Atualizar conta de robô

Visão geral do ponto de extremidade Atualizar conta do robô para modificar detalhes da conta do robô, incluindo escopos necessários

Obtém informações sobre o grupo de IAM especificado.

Ponto de Extremidade da API

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

Escopos

Requer os seguintes escopos:

• PM.RobotAccount
• PM.RobotAccount.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
robotAccountId (obrigatório)	String	A ID da conta de Robot que você deseja atualizar.

Corpo da Solicitação

O corpo da solicitação contém a ID da organização à qual a conta de Robot pertence e as informações que você deseja atualizar, como associações a grupos.

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

Resposta

200 OK

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

Exemplo de solicitação

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

• Seu {baseURL} é: https://{yourDomain}/identity
• Seu {access_token} é: 1234 (para considerações de comprimento).
• O {partitionGlobalId} é: 3fa85f64-5717-4562-b3fc-2c963f66afa6
• Você deseja atribuir a conta de Robot com a ID 88-uv à ID do grupo alumni-02.

A chamada deve ser semelhante ao seguinte exemplo (cURL):

curl --location --request PUT 'https://{yourDomain}/identity/api/RobotAccount/88-uv' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
    "partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "displayName": "Roby",
    "groupIDsToAdd": [
        "alumni-02"
    ],
    "groupIDsToRemove": []
}'

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

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