- Introdução
- Autenticação
- Escopos e permissões
- APIs de gestão de plataforma
[Visualizar] Obter todas as contas de robôs
Retorna a lista de todas as contas de Robots de uma organização, com base na ID da organização
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'
{access_token}
, certifique-se de se autenticar por meio de um dos métodos descritos aqui.
Parâmetro do caminho |
Tipo de dados |
Description |
---|---|---|
(obrigatório) |
String |
A ID da organização da qual você deseja recuperar as contas de Robots. |
Parâmetro de consulta |
Tipo de dados |
Description |
---|---|---|
(opcional) |
String |
A chave que você deseja usar para procurar as contas de Robots. |
(opcional) |
Int32 |
Exibe as N principais contas de Robots. |
(opcional) |
Int32 |
Pular as principais contas do N robô. |
(opcional) |
Int32 |
Especifica a propriedade DTO usada para classificar as entradas de auditoria. Por exemplo,
name , creationTime , id , etc.
|
(opcional) |
Int32 |
Especifica a ordem de classificação. Por exemplo, crescente (
asc ) ou decrescente (desc ).
|
Digamos que você reuniu todas as informações necessárias para criar a chamada de API.
- Seu
{baseURL}
é:https://{yourDomain}/{organizationName}/{tenantName}/
-
Seu
{access_token}
é:1234
(para considerações de comprimento). -
O
{partitionGlobalId}
é:magic-7
-
Você define os seguintes parâmetros de consulta:
searchTerm
=bot
top
= 2, para exibir as duas principais entradasskip
= 2, para pular as duas primeiras entradassortBy
=name
, para classificar as entradas por seu nomesortOrder
=asc
, para classificar as entradas da entrada mais antiga para a mais recente
A chamada deve ter a seguinte aparência (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'
Aqui está o corpo da resposta de uma recuperação bem-sucedida de entradas de auditoria:
{
"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"
]
}
]
}