Update User

Referência de API para atualizar informações sobre um usuário local especificado por ID de usuário

Atualiza as informações sobre o usuário local especificado.

Ponto de Extremidade da API

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

Escopos

Requer os seguintes escopos:

• PM.User
• PM.User.Write

Cabeçalhos de solicitação.

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

Observação:

Para obter o {access_token}, certifique-se de se autenticar por meio de um dos métodos descritos aqui.

Parâmetros do caminho

Parâm	Tipo de dados	Description
userId (obrigatório)	String	A ID do usuário que você deseja atualizar.

Corpo da Solicitação

O corpo da solicitação contém informações do usuário que você deseja atualizar, como nome, email ou associação a grupos.

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

Resposta

200 OK

O grupo personalizado é atualizado com as informações que você forneceu.

400 Bad Request

Não foi possível executar a atualização.

{
    "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"
}

Exemplo de solicitação

Digamos que você reuniu todas as informações necessárias para criar a chamada de API.

• Seu {baseURL} é: https://{yourDomain}/{organizationName}/{tenantName}/
• Seu {access_token} é: 1234 (para considerações de comprimento).
• Você deseja atualizar as informações e associações da ID do usuário her-1909.

A chamada deve ter a seguinte aparência (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
}'

Aqui está a resposta de uma chamada bem-sucedida:

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