Criar uma nova conta de robô

Cria uma nova conta de Robot na ID da organização especificada e a atribui aos grupos indicados.

Ponto de Extremidade da API

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

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.

Corpo da Solicitação

O corpo da solicitação contém a ID da organização à qual você deseja adicionar o grupo e, opcionalmente, os usuários que você deseja adicionar como membros no novo grupo.

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

Resposta

201 Successful

O grupo personalizado é criado nos organização indicados e obtém um ID.

Exemplo de solicitação

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

• Your {baseURL} is: https://{yourDomain}/identity
• Seu {access_token} é: 1234 (para considerações de comprimento).
• O {partitionGlobalId} é: 3fa85f64-5717-4562-b3fc-2c963f66afa6
• Você deseja nomear o grupo: "Gryffindors"

• Você deseja adicionar os usuários Ron, Harry e Hermione ao grupo. Esse usuários têm as seguintes IDs de usuários:

  • Identificador do usuário Ron: ron-0103
  • Identificador do usuário Luna: har-3107
  • Identificador do usuário Hermione: her-1909

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

curl --location --request POST 'https://{yourDomain}/identity/api/Group' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
    "name": "Roby",
    "displayName": "Roby",
    "partitionGlobalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "groupIDsToAdd": [
        "gryff-01"
    ],
    "groupIDsToRemove": []
}'

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

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