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

Ponto de Extremidade da API

GET https://{yourDomain}/identity/api/RobotAccount

Escopos

Requer os seguintes escopos:

• PM.RobotAccount
• PM.RobotAccount.Read

Cabeçalhos de solicitação.

--header 'Authorization: Bearer {access_token}'\
--header 'Content-Type: application/json'

Observação: para obter o {access_token}, certifique-se de se autenticar por meio de um dos métodos descritos aqui.

Parâmetros do caminho

Parâmetro do caminho	Tipo de dados	Description
partitionGlobalId (obrigatório)	String	A ID da organização da qual você deseja recuperar as contas de Robots.

Parâmetros de Consulta

Parâmetro de consulta	Tipo de dados	Description
searchTerm (opcional)	String	A chave que você deseja usar para procurar as contas de Robots.
top (opcional)	Int32	Exibe as N principais contas de Robots.
skip (opcional)	Int32	Pular as principais contas do N robô.
sortBy (opcional)	Int32	Especifica a propriedade DTO usada para classificar as entradas de auditoria. Por exemplo, name, creationTime, id, etc.
sortOrder (opcional)	Int32	Especifica a ordem de classificação. Por exemplo, crescente (asc) ou decrescente (desc).

Resposta

200 OK

Retorna as contas de Robots consultadas.

Exemplo de solicitação

Digamos que você reuniu todas as informações necessárias para criar a chamada de API.

• Your {baseURL} is: https://{yourDomain}/identity
• Seu {access_token} é: 1234 (para considerações de comprimento).
• O {partitionGlobalId} é: 3fa85f64-5717-4562-b3fc-2c963f66afa6

• Você define os seguintes parâmetros de consulta:

  • searchTerm = bot
  • top = 2, para exibir as duas principais entradas
  • skip = 2, para pular as duas primeiras entradas
  • sortBy = name, para classificar as entradas por seu nome
  • sortOrder = asc, para classificar as entradas da entrada mais antiga para a mais recente

A chamada deve ser semelhante ao seguinte exemplo (cURL):

curl --location --request GET 'https://{yourDomain}/identity/api/RobotAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6?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"
            ]
        }
    ]
}