Method: roles.list

Recupera uma lista paginada de todos os papéis em um domínio.

Solicitação HTTP

GET https://admin.googleapis.com/admin/directory/v1/customer/{customer}/roles

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

Parâmetros de caminho

Parâmetros
customer

string

O ID exclusivo da conta do Google Workspace do cliente. No caso de uma conta com vários domínios, use este campo em vez de domain para buscar todos os grupos de um cliente. Também é possível usar o alias my_customer para representar o customerId da sua conta. O customerId também é retornado como parte do recurso Users. É necessário fornecer o parâmetro customer ou domain.

Parâmetros de consulta

Parâmetros
maxResults

integer

Número máximo de resultados a serem retornados.
pageToken

string

Token para especificar a próxima página da lista.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Se bem-sucedido, o corpo da resposta exibirá os dados com a seguinte estrutura:

Representação JSON 
{
  "kind": string,
  "etag": string,
  "items": [
    {
      object (Role)
    }
  ],
  "nextPageToken": string
}
Campos
kind

string

O tipo do recurso da API. É sempre admin#directory#roles.
etag

string

ETag do recurso.
items[]

object (Role)

Uma lista de recursos Papel.
nextPageToken

string

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

  • https://www.googleapis.com/auth/admin.directory.rolemanagement
  • https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly

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