[Vorschau] Alle Roboterkonten abrufen

Gibt die Liste aller Roboterkonten einer Organisation basierend auf der Organisations-ID zurück.

API-Endpunkt

https://{yourDomain}/identity_/api/Setting

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, für die Sie die Roboterkonten abrufen möchten.

Abfrageparameter

Abfrageparameter	Datentyp	Beschreibung
searchTerm (optional)	String	Der Schlüssel, nach dem Sie die Roboterkonten durchsuchen möchten.
top (optional)	Int32	Zeigen Sie die obersten N Roboterkonten an.
skip (optional)	Int32	Überspringen Sie die obersten N Roboterkonten.
sortBy (optional)	Int32	Geben Sie die DTO-Eigenschaft an, nach der Prüfungseinträge sortiert werden. Zum Beispiel: name, creationTime, id etc.
sortOrder (optional)	Int32	Bestimmen Sie die Sortierreihenfolge. Zum Beispiel aufsteigend (asc) oder absteigend (desc).

Antworten

200 OK

Gibt die abgefragten Roboterkonten zurück.

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 legen die folgenden Abfrageparameter fest:

  • searchTerm = bot
  • top = 2, um die beiden obersten Einträge anzuzeigen
  • skip = 2, um die ersten beiden Einträge zu überspringen
  • sortBy = name, um die Einträge nach Namen zu sortieren
  • sortOrder = asc, um die Einträge vom ältesten bis zum neuesten Eintrag zu sortieren

Der Aufruf sollte wie folgt aussehen (cURL):

curl --location --request GET 'https://{yourDomain}/{organizationName}/{tenantName}/identity_/api/RobotAccount/magic-7?searchTerm=attended&top=2&skip=2&sortBy=name&sortOrder=asc' \
--header 'Authorization: Bearer 1234' \
--header 'Content-Type: application/json'

Hier ist der Antworttext für einen erfolgreichen Abruf von Prüfungseinträgen:

{
    "totalCount": 3,
    "results": [
        {
            "id": "55-ab",
            "name": "Bot5",
            "displayName": "Bot5",
            "creationTime": "2021-10-19T18:05:17.3465735",
            "lastLoginTime": null,
            "groupIds": [
                "group1",
                "group2",
                "group3"
            ]
        },
        {
            "id": "66-cd",
            "name": "Bot6",
            "displayName": "Bot6",
            "creationTime": "2021-10-19T18:06:00.3088553",
            "lastLoginTime": null,
            "groupIds": [
                "group1",
                "group3"
            ]
        },
        {
            "id": "77-ef",
            "name": "Bot7",
            "displayName": "Bot7",
            "creationTime": "2021-10-19T18:05:31.4736281",
            "lastLoginTime": null,
            "groupIds": [
                "group2"
            ]
        }
    ]
}