Neste documento, descrevemos como configurar um locatário do SCIM em um pool de identidades de colaboradores. Para saber mais sobre o SCIM, consulte Provisionamento do SCIM para a federação de identidade de colaboradores.
Cada pool de identidade da força de trabalho aceita apenas um locatário SCIM. Para configurar um novo locatário do SCIM em um pool que já tem um, primeiro exclua permanentemente o locatário atual.
A flag --claim-mapping de um locatário do SCIM pode conter apenas expressões específicas da Common Expression Language (CEL). Para saber quais expressões são aceitas, consulte Mapeamento de declarações.
Verifique se o IdP fornece valores exclusivos e não vazios para atributos mapeados para
google.subject e google.group. A sincronização de valores duplicados falha com um erro HTTP 409 Conflict, e valores nulos ou vazios falham com um erro HTTP 400 Bad Request. Para mais informações, consulte Suporte ao SCIM.
Para configurar o System for Cross-domain Identity Management (SCIM), faça o seguinte:
- Configurar um locatário e um token do SCIM em Google Cloud
- Configurar o SCIM no Okta
- Atualizar o provedor para ativar o SCIM
- Verificar a sincronização do SCIM
Configurar um locatário e um token do SCIM em Google Cloud
Para configurar um locatário do SCIM em Google Cloud, faça o seguinte:
-
Crie um locatário do SCIM.
gcloud iam workforce-pools providers scim-tenants create SCIM_TENANT_ID \ --workforce-pool="WORKFORCE_POOL_ID" \ --provider="PROVIDER_ID" \ --display-name="SCIM_TENANT_DISPLAY_NAME" \ --description="SCIM_TENANT_DESCRIPTION" \ --claim-mapping="CLAIM_MAPPING" \ --location="global"Substitua:
SCIM_TENANT_ID: um ID do seu locatário do SCIM.WORKFORCE_POOL_ID: o ID do pool de força de trabalho que você criou anteriormente neste documento.PROVIDER_ID: o ID do provedor de pool de identidade de colaboradores que você criou anteriormente neste documento.SCIM_TENANT_DISPLAY_NAME: um nome de exibição para seu locatário do SCIM.SCIM_TENANT_DESCRIPTION: uma descrição para seu locatário do SCIM.CLAIM_MAPPING: uma lista separada por vírgulas de mapeamentos de atributos. Para a lista completa de atributos de mapeamento, consulte Mapeamento de declarações. O mapeamento a seguir é recomendado para o Gemini Enterprise:google.subject=user.emails[0].value.lowerAscii(),google.group=group.displayNameO atributo
google.subjectque você mapeia no locatário do SCIM precisa se referir exclusivamente às mesmas identidades mapeadas no atributogoogle.subjectno provedor do pool de identidades de colaboradores usando a flag--attribute-mapping. Depois que o locatário do SCIM é criado, não é possível atualizar o mapeamento de declarações. Para substituir, exclua permanentemente o locatário do SCIM e crie um novo imediatamente. Para saber mais sobre as considerações ao usar o SCIM, consulte Suporte ao SCIM.
-
Quando o comando for concluído, faça o seguinte:
-
No campo
baseUrida saída, salve todo o URI, que está formatado comohttps://iamscim.googleapis.com/v1alpha1/tenants/SCIM_TENANT_UID. Você precisa fornecer esse URI ao seu IdP. -
Além disso, salve apenas o
SCIM_TENANT_UIDdo URI. Você vai precisar desse UID para definir uma política de permissão do IAM no locatário do SCIM mais adiante neste documento.
-
No campo
-
Crie um token do SCIM:
gcloud iam workforce-pools providers scim-tenants tokens create SCIM_TOKEN_ID \ --display-name DISPLAY_NAME \ --scim-tenant SCIM_TENANT_ID \ --workforce-pool WORKFORCE_POOL_ID \ --provider PROVIDER_ID \ --location globalSubstitua:
SCIM_TOKEN_ID: um ID para o token SCIMDISPLAY_NAME: o nome de exibição do token SCIMWORKFORCE_POOL_ID: o ID do pool de colaboradoresSCIM_TENANT_ID: o ID do locatário do SCIMPROVIDER_ID: o ID do provedor do pool de identidade da força de trabalho
-
Quando o comando
gcloud iam workforce-pools providers scim-tenants tokens createfor concluído, faça o seguinte:-
Na saída, salve o valor de
SCIM_TOKENno camposecurityToken. Você precisa fornecer esse token de segurança ao seu IdP. O token de segurança é mostrado apenas nessa saída e, se for perdido, você precisará criar um novo token do SCIM. -
Para verificar se o
SCIM_TOKENfoi rejeitado pela política da sua organização, execute o seguinte comando:curl -v -H "Authorization: Bearer SCIM_TOKEN" https://iamscim.googleapis.com/v1alpha1/tenants/SCIM_TENANT_UID/Users
Se o comando falhar com um erro relacionado a permissões, execute
gcloud organizations add-iam-policy-binding, descrito em uma etapa posterior. Se o comando for bem-sucedido, pule essa etapa.
-
-
Defina uma política de permissão do IAM no locatário e no token do SCIM. Se o comando
curlem uma etapa anterior falhou com um erro relacionado a permissões, execute o seguinte comando:gcloud organizations add-iam-policy-binding ORGANIZATION_ID \ --member=serviceAccount:SERVICE_AGENT_EMAIL \ --role roles/iam.scimSyncerSubstitua:
- ORGANIZATION_ID: o ID da organização.
- SERVICE_AGENT_EMAIL: o endereço de e-mail do agente de serviço. O endereço de e-mail está no seguinte formato:
o-ORGANIZATION_ID-SCIM_TENANT_UID@gcp-sa-iamscim.iam.gserviceaccount.com. SCIM_TENANT_UID é retornado quando você cria o locatário do SCIM.
Ao provisionar grupos no IdP, verifique se o nome de exibição de cada grupo, conforme fornecido no campo displayName, é exclusivo em um locatário do SCIM. Para saber mais sobre grupos e
SCIM no Microsoft Entra ID, consulte
Grupos.
Configurar o SCIM no Okta
Para configurar o SCIM no Okta, faça o seguinte no aplicativo Okta:
- Faça login no Admin Console do Okta.
- Acesse Aplicativos > Aplicativos.
Selecione ou crie um aplicativo:
Se você quiser selecionar um aplicativo que já existe, faça o seguinte:
- Clique no nome do aplicativo que você criou usando o modelo da federação de identidade de colaboradores do Google Cloud.
-
Na guia Geral, faça o seguinte:
- No painel Configurações do app, clique em Editar.
- No campo Locatário, insira o ID do locatário obtido na CLI gcloud.
- Clique em Concluído.
Se quiser criar um aplicativo, faça o seguinte:
- Clique em Procurar no catálogo de apps.
- No campo Pesquisar, insira Federação de identidade de colaboradores do Google Cloud e selecione a integração Federação de identidade de colaboradores do Google Cloud nos resultados.
Clique em Adicionar integração.
- No campo Aplicativo, insira um nome para seu app.
- No campo Locatário, insira o ID do locatário obtido na CLI gcloud.
- Clique em Concluído.
-
Na guia Provisionamento, faça o seguinte:
No painel Integração, clique em Editar.
- No campo Token de API, insira o token SCIM que você recebeu de Google Cloud.
- Para confirmar a validade do token de API, clique em Testar credenciais.
- Selecione Importar grupos.
- Clique em Salvar.
No painel Para app, clique em Editar.
- Selecione Criar usuários, Atualizar atributos do usuário e Desativar usuários.
- Clique em Salvar.
Atualizar o provedor para ativar o SCIM
Para ativar o SCIM em um provedor, defina a flag --scim-usage com base na meta do produto:
-
Ativado para grupos (
enabled-for-groups): usado para o Gemini Enterprise. Usa grupos sincronizados com SCIM para autorização do IAM e avaliação de políticas. Os atributos do usuário continuam sendo originados dos tokens de login do IdP. -
Ativado para usuários e grupos (
enabled-for-users-groups): usado para o Looker (prévia). Usa dados de usuários e grupos sincronizados com o SCIM como a principal fonte de declarações para autorização do IAM e fluxos de trabalho de login do OAuth.
Ativar o SCIM para grupos (Gemini Enterprise)
OIDC
gcloud iam workforce-pools providers update-oidc PROVIDER_ID \
--workforce-pool=WORKFORCE_POOL_ID \
--location=LOCATION \
--scim-usage=enabled-for-groups
Substitua:
PROVIDER_ID: o ID do provedor do pool de identidade da força de trabalhoWORKFORCE_POOL_ID: o ID do pool de colaboradoresLOCATION: o local do pool de colaboradores
SAML
gcloud iam workforce-pools providers update-saml PROVIDER_ID \
--workforce-pool=WORKFORCE_POOL_ID \
--location=LOCATION \
--scim-usage=enabled-for-groups
Substitua:
PROVIDER_ID: o ID do provedor do pool de identidade da força de trabalhoWORKFORCE_POOL_ID: o ID do pool de colaboradoresLOCATION: o local do pool de colaboradores
Ativar o SCIM para usuários e grupos (Looker) (prévia)
OIDC
gcloud iam workforce-pools providers update-oidc PROVIDER_ID \
--workforce-pool=WORKFORCE_POOL_ID \
--location=LOCATION \
--scim-usage=enabled-for-users-groups
Substitua:
PROVIDER_ID: o ID do provedor do pool de identidade da força de trabalhoWORKFORCE_POOL_ID: o ID do pool de colaboradoresLOCATION: o local do pool de colaboradores
SAML
gcloud iam workforce-pools providers update-saml PROVIDER_ID \
--workforce-pool=WORKFORCE_POOL_ID \
--location=LOCATION \
--scim-usage=enabled-for-users-groups
Substitua:
PROVIDER_ID: o ID do provedor do pool de identidade da força de trabalhoWORKFORCE_POOL_ID: o ID do pool de colaboradoresLOCATION: o local do pool de colaboradores
Para verificar a sincronização do SCIM, consulte Verificar a sincronização do SCIM.
Mapeamento de declarações
Ao configurar o SCIM, você define mapeamentos de declarações (--claim-mapping) no locatário do SCIM para mapear atributos de usuários e grupos do SCIM para atributos do Google.
Atributos Google Cloud compatíveis para mapeamento de declarações
A tabela a seguir lista os atributos Google Cloud que podem ser mapeados no seu locatário do SCIM (--claim-mapping) usando a Common Expression Language (CEL):
| AtributoGoogle Cloud | Requisito | Descrição | Expressões e limites aceitos |
|---|---|---|---|
google.subject |
Obrigatório |
Identificador exclusivo do usuário autenticado. O atributo do IdP usado para preencher |
Restrito às seguintes expressões básicas (ou com .lowerAscii()):
Comprimento máximo: 127 bytes. Observação:esse mapeamento é imutável depois que o locatário do SCIM é criado. Para atualizá-lo, é necessário excluir permanentemente e recriar o locatário do SCIM. |
google.group |
Obrigatório para grupos do SCIM | Identificador exclusivo da associação ao grupo sincronizada usando o SCIM. | Restrito às seguintes expressões básicas (ou com .lowerAscii()):
Observação:esse mapeamento é imutável depois que o locatário do SCIM é criado. Para atualizá-lo, é necessário excluir permanentemente e recriar o locatário do SCIM. |
google.display_name |
Opcional | Um atributo que define o nome do usuário conectado no console Google Cloud . Ele não pode ser usado em políticas de permissão do IAM. | Mapeia para um atributo de string, como user.displayName ou user.name.formatted. Tamanho máximo: 100 bytes. |
google.profile_photo |
Opcional | Um URL da miniatura da foto do usuário que aparece como foto do perfil no console do Google Cloud . Ele não pode ser usado em políticas de permissão do IAM. | Precisa ser avaliado como uma string de URL válida (como user.photos.filter(p, p.type == 'thumbnail')[0].value ou user.photos[0].value). |
google.email |
Opcional | Um atributo usado para mapear endereços de e-mail do IdP para produtos integrados usando a integração do cliente OAuth da federação de identidade de colaboradores. Ele não pode ser usado em políticas de permissão do IAM. | Mapeia para um atributo de e-mail, como user.emails.filter(e, e.type == 'work')[0].value ou user.emails[0].value. |
google.posix_username |
Opcional | Uma string de nome de usuário exclusiva compatível com POSIX usada para SSH no navegador e Login do SO com a federação de identidade de colaboradores. Esse atributo não pode ser usado nas políticas de permissão do IAM. | O tamanho máximo é de 32 caracteres. |
attribute.KEY |
Opcional |
Atributos personalizados do seu IdP que podem ser usados para definir sua estratégia de autorização em uma política de permissão do IAM. Substitua KEY pelo nome do atributo que você quer usar. Por exemplo, é possível definir um atributo personalizado como |
Até 50 regras de mapeamento de atributos personalizados. Tamanho máximo por regra: 256 caracteres. |
Exemplos de mapeamentos para consistência de assunto
Conforme descrito em Atributos compatíveis com o mapeamento de declarações,
o atributo do IdP usado para preencher google.subject precisa ser idêntico no mapeamento do
provedor (--attribute-mapping) e no locatário do SCIM (--claim-mapping).
A tabela a seguir mostra exemplos de referência para o Okta:
| Atributo do Google | Mapeamento de provedor de pool de identidade de colaboradores | Mapeamento de locatário do SCIM |
|---|---|---|
google.subject |
assertion.sub |
user.externalId |
google.subject |
assertion.subject |
user.userName |
google.subject |
assertion.subject.lowerAscii() |
user.userName.lowerAscii() |
google.subject |
assertion.preferred_username |
user.userName |
google.subject |
assertion.preferred_username.lowerAscii() |
user.userName.lowerAscii() |
google.subject |
assertion.email |
user.emails[0].value |
google.subject |
assertion.email.lowerAscii() |
user.emails[0].value.lowerAscii() |
Verificar a sincronização do SCIM
Depois de configurar o SCIM, use curl para verificar se os usuários e grupos estão sendo sincronizados corretamente com Google Cloud. Esses comandos exigem um token SCIM válido e seu ID de locatário do SCIM.
Verificar a sincronização de usuários
Para verificar se um usuário foi sincronizado corretamente, pesquise o userName dele usando o seguinte filtro:
curl -H "Authorization: Bearer SCIM_TOKEN" \ "https://iamscim.googleapis.com/v1alpha1/tenants/SCIM_TENANT_UID/Users?filter=userName%20eq%20%22USER_NAME%22"
Exemplo de resposta:
{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
"totalResults": 1,
"Resources": [
{
"id": "USER_ID",
"userName": "USER_NAME",
...
}
]
}
Verificar a sincronização de grupo
Para verificar se um grupo foi sincronizado corretamente, pesquise o displayName dele usando o seguinte filtro:
curl -H "Authorization: Bearer SCIM_TOKEN" \ "https://iamscim.googleapis.com/v1alpha1/tenants/SCIM_TENANT_UID/Groups?filter=displayName%20eq%20%22GROUP_NAME%22"
Exemplo de resposta:
{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
"totalResults": 1,
"Resources": [
{
"id": "GROUP_ID",
"displayName": "GROUP_NAME",
...
}
]
}
Verificar a associação ao grupo
Para verificar se um usuário específico é membro de um grupo, use um filtro que especifique o ID do grupo e o ID do usuário.
curl -H "Authorization: Bearer SCIM_TOKEN" \ "https://iamscim.googleapis.com/v1alpha1/tenants/SCIM_TENANT_UID/Groups?filter=id%20eq%20%22GROUP_ID%22%20and%20members%20eq%20%22USER_ID%22"
Exemplo de resposta se o usuário for assinante:
{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
"totalResults": 1,
"Resources": [
{
"id": "GROUP_ID",
"displayName": "GROUP_NAME",
...
}
]
}
Exemplo de resposta se o usuário não for assinante:
{
"schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"],
"totalResults": 0,
"Resources": []
}
Observação:para conseguir o GROUP_ID e o USER_ID, primeiro encontre o grupo e o usuário usando os filtros displayName e userName. Os IDs são retornados no campo id da resposta. Substitua SCIM_TOKEN, SCIM_TENANT_UID, USER_NAME, GROUP_NAME, GROUP_ID e USER_ID pelos seus valores reais.
Forçar a exclusão de um locatário do SCIM
Para forçar a exclusão de um locatário do SCIM, faça o seguinte:
- Se
--scim-usage=enabled-for-groupsou--scim-usage=enabled-for-users-groupsestiver definido para seu provedor, desative-o na configuração do provedor:gcloud iam workforce-pools providers update-oidc PROVIDER_ID \ --workforce-pool=WORKFORCE_POOL_ID \ --location=LOCATION \ --scim-usage=SCIM_USAGE_UNSPECIFIEDSubstitua:
PROVIDER_ID: o ID do provedor do pool de identidade da força de trabalhoWORKFORCE_POOL_ID: o ID do pool de colaboradoresLOCATION: o local do pool de colaboradores
- Exclua o locatário do SCIM:
gcloud iam workforce-pools providers scim-tenants delete SCIM_TENANT_ID \ --workforce-pool=WORKFORCE_POOL_ID \ --provider=PROVIDER_ID \ --hard-delete \ --location=globalSubstitua:
SCIM_TENANT_ID: o ID do locatário do SCIM a ser excluídoWORKFORCE_POOL_ID: o ID do pool de colaboradoresPROVIDER_ID: o ID do provedor do pool de identidade da força de trabalho
A seguir
- Resolver problemas de provisionamento do SCIM
- Excluir os usuários da federação de identidade de colaboradores e respectivos dados
- Saiba quais produtos do Google Cloud são compatíveis com a federação de identidade de colaboradores
- Configurar o acesso do usuário ao console (federado)