Mettre à jour un compte de robot

Met à jour les informations sur le compte de robot spécifié.

Point de terminaison de l’API

PUT https://{yourDomain}/{organizationName}/identity/api/Setting

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

Paramètres de chemin d'accès

Param	Type de données	Description
robotAccountId (requis)	Chaîne de caractères (string)	L'ID du compte de robot que vous souhaitez mettre à jour.

Corps de la requête

Le corps de la demande contient l'ID de l'organisation à laquelle appartient le compte robot et les informations que vous souhaitez mettre à jour, telles que les adhésions au groupe.

{
  "partitionGlobalId": "string",
  "displayName": "string",
  "groupIDsToAdd": [
    "string"
  ],
  "groupIDsToRemove": [
    "string"
  ]
}

Réponses

200 OK

Le groupe personnalisé est mis à jour avec les informations que vous avez fournies.

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 affecter le compte de robot avec l'ID 88-uv à l'ID de groupe alumni-02.

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

curl --location --request PUT 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/RobotAccount/88-uv' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
    "partitionGlobalId": "magic-7",
    "displayName": "Roby",
    "groupIDsToAdd": [
        "alumni-02"
    ],
    "groupIDsToRemove": []
}'

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

{
    "id": "88-uv",
    "name": "Roby",
    "displayName": "Roby",
    "creationTime": "2021-10-20T12:16:16.6492925",
    "lastLoginTime": null,
    "groupIds": [
        "alumni-02",
        "gryff-01"
    ]
}