Skip to main content

Points de terminaison de l'identifiant

Points de terminaison et paramètres d'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 .

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 .

Récupérer un enregistrement d'informations d'identification

Pour obtenir des informations sur tous les enregistrements de workflow, utilisez le point de terminaison  GET {baseURL}/v3/workflows/ .

Note

Si vous n'êtes pas un curateur, 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.

Paramètres

  • 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.

  • ownerId  (chaîne) : facultatif. Pour filtrer les résultats par ID utilisateur, entrez l'ID d'un utilisateur.

  • versionId  (chaîne) : facultatif. Pour filtrer les résultats par userGroupId, entrez l'ID d'un groupe d'utilisateurs.

Récupérer un enregistrement d'informations d'identification

Pour obtenir des informations sur un workflow spécifique, utilisez le point de terminaison  GET {baseURL}/v3/workflows/{credentialId} .

Paramètres

  • workflowCredentialType (chaîne) : obligatoire. Saisissez un ID de collection pour obtenir les informations relatives à un identifiant spécifique.

Partager des informations d'identification avec un utilisateur

Pour partager des informations d'identification avec un utilisateur, utilisez le {baseURL} {credentialId} noeud final POST /v3/credentials/ /users.

Paramètres

  • workflowCredentialType (chaîne) : obligatoire. Saisissez un ID de collection que vous souhaitez partager.

  • Contrat (corps) : obligatoire. Spécifiez les éléments suivants pour partager des informations d'identification avec un utilisateur :

    • workflowCredentialType (chaîne) : obligatoire. Spécifiez l'ID d'un utilisateur avec lequel vous souhaitez partager des informations d'identification.

Partager des identifiants avec des groupes d'utilisateurs

Pour partager des informations d'identification avec un groupe d'utilisateurs, utilisez le {baseURL} {credentialId} noeud final POST /v3/credentials/ /usergroups.

Paramètres

  • workflowCredentialType (chaîne) : obligatoire. Saisissez un ID d'identification que vous souhaitez partager.

  • Contrat (corps) : obligatoire. Spécifiez les éléments suivants pour partager des informations d'identification avec un groupe d'utilisateurs :

    • workflowCredentialType (chaîne) : obligatoire. Spécifiez l'ID d'un groupe d'utilisateurs avec lequel vous souhaitez partager des informations d'identification.

Retire un utilisateur des informations d'identification

Pour supprimer un utilisateur d'une information d'identification, utilisez le {baseURL}{credentialId}{userId} noeud final DELETE /v3/credentials/ /users/.

Paramètres

  • workflowCredentialType (chaîne) : obligatoire. Saisissez l'ID du workflow dont vous souhaitez récupérer les informations.

  • workflowCredentialType (chaîne) : obligatoire. Saisissez un ID utilisateur que vous souhaitez supprimer des informations d'identification.

Comment retirer un utilisateur ou un groupe d'une collection

Pour supprimer un groupe d'utilisateurs d'une information d'identification, utilisez le {baseURL}{credentialId}{userGroupId} noeud final DELETE /v3/credentials/ /usergroups/.

Paramètres

  • workflowCredentialType (chaîne) : obligatoire. Saisissez l'ID d'identification dont vous souhaitez supprimer le groupe d'utilisateurs.

  • workflowCredentialType (chaîne) : obligatoire. Entrez un ID de groupe d'utilisateurs que vous souhaitez supprimer des informations d'identification.

Supprimer des informations d'identification

Pour supprimer un workflow spécifique, utilisez le point de terminaison  DELETE {baseURL}/v3/workflows/{credentialId} .

Paramètres

  • workflowCredentialType (chaîne) : obligatoire. Sélectionnez les 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 true. Lorsque cette option n'est pas sélectionnée, la valeur par défaut est « false ». Ceci afin de se protéger contre un appel errant.

Relations d'objets

Pour obtenir des informations sur un workflow spécifique, utilisez le point de terminaison  GET /v3/workflows/ . L' ID d'identification que vous obtenez peut être utilisé dans les cas suivants :

Dans cette section​: