Bestimmtes Roboterkonto abrufen

API-Referenz zum Abrufen von Roboterkontoinformationen nach Organisation und Roboterkonto-ID

Gibt Informationen über ein Roboterkonto zurück, basierend auf der Organisation und der Roboterkonto-ID.

API-Endpunkt

GET https://{yourDomain}/{organizationName}/identity/api/RobotAccount/{partitionGlobalId}/{robotAccountId}

Scopes

Folgende Scopes sind erforderlich:

• PM.RobotAccount
• PM.RobotAccount.Read

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

Pfadparameter	Datentyp	Beschreibung
partitionGlobalId (erforderlich)	String	Die ID der Organisation, die die gewünschte Gruppe enthält.
robotAccountID (erforderlich)	String	Die ID des Roboterkontos, das Sie abrufen wollen.

Antworten

200 OK

Die angegebenen Roboterkontoinformationen werden zurückgegeben, z. B. Name, Erstellungszeit und die Gruppen-IDs, zu denen das Konto gehört.

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
• Die {robotAccountID} lautet: 33-ab

Der Aufruf sollte wie folgt aussehen (cURL):

curl --location --request GET 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/RobotAccount/magic-7/33-ab' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'

Hier ist der Antworttext für einen erfolgreichen Aufruf:

{
    "id": "33-ab",
    "name": "Bot3",
    "displayName": "Bot3",
    "creationTime": "2021-10-19T14:25:01.6574988",
    "lastModificationTime": "2021-10-19T14:25:01.6574988",
    "groupIds": [
       "4d161738-7204", "ce684f6f-5af3"
    ]
}