API SCIM direta

Este artigo inclui informações sobre como usar as chamadas manuais de API para atualizar o provisionamento de usuários. 

Se preferir assistir a um passo a passo em vídeo, pule para esta seção.

Para começar, um administrador de TI na Workvivo pode acessar as Configurações de provisionamento no Painel de administração:

Você escolherá Outro como Provedor de SCIM e gerará o token secreto de SCIM.

Além disso, há alguns outros parâmetros que você pode alterar:

• Permitir que usuários sejam reativados a partir de uma chamada POST
• Permitir modificação de funções de autenticação no SCIM PUT - recomendamos habilitar isso se as funções de usuário estiverem sendo gerenciadas por meio de chamadas SCIM. Se estiver sendo gerenciado no painel de administração, deixe esta configuração como 'Não'
• Permitir atualização do modo de autenticação do usuário - recomendamos habilitar isso se o provisionamento estiver definido como uma abordagem híbrida (usuários no Workvivo efetuando login via SSO e senha)

Veja abaixo nossos exemplos de POST, PUT e PATCH como referência. Além disso, em anexo há um exemplo de coleção json para referência.

Se você informar ao seu contato da Workvivo (gerente de integração antes do lançamento ou equipe de suporte via "Enviar uma solicitação" após o lançamento) quais pontos de dados de funcionários você gostaria de ter em cada perfil (isto é, tipos de equipe adicionais de campos personalizados), poderemos configurar isso para você na nossa parte e fornecer mais detalhes sobre as chamadas de atributo específicas, se desejado.

Observações:

• Certifique-se de que o ExternalID seja único por usuário e não mude.
• Além disso, não passe valores NULL para o Workvivo. Em vez disso, use strings vazias ou remova a operação.

Exemplo de solicitação POST SCIM:
URL da solicitação: https://[domínio da empresa]/scim/v2/scim/Users/
Exemplo: https://empresa.workvivo.com/scim/v2/scim/Users/
Método de solicitação: POST (criar)

Exemplo de solicitação:

{
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
    ],
    "externalId": "8715", // Unique Identifier 
    "userName": "joe.bloggs@workvivo.com",
    "displayName": "Joe Bloggs",
    "name": {
        "formatted": "Joe Bloggs",
        "familyName": "Bloggs",
        "givenName": "Joe"
    },
    "emails": [
        {
            "type": "work",
            "value": "joe.bloggs@workvivo.com",
            "primary": true
        }
    ],
    "phoneNumbers": [
        {
            "primary": true,
            "type": "work",
            "value": "1234567"
        },
        {
            "primary": true,
            "type": "mobile",
            "value": "+1234567"
        }
    ],
    "addresses": [
        {
            "locality": "Ireland", // Secondary Team
            "type": "work"
        }
    ],
    "title": "Technical Support",
    "active": true,
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
        "department": "Customer Support", // Primary Team
        "costCenter": "Operations", // Tertiary Team
        "manager": {
            "displayName": "",
            "value": "654321",
            "$ref": ""
        },
        "taxonomies": [ // Additional Teams
            {
                "displayName": "Customer Experience",
                "type": "Division"
            },
            {
                "displayName": "Workvivo",
                "type": "Company"
            }
        ]
    }
}

Exemplo de solicitação SCIM PUT:

URL da solicitação: https://[domínio do cliente]/scim/v2/scim/Users/662096
Exemplo: https://company.workvivo.com/scim/v2/scim/Users/662096

Método de solicitação: PUT (criar ou atualizar)

 

Solicitação de amostra:

{
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
    ],
    "externalId": "8751", // identificador Único 
    "userName": "Joe.bloggs2@workvivo.com",
    "nome": {
        "formatted": "Joe Bloggs",
        "familyName": "Bloggs",
        "givenName": "Joe"
    },
 "e-mails": [
 {
            "type": "work",
            "value": "Joe.bloggs2@workvivo.com",
            "primary": true
        }
 ],
 "Números de telefone": [
 {
            "primary": true,
            "type": "work",
            "value": "3534353"
        },
 {
            "primary": true,
            "type": "mobile",
            "value": "+354769999"
        }
 ],
 "endereços": [
 {
            "locality": "Location Name", // Secondary Team
            "type": "work"
        }
 ],
 "título": "Cargo",
 "ativo": verdadeiro,
 "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
        "department": "Suporte Departamento", // Equipe Principal
        "costCenter": "Operações", // Equipe Terciária
        "manager": {
            "displayName": "",
            "value": "654321", // Workvivo ID
            "$ref": ""
        },
        "taxonomies": [ // Equipes Adicionais
            {
                "displayName": "Dv1",
                "type": "Division"
            },
            {
                "displayName": "Workvivo",
                "type": "Company"
            }
        ]
    }
}

Exemplo de solicitação de PATCH do SCIM:

URL da solicitação: https://[domínio do cliente]/scim/v2/scim/Users/662096
Exemplo: https://company.workvivo.com/scim/v2/scim/Users/662096

Método de solicitação: Patch (atualização)

 

Solicitação de amostra:

{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:PatchOp"
    ],
    "Operações": [
        {
            "op": "add",
            "path": "title",
            "value": "New Job Title"
        }
    ]
}

Mapeamentos e atributos padrão para a Workvivo:
 

Veja abaixo os mapeamentos de termos específicos. Não hesite em entrar em contato com seu contato Workvivo para obter exemplos de solicitações de chamadas abaixo, se necessário.

• ExternalID: Identificador exclusivo fornecido por usuário que ancorará as informações do usuário. Isso determinará quaisquer alterações no perfil do usuário
• Nome de usuário e e-mail: campo de e-mail no Workvivo
• FirstName: Nome/Nome Próprio
• Sobrenome: Sobrenome
• DisplayName: Nome de exibição
• Ativo: se a conta do usuário deve estar ativa ou desativada
• JobTitle: Cargo do usuário
• DirectDial: Número de telefone direto (comercial)
• Celular: Número de telefone celular
• DateOfBirth: Data de Nascimento
• HireDate: Data de contratação
• Gerente: Gerente do usuário que gera organograma
  • Deve estar no formato de e-mail ou WorkvivoID. Se for e-mail, o provedor de SCIM precisa ser o Okta, como mostrado na captura de tela inicial
     

Tipos de equipe adicionais:

Entre em contato com seu contato do Workvivo para adicionar ou ajustar os tipos de equipe no Workvivo

• Departamento: Tipo de equipe padrão, relacionado à configuração da estrutura primária
• Localidade: Tipo de equipe padrão, relacionado à configuração da estrutura secundária
• CostCenter: Configuração de estrutura terciária

Para saber mais sobre nossos tipos de equipe e configurações de estrutura, confira o artigo na Central de Ajuda.
 

Veja o guia no vídeo abaixo: