Pour en savoir plus sur les relations d'objets et sur leur utilisation dans l'API, consultez la section Relations d'objets .
Pour plus d'informations à propos des informations d'identification, consultez la page d'aide Informations d'identification .
Note
Nous n'autorisons pas la création d'informations d'identification via l'API. Pour créer des informations d'identification en tant qu'administrateur, utilisez l' Interface utilisateur Server .
Pour obtenir des informations sur toutes les informations d'identification, utilisez le point de terminaison
GET {baseURL}/v3/credentials
.
Note
Si vous n'êtes pas administrateur, les résultats sont limités aux informations d'identification auxquelles vous avez accès et les paramètres « view », « userId » et « userGroupId » seront ignorés.
view (chaîne) : facultatif. Peut être laissé sans valeur. Vous pouvez choisir parmi les valeurs suivantes : « Default » et « Full ». Si ce paramètre est défini sur « Default », un objet de vue réduite est renvoyé. Lorsqu'elle n'est pas spécifiée, la valeur « Default » est utilisée.
userId (chaîne) : facultatif. Pour filtrer les résultats par userId, saisissez un ID d'utilisateur.
userGroupId (chaîne) : facultatif. Pour filtrer les résultats par userGroupId, saisissez un ID de groupe d'utilisateurs.
Pour obtenir des informations sur des informations d'identification, utilisez le point de terminaison
GET {baseURL}/v3/credentials/{credentialId}
.
credentialId (chaîne) : obligatoire. Saisissez un ID de collection pour obtenir les informations relatives à des informations d'identification spécifiques.
Pour partager des informations d'identification avec un utilisateur, utilisez le point de terminaison
POST {baseURL}
/v3/credentials/{credentialId}/users
.
credentialId (chaîne) : obligatoire. Saisissez un ID de collection à partager.
contract (corps) : obligatoire. Indiquez les éléments suivants pour partager des informations d'identification avec un utilisateur :
userId (chaîne) : obligatoire. Indiquez un ID d'utilisateur avec lequel vous souhaitez partager des informations d'identification.
Pour partager des informations d'identification avec un groupe d'utilisateurs, utilisez le point de terminaison
POST {baseURL}
/v3/credentials/{credentialId}/userGroups
.
credentialId (chaîne) : obligatoire. Saisissez un ID d'informations d'identification à partager.
contract (corps) : obligatoire. Indiquez les éléments suivants pour partager des informations d'identification avec un groupe d'utilisateurs :
userGroupId (chaîne) : obligatoire. Indiquez un ID de groupe d'utilisateurs avec lequel vous souhaitez partager des informations d'identification.
Pour retirer un utilisateur d'informations d'identification, utilisez le point de terminaison
DELETE {baseURL}/v3/credentials/{credentialId}/users/{userId}
.
credentialId (chaîne) : obligatoire. Saisissez l'ID des informations d'identification dont vous souhaitez retirer l'utilisateur.
userId (chaîne) : obligatoire. Saisissez un ID d'utilisateur que vous souhaitez retirer des informations d'identification.
Pour retirer un groupe d'utilisateurs d'informations d'identification, utilisez le point de terminaison
DELETE {baseURL}/v3/credentials/{credentialId}/userGroups/{userGroupId}
.
credentialId (chaîne) : obligatoire. Saisissez l'ID des informations d'identification dont vous souhaitez retirer le groupe d'utilisateurs.
userGroupId (chaîne) : obligatoire. Saisissez un ID de groupe d'utilisateurs que vous souhaitez retirer des informations d'identification.
Pour supprimer des informations d'identification, utilisez le point de terminaison
DELETE {baseURL}/v3/credentials/{credentialId}
.
credentialId (chaîne) : obligatoire. Saisissez l'ID des informations d'identification à supprimer.
force (booléen) : facultatif. Indiquez si vous souhaitez forcer la suppression d'informations d'identification en cas de partages. Si vous souhaitez supprimer les informations d'identification et nettoyer tous les partages, définissez le paramètre « force » sur « vrai ». Lorsque cette option n'est pas sélectionnée, la valeur par défaut est « faux ». Ceci vous protège des appels erronés.
Pour obtenir des informations sur des ID d'informations d'identification existantes, utilisez le point de terminaison GET /v3/credentials . Le credentialId que vous obtenez peut être utilisé dans les cas suivants :
Vous souhaitez obtenir des informations sur des informations d'identification spécifiques .
Vous souhaitez partager des informations d'identification avec un utilisateur .
Vous souhaitez partager des informations d'identification avec un groupe d'utilisateurs .
Vous souhaitez retirer un utilisateur d'informations d'identification .
Vous souhaitez retirer un groupe d'utilisateurs d'informations d'identification .
Vous souhaitez supprimer des informations d'identification spécifiques .