Obtém informações paginadas sobre grupos do Employee Identity and Access Management (EIAM).
Experimente agora
Testar
Autorização RAM
Sintaxe da solicitação
GET /v2/{instanceId}/{applicationId}/groups HTTP/1.1Parâmetros de caminho
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| instanceId |
string |
Sim |
O ID da instância. |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| applicationId |
string |
Sim |
O ID da aplicação. |
app_mkv7rgt4d7i4u7zqtzev2mxxxx |
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| Authorization |
string |
Sim |
As informações de autenticação. O valor está no formato Bearer ${access_token}. Exemplo: Bearer ATxxxx. |
Bearer xxxx |
| groupNameStartWith |
string |
Não |
O prefixo do nome do grupo. |
group_xxx |
| nextToken |
string |
Não |
O nextToken. |
NTxxx |
| maxResults |
integer |
Não |
O número de entradas por página. Valor padrão: 20. |
20 |
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
DeveloperNextTokenResponse. |
||
| totalCount |
integer |
O número total de entradas retornadas. |
1000 |
| data |
array<object> |
Os dados retornados. |
|
|
object |
Os dados retornados. |
||
| instanceId |
string |
O ID da instância. |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| groupId |
string |
O ID do grupo. |
group_ufdsasn35ea5lmthk267xxxxx |
| groupName |
string |
O nome do grupo. |
name_test |
| description |
string |
A descrição do grupo. |
description_demo |
| groupExternalId |
string |
O ID externo do grupo. |
group_ufdsasn35ea5lmthk267xxxxx |
| groupSourceType |
string |
O tipo de origem do grupo. Valores válidos: build_in, ding_talk, ad e ldap. |
build_in |
| groupSourceId |
string |
O ID de origem do grupo. |
idaas_ue2jvisn35ea5lmthk267xxxxx |
| createTime |
integer |
O horário em que o grupo foi criado. O valor é um timestamp UNIX. Unidade: milissegundos. |
1652085686179 |
| updateTime |
integer |
O horário em que o grupo foi atualizado pela última vez. O valor é um timestamp UNIX. Unidade: milissegundos. |
1652085686179 |
| nextToken |
string |
A posição inicial da consulta. Se este parâmetro for deixado vazio, a consulta começará do início. |
NTxxx |
| maxResults |
integer |
O número máximo de entradas retornadas. |
20 |
Exemplos
Resposta de sucesso
JSON formato
{
"totalCount": 1000,
"data": [
{
"instanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
"groupId": "group_ufdsasn35ea5lmthk267xxxxx",
"groupName": "name_test",
"description": "description_demo",
"groupExternalId": "group_ufdsasn35ea5lmthk267xxxxx",
"groupSourceType": "build_in",
"groupSourceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
"createTime": 1652085686179,
"updateTime": 1652085686179
}
],
"nextToken": "NTxxx",
"maxResults": 20
}Códigos de erro
Consulte Códigos de Erro para uma lista completa.
Notas de versão
Consulte Notas de Versão para uma lista completa.