[Vorschau] Neues Roboterkonto erstellen

Erstellt ein neues Roboterkonto in der angegebenen Organisations-ID und weist es den angegebenen Gruppen zu.

API-Endpunkt

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

Scopes

Folgende Scopes sind erforderlich:

• PM.RobotAccount
• PM.RobotAccount.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",
  "groupIDsToAdd": [
    "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} ist: https://{yourDomain}/{organizationName}/{tenantName}/
• Ihre {access_token} ist: 1234 (aus Gründen der Länge).
• Die {partitionGlobalId} lautet: magic-7
• 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 wie folgt aussehen (cURL):

curl --location --request POST 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/Group' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'
--data-raw '{
    "name": "Roby",
    "displayName": "Roby",
    "partitionGlobalId": "magic-7",
    "groupIDsToAdd": [
        "gryff-01"
    ],
    "groupIDsToRemove": []
}'

Hier ist die Antwort für einen erfolgreichen Aufruf:

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