Todos os produtos
Search

Este produto

    Identity as a Service:ListGroups

    Central de documentação

    Identity as a Service:ListGroups

    Última atualização: Jun 24, 2026

    Listar grupos de contas do EIAM.

    Experimente agora

    Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

    Testar

    Autorização RAM

    Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

    Parâmetros da solicitação

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    Exemplo
    InstanceId

    string

    Sim

    ID da instância.

    idaas_ue2jvisn35ea5lmthk267xxxxx
    PageNumber

    integer

    Não

    Número da página.

    1
    PageSize

    integer

    Não

    Tamanho da página.

    20
    GroupIds

    array

    Não

    Lista de IDs de grupo.

    string

    Não

    ID do grupo.

    group_d6sbsuumeta4h66ec3il7yxxxx
    GroupName

    string

    Não

    Nome do grupo. A consulta usa correspondência exata.

    name_test
    GroupNameStartsWith

    string

    Não

    Prefixo do nome do grupo. A consulta usa correspondência por prefixo.

    name
    GroupExternalId

    string

    Não

    ID externo do grupo.

    group_external_id

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    RequestId

    string

    ID da solicitação.

    0441BD79-92F3-53AA-8657-F8CE4A2B912A
    TotalCount

    integer

    Número total de entradas correspondentes. O número máximo de entradas retornadas em uma única solicitação é determinado pelo pageSize.

    100
    Groups

    array<object>

    Lista de grupos de contas.

    object

    Objeto de grupo de contas.

    GroupId

    string

    ID do grupo.

    group_d6sbsuumeta4h66ec3il7yxxxx
    GroupName

    string

    Nome do grupo.

    group_name
    Description

    string

    Descrição do grupo.

    test group
    GroupExternalId

    string

    ID externo do grupo, usado para associação com sistemas externos. O padrão é o ID do grupo de contas.

    group_d6sbsuumeta4h66ec3il7yxxxx
    GroupSourceType

    string

    Tipo de origem do grupo. Atualmente, apenas o tipo autogerenciado é suportado. Valores válidos:

    • build_in: autogerenciado.

    build_in
    GroupSourceId

    string

    ID de origem do grupo. Se criado por importação de outras fontes, este é o ID da fonte externa. O padrão é o ID da instância.

    idaas_ue2jvisn35ea5lmthk267xxxxx
    CreateTime

    integer

    Hora de criação do grupo no formato de carimbo de data/hora Unix, em milissegundos.

    1652085686179
    UpdateTime

    integer

    Hora da última atualização do grupo no formato de carimbo de data/hora Unix, em milissegundos.

    1652085686179
    InstanceId

    string

    ID da instância.

    idaas_ue2jvisn35ea5lmthk267xxxxx

    Exemplos

    Resposta de sucesso

    JSON formato

    {
  "RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
  "TotalCount": 100,
  "Groups": [
    {
      "GroupId": "group_d6sbsuumeta4h66ec3il7yxxxx",
      "GroupName": "group_name",
      "Description": "test group",
      "GroupExternalId": "group_d6sbsuumeta4h66ec3il7yxxxx",
      "GroupSourceType": "build_in",
      "GroupSourceId": "idaas_ue2jvisn35ea5lmthk267xxxxx",
      "CreateTime": 1652085686179,
      "UpdateTime": 1652085686179,
      "InstanceId": "idaas_ue2jvisn35ea5lmthk267xxxxx"
    }
  ]
}

    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.