- Erste Schritte
- Authentication
- Scopes und Berechtigungen
- Plattformverwaltungs-APIs
[Vorschau] Alle Roboterkonten abrufen
Gibt die Liste aller Roboterkonten einer Organisation basierend auf der Organisations-ID zurück.
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
{access_token}
zu erhalten, müssen Sie sich mit einer der hier beschriebenen Methoden authentifizieren.
Pfadparameter |
Datentyp |
Beschreibung |
---|---|---|
(erforderlich) |
String |
Die ID der Organisation, für die Sie die Roboterkonten abrufen möchten. |
Abfrageparameter |
Datentyp |
Beschreibung |
---|---|---|
(optional) |
String |
Der Schlüssel, nach dem Sie die Roboterkonten durchsuchen möchten. |
(optional) |
Int32 |
Zeigen Sie die obersten N Roboterkonten an. |
(optional) |
Int32 |
Überspringen Sie die obersten N Roboterkonten. |
(optional) |
Int32 |
Geben Sie die DTO-Eigenschaft an, nach der Prüfungseinträge sortiert werden. Zum Beispiel:
name , creationTime , id etc.
|
(optional) |
Int32 |
Bestimmen Sie die Sortierreihenfolge. Zum Beispiel aufsteigend (
asc ) oder absteigend (desc ).
|
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 anzuzeigenskip
= 2, um die ersten beiden Einträge zu überspringensortBy
=name
, um die Einträge nach Namen zu sortierensortOrder
=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'
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"
]
}
]
}
{
"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"
]
}
]
}