Gerenciar usuários do SCIM na organização
Depois de verificar o domínio e configurar a autenticação SAML da organização, gere o token da API SCIM.
Nesta página
Recursos
Informar o token da API SCIM ao provedor de serviços de identidade permite fazer o seguinte por meio do provedor:
- Criar usuários
- Atribuir ou atualizar funções de usuário
- Desativar usuários
Requisitos
Antes de configurar o gerenciamento de usuários do SCIM, é preciso verificar o domínio e criar uma configuração de SAML. Só é possível gerenciar usuários associados com um domínio verificado.
Configurar o gerenciamento de usuários do SCIM
- No admin de sua organização na Shopify, acesse Usuários > Segurança.
- Na seção Integração com SCIM, clique em Gerar token da API.
- Clique em Copiar para copiar o token gerado para a área de transferência.
- Forneça o token ao provedor de serviços de identidade. O procedimento para adicionar o token depende do provedor utilizado.
Concluir a configuração do SCIM no Okta
- Abra o app Shopify Plus.
-
Clique na aba Entrar.
- Defina o Formato de nome de usuário da solicitação para E-mail.
- Clique em Salvar.
-
Clique na aba Provisão.
- Clique em Configurar integração da API.
- Marque Habilitar integração da API e cole o token da API no campo fornecido.
- Clique em Testar credenciais da API. Se você encontrar um erro, verifique se você copiou corretamente o token da API do admin do Shopify Plus. Caso o erro persista, entre em contato com o Atendimento ao cliente do Plus.
- Clique em Salvar.
Concluir a configuração do SCIM no OneLogin
- Abra o app Shopify Plus.
-
Clique no item de menu Configuração.
- No campo Token de portador do SCIM, cole o token da API.
- Clique em Salvar.
-
Clique no item de menu Parâmetros.
- Defina o valor padrão de Nome de usuário do SCIM como E-mail.
- Clique em Salvar.
Concluir a configuração do SCIM no Azure
- Abra o app Shopify Plus.
- Clique no item de menu Provisionamento.
- Clique em Iniciar.
- No menu Modo de provisionamento, selecione Automático.
- No campo URL do locatário, insira o URL base
https://shopifyscim.com/scim/v2/. - No campo Token secreto, insira o token da API.
- Clique no botão Testar conexão. Caso ocorra um erro, verifique se o token da API foi copiado corretamente do admin do Shopify Plus. Se o problema persistir, entre em contato com o Atendimento ao cliente do Plus.
- Clique em Salvar.
- Altere a opção de Provisionamento de status para Ativado.
- Clique em Salvar.
Após adicionar o token da API ao provedor de serviço de identidade, é possível acrescentar ou remover usuários por meio do serviço. A forma de fazer login pode variar de acordo com o status do usuário na Shopify e com o provedor.
| Status do usuário | Efeito dentro da Shopify |
|---|---|
| O usuário já existe em sua organização | Se você adicionar um usuário ao provedor de serviços de identidade, ele precisará fazer login usando a autenticação SAML caso todas as condições a seguir forem verdadeiras:
|
| O usuário existe na Shopify, mas não na organização | Se você acrescentar um usuário ao provedor de serviços de identidade, ele será adicionado à sua organização e será necessário fazer login usando a autenticação SAML se todas as condições a seguir forem verdadeiras:
|
| O usuário não existe na Shopify | Caso você acrescente um usuário ao provedor de serviços de identidade, ele será adicionado à sua organização e precisará fazer login com autenticação SAML se todas as condições abaixo forem verdadeiras:
|
Após a inclusão do token da API, quando um usuário novo é adicionado na Shopify por meio do provedor de identidade ou do admin da organização, ele terá o status definido como pendente. Caso o login com SAML seja obrigatório, o status permanecerá como pendente até que esse usuário use o provedor de identidade para fazer login.
Atribuição de função no SCIM
Após concluir a configuração do SCIM, é possível atribuir funções aos usuários do SCIM por meio do provedor de serviços de identidade. Antes da atribuição, verifique se a função existe na organização, pois os usuários de SCIM existentes não são atualizados se a função não tiver sido criada para a organização.
Atribuição de funções em provedores de serviço de identidade aceitos
A compatibilidade com atribuição de funções foi adicionada aos apps OneLogin e Okta. No app Azure, o recurso será aceito mais tarde. Para atribuir ou atualizar uma função de usuário SCIM no OneLogin ou Okta, altere o nome da função para um usuário SCIM existente no portal de provisionamento do provedor de serviços de identidade.
Atribuir funções em provedores de serviço de identidade não aceitos
Se o provedor de serviços de identidade não tiver um app Shopify Plus, edite manualmente a configuração do SCIM. Antes de começar, verifique se o provedor permite a inclusão de funções como um campo SCIM.
Para atribuir ou atualizar uma função de usuário do SCIM, o corpo JSON nas solicitações POST, PUT e PATCH precisa incluir este código:
json
{
"name": {
"givenName": "given_name"
"familyName": "family_name"
},
"userName": "email",
"roles": [{"value": "role_name"}]
}
O corpo JSON do SCIM precisa incluir uma chave chamada roles. A chave roles precisa ser uma matriz com um hash que armazene o nome da função. Se houver vários hashes com nomes de função, só o da última função será usado para a atribuição. Caso o nome da função seja inválido ou o corpo JSON do SCIM não corresponda ao modelo acima, as funções não serão atribuídas ou atualizadas.
Desatribuir funções
Para desatribuir uma função de usuário, use o admin da Shopify para organizações. Saiba mais sobre a desatribuição de funções de usuário na Shopify.
Remover a integração com SCIM
Remova a integração com SCIM se ela não for mais obrigatória. Não foi possível desfazer essa ação. Para reativar a integração, é preciso gerar um novo token da API.
Etapas:
- No admin de sua organização na Shopify, acesse Usuários > Segurança.
- Na seção Integração com SCIM, clique em … ao lado do token da API.
- Clique em Excluir token.
Restrições
Não foi possível remover titulares de loja e organização por meio de um provedor de serviços de identidade, pois é preciso transferir os dois tipos de titularidade antes de excluir o usuário. Portanto, para alterar o titular da loja, acesse o admin da Shopify. Já para mudar o titular da organização, entre em contato com o Atendimento ao cliente do Plus.