Créer un nouveau compte de robot

Crée un compte Robot dans l'ID d'organisation spécifié et l'affecte aux groupes indiqués.

Point de terminaison de l’API

POST https://{yourDomain}/{organizationName}/identity/api/RobotAccount

Étendues

Nécessite les étendues suivantes :

• PM.RobotAccount
• PM.RobotAccount.Write

En-têtes de requête.

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'

Remarque : pour obtenir le {access_token}, assurez-vous de vous authentifier via l'une des méthodes décrites ici.

Corps de la requête

Le corps de la demande contient l'ID de l'organisation à laquelle ajouter le groupe et, éventuellement, les utilisateurs que vous souhaitez ajouter en tant que membres du nouveau groupe.

{
  "partitionGlobalId": "string",
  "id": "string",
  "name": "string",
  "groupIDsToAdd": [
    "string", "string"
  ]
}

Réponses

201 Réussi

Le groupe personnalisé est créé dans l'organisation indiquée et obtient un ID.

Exemple de requête

Supposons que vous ayez rassemblé toutes les informations nécessaires pour créer l'appel d'API.

• Votre {baseURL} est : https://{yourDomain}/{organizationName}/{tenantName}/
• Votre {access_token} est : 1234 (pour des considérations de longueur).
• Le {partitionGlobalId} est : magic-7
• Vous souhaitez nommer le groupe : "Gryffindors"

• Vous souhaitez ajouter les utilisateurs Ron, Harry et Hermione au groupe. Ces utilisateurs ont les ID utilisateur suivants :

  • Identifiant utilisateur Ron : ron-0103
  • Identifiant utilisateur Harry : har-3107
  • Identifiant utilisateur Hermione : her-1909

L’appel devrait ressembler à l'exemple ci-dessous (cURL) :

curl --location --request POST 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/Group' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
    "name": "Roby",
    "displayName": "Roby",
    "partitionGlobalId": "magic-7",
    "groupIDsToAdd": [
        "gryff-01"
    ],
    "groupIDsToRemove": []
}'

Voici la réponse pour un appel réussi :

{
    "id": "rb-12",
    "name": "Roby",
    "displayName": "Roby",
    "creationTime": "2021-10-20T15:20:29.1302044Z",
    "lastLoginTime": null,
    "groupIds": ["gryff-01"]
}