Récupérer tous les enregistrements d'informations d'identification
Partager des informations d'identification avec un utilisateur
Partager des informations d'identification avec un groupe d'utilisateurs
Retirer l'autorisation d'un utilisateur d'exploiter des informations d'identification
Retirer l'autorisation d'un groupe d'utilisateurs d'exploiter des informations d'identification
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 .
Pour récupérer tous les enregistrements d'informations d'identification accessibles, 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 récupérer des détails sur des informations d'identification existantes, 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.
To create a credential record, use the POST {baseURL}/v3/credentials endpoint.
Note
Only Curators can use this API endpoint.
This API endpoint is disabled if TLS is not enabled.
The API validates the username and password and only creates credentials for existing Windows logins with valid passwords.
addContract (body): Required. Specify the following to create a new credential:
password (string) Required. Specify the password for the username of the new credential to be added.
username (string) Required. Specify the username of the new credential to be added.
To update a credential record, use the PUT {baseURL}/v3/credentials/{credentialId} endpoint.
Note
Only Curators can use this API endpoint.
This API endpoint is disabled if TLS is not enabled.
This API endpoint validates the username and password and only updates credentials for existing Windows logins with valid passwords.
updateContract (body): Required. Specify the following to update a credential with a new password:
NewPassword (string): Required. Specify the new password for the credential ID.
credentialId (string) Required. Enter the ID of the credential to update.
Pour partager des informations d'identification existantes avec un utilisateur existant, utilisez le point de terminaison
POST {baseURL}
/v3/credentials/{credentialId}/users
.
Note
Seuls les administrateurs peuvent utiliser ce point de terminaison d'API.
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 existantes avec un groupe d'utilisateurs existant, utilisez le point de terminaison
POST {baseURL}
/v3/credentials/{credentialId}/userGroups
.
Note
Seuls les administrateurs peuvent utiliser ce point de terminaison d'API.
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 l'autorisation d'un utilisateur permettant d'utiliser des informations d'identification existantes, utilisez le point de terminaison
DELETE {baseURL}/v3/credentials/{credentialId}/users/{userId}
.
Note
Seuls les administrateurs peuvent utiliser ce point de terminaison d'API.
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 l'autorisation d'un groupe d'utilisateurs permettant d'utiliser des informations d'identification existantes, utilisez le point de terminaison
DELETE {baseURL}/v3/credentials/{credentialId}/userGroups/{userGroupId}
.
Note
Seuls les administrateurs peuvent utiliser ce point de terminaison d'API.
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 existantes, utilisez le point de terminaison
DELETE {baseURL}/v3/credentials/{credentialId}
.
Note
Seuls les administrateurs peuvent utiliser ce point de terminaison d'API.
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 .
You want to update a specific credential.