[Aperçu] Mettre à jour l'utilisateur

Met à jour les informations sur l'utilisateur local indiqué.

Point de terminaison de l’API

https://{yourDomain}/identity/api/User/{userId}

Étendues

Nécessite les étendues suivantes :

• PM.User
• PM.User.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
userId (requis)	Chaîne de caractères (string)	L'ID de l'utilisateur que vous souhaitez supprimer.

Corps de la requête

Le corps de la demande contient les informations utilisateur que vous souhaitez mettre à jour, telles que le nom, l'adresse e-mail ou l'adhésion au groupe.

{
  "name": "string",
  "surname": "string",
  "email": "[e-mail]",
  "isActive": true,
  "password": "string",
  "groupIDsToAdd": [
    "string"
  ],
  "groupIDsToRemove": [
    "string"
  ],
  "bypassBasicAuthRestriction": true,
  "invitationAccepted": true
}

Réponses

200 OK

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

400 Requête incorrecte

Impossible d'effectuer la mise à jour.

{
    "errors": {
        "bypassBasicAuthRestriction": [
            "Unexpected character encountered while parsing value: h. Path 'bypassBasicAuthRestriction', line 17, position 35.",
            "Unexpected character encountered while parsing value: a. Path 'bypassBasicAuthRestriction', line 17, position 35."
        ]
    },
    "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
    "title": "One or more validation errors occurred.",
    "status": 400,
    "traceId": "00-aec3de9099a9934e9c31e26c19f5e0dd-8c0d3d5f476c7742-00"
}

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).
• Vous souhaitez mettre à jour les informations et l'adhésion de l'ID utilisateur her-1909.

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

curl --location --request PUT 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/User/her-1909' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
    "name": "Hermione",
    "surname": "Granger-Weasley",
    "email": "[e-mail]",
    "groupIDsToAdd": [
        "gryff-01",
        "alumni-02",
        "teachers-03"
    ],
    "groupIDsToRemove": [],
    "bypassBasicAuthRestriction": false
}'

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

{
    "succeeded": true,
    "errors": []
}