Method: customers.v2.Groups.list

Recupera uma lista de grupos.

  • As solicitações precisam especificar um filtro. As solicitações sem um parâmetro filter retornam um erro tooMany.
  • O parâmetro filter só oferece suporte à igualdade em displayName (por exemplo, displayName eq "Group Name") ou externalId (por exemplo, externalId eq "ddaafa46e2b6").
  • Não há suporte para correspondências de substrings (co, sw, ew), operadores lógicos (and, or) e filtros de valores complexos.
  • Não há suporte para paginação. Se houver mais de 50 correspondências de grupo, somente os primeiros 50 resultados serão retornados.

Solicitação HTTP

GET https://cloudidentityscim.googleapis.com/v1/customers/{customerId}/v2/Groups

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
customerId

string

Obrigatório. ID do cliente.

Parâmetros de consulta

Parâmetros
filter

string

O parâmetro de filtro.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Mensagem de resposta da listagem de grupos.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "schemas": [
    string
  ],
  "resources": [
    {
      object (Group)
    }
  ],
  "totalResults": integer
}
Campos
schemas[]

string

Os esquemas dos recursos retornados.
resources[]

object (Group)

A lista de recursos solicitados.
totalResults

integer

O número total de resultados.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/cloud-identity.groups.readonly
  • https://www.googleapis.com/auth/cloud-identity.groups
  • https://www.googleapis.com/auth/cloud-identity
  • https://www.googleapis.com/auth/cloud-platform

Para mais informações, consulte o guia de autorização.