Criar um novo grupo local

Cria um novo grupo local na ID da organização especificada e adiciona os usuários indicados a ela.

Ponto de Extremidade da API

POST https://{yourDomain}/{organizationName}/identity/api/Group

Escopos

Requer os seguintes escopos:

• PM.Group
• PM.Group.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",
  "directoryUserMemberIDs": [
    "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.

• Seu {baseURL} é: https://{yourDomain}/{organizationName}/{tenantName}/
• Seu {access_token} é: 1234 (para considerações de comprimento).
• O {partitionGlobalId} é: magic-7
• 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 ter a seguinte aparência (cURL):

curl --location --request POST 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/Group' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
    "partitionGlobalId":"magic-7",
    "name":"Gryffindors",
    "id": "gryff-01",
    "directoryUserMemberIDs":
    ["ron-0103", "har-3107", "her-1909"]
}'

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

{
    "id": "gryff-01",
    "name": "Gryffindors",
    "displayName": "Gryffindors",
    "type": 1,
    "creationTime": "2021-10-19T15:37:49.1853184",
    "lastModificationTime": null,
    "members": [
        {
            "objectType": "DirectoryUser",
            "firstName": "Hermione",
            "lastName": "Granger",
            "jobTitle": "student",
            "companyName": "Hogwarts",
            "city": "London",
            "department": "magic",
            "displayName": "Hermione Granger",
            "source": "local",
            "identifier": "her-1909",
            "name": "Hermione",
            "email": "[e-mail]"
        },
        {
            "objectType": "DirectoryUser",
            "firstName": "Harry",
            "lastName": "Potter",
            "jobTitle": ""student"",
            "companyName": "Hogwarts",
            "city": "London",
            "department": "magic",
            "displayName": "Harry Potter",
            "source": "local",
            "identifier": "har-3107",
            "name": "Harry",
            "email": "[e-mail]"
        },
        {
            "objectType": "DirectoryUser",
            "firstName": "Ron",
            "lastName": "Weasley",
            "jobTitle": "student",
            "companyName": "Hogwarts",
            "city": "London",
            "department": "magic",
            "displayName": "Ron Weasley",
            "source": "local",
            "identifier": "ron-0103",
            "name": "Ron",
            "email": "[e-mail]"
        }
    ]
}