API SCIM
A API SCIM no Wrike permite o provisionamento e a gestão automática de usuários sincronizando dados de usuários do seu provedor de identidade. Use-a para criar, atualizar e desativar usuários mantendo o controle centralizado sobre acesso e informações de identidade.
|
Availability: Legacy Enterprise.; Unavailability: Legacy Free, Legacy Professional, Legacy Business.; |
|
Disponibilidade: Pinnacle, Apex. Indisponibilidade: Free, Team, Business; |
O System for Cross-domain Identity Management (SCIM) é um padrão que automatiza a troca de informações de identidade de usuários entre domínios de identidade ou sistemas de TI. Existem soluções prontas para provisionamento SCIM no Wrike com OKTA, OneLogin e Azure AD, detalhadas nos artigos de ajuda vinculados. Esta página aborda o provisionamento SCIM personalizado via API.
Ele pode ser usado para:
-
Provisionar novos usuários no Wrike
-
Provisionar e atualizar atributos de usuário compatíveis
-
Provisionar e atualizar atributos personalizados de usuário
-
Desativar ou excluir usuários no Wrike
-
Criar e atualizar grupos de usuários no Wrike
-
Adicionar ou remover membros do grupo
-
Funciona somente nos planos de assinatura Legacy Enterprise, Pinnacle e Apex.
-
A sincronização é unidirecional – do IdP para o Wrike.
-
As senhas dos usuários não são armazenadas no Wrike. Se um usuário for criado via SCIM em uma conta sem SAML SSO, ele precisará usar a página de redefinição de senha para criar uma senha.
-
A pesquisa é suportada apenas pelo endereço de e-mail.
-
O Wrike usa o endereço de e-mail como nome de usuário. Durante o provisionamento ou integração, o Wrike procurará um e-mail válido em userName ou emails para usar como login.
Observação
Como as formas de implementação do SCIM variam muito entre diferentes provedores de identidade (como mensagens de erro, ações que são ou não suportadas etc.), os aspectos específicos de cada IdP relacionados à funcionalidade e às mensagens de erro do SCIM devem ser investigados pelos administradores do seu IdP e em estreita cooperação com eles. A solução de problemas e a consultoria sobre as especificidades da implementação do SCIM em diferentes provedores de identidade estão fora do escopo de trabalho da equipe de suporte do Wrike.
-
Você deve ter uma conta com assinatura Legacy Enterprise, Pinnacle ou Apex e ser um administrador com os direitos "editar nomes e e-mails, adicionar/remover pessoas de grupos, exportar uma lista de usuários, desativar e excluir contas de usuário individuais", "Configurar definições de segurança avançadas" e "Conceder/revogar direitos de administrador" ativados.
-
Add approved domains. Somente usuários de domínios aprovados serão provisionados automaticamente no Wrike.
-
Gere um token de API permanente.
-
Em Apps & Integrations, obtenha a URL SCIM da sua conta na guia SCIM do cartão OKTA, OneLogin ou Azure AD.
-
Você pode usar o Postman para utilizar nosso ambiente e coleção de chamadas pré-prontos. Para preparar um ambiente Postman, faça o download e importe:
-
Coleção de chamadas SCIM do Wrike para Postman: Wrike SCIM.postman_collection.json
-
Baixe e importe o ambiente SCIM do Wrike, adicione sua URL base + token permanente: Wrike_SCIM_API.postman_environment.json
-
. Usuários
-
Listar usuários integrados - GET {{base_url}}/Users - retorna um JSON com informações sobre os usuários existentes da conta que estão integrados via SCIM. Esses são usuários criados por convite e depois vinculados com a chamada POST /Users, além dos usuários provisionados diretamente via SCIM. Se você criou alguns usuários manualmente e ainda não os integrou com a chamada nº 2, eles não aparecerão no JSON.
-
Obter usuário integrado - GET {{base_url}}/Users/ - adicione o ID do usuário para receber um JSON com as informações desse usuário, por exemplo GET {{base_url}}/Users/KUAH4WFR onde KUAH4WFR é o ID de API do usuário.
-
Pesquisar usuários integrados usando filtro eq - GET {{base_url}}/Users?filter=userName eq "jerome.chef@scim.test" - pesquisa o usuário pelo endereço de e-mail completo primário.
-
-
Criação de usuário - POST {{base_url}}/Users + corpo de requisição devidamente formatado (veja abaixo um exemplo de corpo de requisição com explicação) - cria um usuário com os atributos especificados no corpo da requisição.
-
Substituição de atributos de usuário - PUT {{base_url}}/Users/{{user_id}} + corpo de requisição devidamente formatado (veja abaixo um exemplo de corpo de requisição com explicação) - reescreve todos os atributos do usuário de acordo com o corpo da requisição. Essa chamada pode ser usada para atualizar o tipo de usuário e desativar/ativar o usuário.
-
Patch de atributos de usuário - PATCH {{base_url}}/Users/{{user_id}} + corpo de requisição devidamente formatado (veja abaixo um exemplo de corpo de requisição com explicação) - quase o mesmo, com a diferença de que o corpo da requisição contém apenas os atributos a serem atualizados e seus novos valores.
-
Exclusão de usuário - DELETE {{base_url}}/Users/{{user_id}}.
Atributos personalizados do usuário
-
Os atributos personalizados de usuário podem ser provisionados e atualizados por meio da extensão SCIM do Wrike como parte das chamadas POST /Users, PUT /Users/{{user_id}} e PATCH /Users/{{user_id}}.
Grupos
-
Listar grupos - GET {{base_url}}/Groups - retorna um JSON com informações sobre os grupos de usuários do Wrike provisionados.
-
Obter grupo - GET {{base_url}}/Groups/{{group_id}} - retorna um JSON com informações sobre esse grupo.
-
Criação de grupo - POST {{base_url}}/Groups + corpo de requisição devidamente formatado - cria um grupo de usuários do Wrike.
-
Patch de grupo - PATCH {{base_url}}/Groups/{{group_id}} + corpo de requisição devidamente formatado - atualiza atributos do grupo e alterações de membros.
-
Exclusão de grupo - DELETE {{base_url}}/Groups/{{group_id}}.
Este é um exemplo de corpo de requisição para criar um usuário / vincular um usuário existente / atualizar atributos de usuário:
*userName, e-mails primário e secundários:
-
userName é um campo obrigatório.
-
E-mails (primário e secundários) são opcionais; pode haver quantos e-mails forem necessários neste bloco.
-
Se NÃO houver e-mail primário no corpo da requisição, userName será adicionado como e-mail primário do usuário no Wrike.
-
Se HOUVER um e-mail primário no corpo da requisição, ele será usado como o e-mail primário do usuário no Wrike.
-
Se houver e-mails em emails e nenhum deles estiver marcado como primário, então userName será adicionado como endereço primário do usuário no Wrike e os demais serão adicionados como e-mails secundários.
**Idiomas disponíveis e o que significam:
Aqui está um exemplo de corpo de requisição para aplicar patch nos atributos de usuário:
A integração Wrike - SCIM permite definir os tipos de usuário dos usuários vinculados ao SCIM em solicitações de provisionamento ou atualização usando o parâmetro wrikeUserType.
Os valores aceitos para o atributo wrikeUserType correspondentes aos tipos de usuário padrão são "Regular", "External", "Collaborator", "Viewer" e "Contributor" (com ou sem capitalização).
Nota
"Viewer" e "Contributor" são aceitos se esses tipos de usuário estiverem habilitados na sua conta.
O vínculo com os tipos de usuário padrão permanece ativo mesmo que esses tipos tenham sido renomeados/modificados (por exemplo, se "Regular user" for renomeado para Externo, a solicitação com o valor “Regular” ainda será vinculada ao mesmo tipo de usuário).
Os valores dos IDs dos tipos de usuário padrão são os seguintes:
-
Owner: -1
-
Admin: -2
-
Regular: -3
-
External: -4
-
Collaborator: -5
-
Viewer: -8
-
Contributor: -10
Nota
Viewer and Contributor tipos de usuário podem ou não estar habilitados na sua conta. Se estiver em dúvida, entre em contato com seu representante de sucesso do cliente para verificar se eles estão habilitados.
Um método mais robusto e confiável é referenciar os tipos de usuário pelos seus UIDs da API - portanto, sempre prefira esse método. Os UIDs podem ser obtidos usando um dos métodos a seguir:
-
com o método GET /user_types na API do Wrike.
-
a partir da resposta dos métodos CREATE, GET ou PATCH para usuários existentes.
-
A equipe de suporte do Wrike pode fornecer os UIDs dos tipos de usuário da sua conta mediante solicitação do proprietário ou administrador da conta.
Importante
Observe que o atributo name.formatted não pode ser atualizado usando o método PATCH. Seu valor é gerado automaticamente com base nos atributos de usuário name.familyName e name.givenName.
Wrike oferece suporte a campos personalizados no nível do usuário. Eles podem ser provisionados via SCIM usando uma extensão SCIM personalizada:
Cada campo personalizado de usuário é referenciado como:
Exemplo:
O provisionamento de grupos permite:
-
Criação automática de grupos de usuários do Wrike com base nos grupos definidos no IdP
-
Adicionar e remover membros do grupo
-
Exclusão do grupo quando ele for removido do IdP
-
Atualizações incrementais contínuas
Os grupos são sincronizados pelo endpoint SCIM /Groups.