Recuperar grupos empresariais com a API Cloud OAuth

Neste guia, descrevemos como recuperar associações a grupos empresariais para usuários autenticados da força de trabalho usando o endpoint /groups na API Cloud OAuth (cloudoauth.googleapis.com).

O endpoint /groups serve como um endpoint de declarações distribuídas para integrações do OpenID Connect (OIDC), retornando associações paginadas a grupos empresariais para usuários em pools de identidade da força de trabalho habilitados e não habilitados para SCIM.

Antes de começar

  1. Configure um pool e um provedor de identidade da força de trabalho. Para mais informações, consulte Configurar a federação de identidade de colaboradores.
  2. Registre um cliente OAuth e troque um código de autorização por um token de acesso. Para mais informações, consulte Trocar tokens com a API Cloud OAuth.

  3. Ative a API Cloud OAuth.

    Funções necessárias para ativar APIs

    Para ativar APIs, você precisa da permissão serviceusage.services.enable. Se você criou o projeto, provavelmente já tem essa permissão com o papel de Proprietário (roles/owner). Caso contrário, é possível receber essa permissão com o papel de Administrador do Service Usage (roles/serviceusage.serviceUsageAdmin). Saiba como conceder papéis.

    Ativar a API

Recuperar grupos empresariais

Para recuperar as associações de grupo do usuário autenticado, envie uma solicitação HTTP GET ao endpoint /groups:

O método common.groups da API Cloud OAuth recupera as associações a grupos empresariais do usuário autenticado.

Antes de usar os dados da solicitação abaixo, faça as substituições a seguir:

  • TOKEN: o token de acesso OAuth 2.0 de curta duração obtido do endpoint de troca de token.
  • PAGE_SIZE: opcional. O número máximo de grupos a serem retornados por página (entre 2.500 e 5.000).
  • PAGE_TOKEN: opcional. Um token de paginação recebido de uma resposta /groups anterior no campo next_page_token.

Método HTTP e URL: 

GET https://cloudoauth.googleapis.com/v1/common/groups?page_size=PAGE_SIZE&page_token=PAGE_TOKEN

Para enviar a solicitação, expanda uma destas opções:

Você receberá uma resposta JSON semelhante a esta:

{
  "groups": [
    "security-admin@example.com",
    "data-analysts@example.com",
    "looker-developers@example.com"
  ],
  "next_page_token": "AE12aBcDeFgHiJkLmNoPqRsTuVwXyZ"
}

Campos de resposta

A resposta contém os seguintes campos:

Campo Tipo Descrição
groups array of strings A lista de identificadores de grupo empresarial ou endereços de e-mail a que o usuário autenticado pertence.
next_page_token string Um token que pode ser transmitido como page_token em solicitações subsequentes para recuperar a próxima página de resultados. Se o campo for omitido ou estiver vazio, não haverá páginas subsequentes.

Para informações sobre respostas de erro retornadas pelo endpoint /groups, consulte Erros de grupos e informações do usuário do Cloud OAuth.

A seguir