Neue lokale Gruppe erstellen

Erstellt eine neue lokale Gruppe in der angegebenen Organisations-ID und fügt ihr die angegebenen Benutzer hinzu.

API-Endpunkt

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

Scopes

Folgende Scopes sind erforderlich:

• PM.Group
• PM.Group.Write

Anforderungsheader

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

Hinweis: Um das {access_token} zu erhalten, müssen Sie sich mit einer der hier beschriebenen Methoden authentifizieren.

Anforderungstext

Der Anforderungstext enthält die Organisations-ID, zu der die Gruppe hinzugefügt werden soll, und optional die Benutzer, die Sie als Mitglieder in der neuen Gruppe hinzufügen möchten.

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

Antworten

201 Erfolgreich

Die benutzerdefinierte Gruppe wird in der angegebenen Organisation erstellt und erhält eine ID.

Beispielanforderung

Angenommen, Sie haben alle Informationen gesammelt, die zum Erstellen des API-Aufrufs erforderlich sind.

• Ihre {baseURL} lautet: https://{yourDomain}/identity
• Ihre {access_token} ist: 1234 (aus Gründen der Länge).
• Die {partitionGlobalId} lautet: 3fa85f64-5717-4562-b3fc-2c963f66afa6
• Sie möchten der Gruppe einen Namen geben: "Gryffindors"

• Sie möchten die Benutzer Ron, Harry und Hermine zur Gruppe hinzufügen. Diese Benutzer haben die folgenden Benutzer-IDs:

  • Ron-Benutzer-ID: ron-0103
  • Harry-Benutzer-ID: har-3107
  • Hermine-Benutzer-ID: her-1909

Der Aufruf sollte dem folgenden Beispiel ähneln (cURL):

curl --location --request POST 'https://{yourDomain}/identity/api/Group' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
    "partitionGlobalId":"3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name":"Gryffindors",
    "id": "gryff-01",
    "directoryUserMemberIDs":
    ["ron-0103", "har-3107", "her-1909"]
}'

Hier ist die Antwort für einen erfolgreichen Aufruf:

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