ListGroups - CloudSSO: Central de Documentação do Alibaba Cloud

Consulta os grupos.

Descrição da operação

Este tópico fornece um exemplo de como consultar os grupos no diretório d-00fc2p61****. O resultado retornado mostra que o diretório contém três grupos. Os grupos group1 e group2 são sincronizados a partir de um provedor de identidade (IdP) externo. O grupo TestGroup é criado manualmente no CloudSSO.

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

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

cloudsso:ListGroups

list

*Group

acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}/group/*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DirectoryId	string	Sim	O ID do diretório.	d-00fc2p61****
NextToken	string	Não	O token de paginação usado na próxima solicitação para recuperar uma nova página de resultados. Você não precisa especificar este parâmetro na primeira solicitação. Você deve especificar o token obtido na consulta anterior como o valor de NextToken.\n\nAo chamar esta operação pela primeira vez, se o número total de entradas a serem retornadas for maior que o valor do parâmetro MaxResults, as entradas serão truncadas. O sistema retorna as entradas com base no valor do parâmetro MaxResults e não retorna as entradas excedentes. Nesse caso, o valor do parâmetro de resposta IsTruncated é true e o parâmetro NextToken é retornado. Na próxima chamada, você pode usar o valor do parâmetro NextToken e manter as configurações dos outros parâmetros de solicitação para consultar as entradas excedentes. Você pode repetir a chamada até que o valor de IsTruncated se torne false. Dessa forma, todas as entradas são retornadas.	K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
MaxResults	integer	Não	O número de entradas por página.\n\nValores válidos: 1 a 100.\n\nValor padrão: 10.	10
Filter	string	Não	A condição de filtro.\n\nVocê deve especificar o valor no formato . O valor não diferencia maiúsculas de minúsculas. Você pode definir apenas como GroupName e apenas como eq ou sw. O valor eq indica Igual a, e o valor sw indica Começa com.\n\nPor exemplo, se você definir Filter como GroupName sw test, a operação consulta os grupos cujos nomes começam com test. Se você definir Filter como GroupName eq testgroup, a operação consulta o grupo cujo nome é testgroup.	GroupName eq testgroup
ProvisionType	string	Não	O tipo do grupo. O tipo pode ser usado para filtrar grupos. Valores válidos:\n\n* Manual: O grupo é criado manualmente.\n* Synchronized: O grupo é sincronizado a partir de um IdP externo.	Manual

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Os parâmetros de resposta.
NextToken	string	Um token de paginação. Pode ser usado na próxima solicitação para recuperar uma nova página de resultados.\n\n> Este parâmetro é retornado apenas quando o valor do parâmetro IsTruncated é true.	K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****
RequestId	string	O ID da solicitação.	768F908D-A66A-5A5D-816C-20C93CBBFEE3
Groups	array<object>	Os grupos.
	object	O grupo.
GroupName	string	O nome do grupo.	TestGroup
Description	string	A descrição do grupo.	This is a group.
CreateTime	string	A hora em que o grupo foi criado.	2021-11-01T02:38:27Z
ProvisionType	string	O tipo do grupo. Valores válidos:\n\n* Manual: O grupo é criado manualmente.\n* Synchronized: O grupo é sincronizado a partir de um IdP externo.	Manual
UpdateTime	string	A hora em que as informações do grupo foram modificadas.	2021-11-01T02:38:27Z
GroupId	string	O ID do grupo.	g-00jqzghi2n3o5hkh****
MaxResults	integer	O número de entradas por página.	10
TotalCounts	integer	O número total de entradas retornadas.	3
IsTruncated	boolean	Indica se as entradas consultadas estão truncadas. Valores válidos:\n\n* true\n* false.	false

Exemplos

Resposta de sucesso

JSON formato

{
  "NextToken": "K1c3o9K7pFxoTtxH1Nm7MMLb7zrDGvftYBQBPDVv7AD3a8yhRb3Mk8L9ivmN6bFSjfkZNTAg3h4****",
  "RequestId": "768F908D-A66A-5A5D-816C-20C93CBBFEE3",
  "Groups": [
    {
      "GroupName": "TestGroup",
      "Description": "This is a group.",
      "CreateTime": "2021-11-01T02:38:27Z",
      "ProvisionType": "Manual",
      "UpdateTime": "2021-11-01T02:38:27Z",
      "GroupId": "g-00jqzghi2n3o5hkh****"
    }
  ],
  "MaxResults": 10,
  "TotalCounts": 3,
  "IsTruncated": false
}

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.