Roboterkonto aktualisieren

Aktualisiert die Informationen zum angegebenen Roboterkonto.

API-Endpunkt

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

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.

Pfadparameter

Parameter	Datentyp	Beschreibung
robotAccountId (erforderlich)	String	Die ID des Roboterkontos, die sie aktualisieren wollen.

Anforderungstext

Der Anforderungstext enthält die Organisations-ID, zu der das Roboterkonto gehört, und die Informationen, die Sie aktualisieren möchten, z. B. Gruppenmitgliedschaften.

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

Antworten

200 OK

Die benutzerdefinierte Gruppe wird mit den von Ihnen angegebenen Informationen aktualisiert.

Beispielanforderung

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

• Your {baseURL} is: 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 das Roboterkonto mit der ID 88-uv der Gruppen-ID alumni-02 zuweisen.

Der Aufruf sollte dem folgenden Beispiel ähneln (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": []
}'

Hier ist die Antwort für einen erfolgreichen Aufruf:

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