API SCIM directa

En este artículo, se proporciona información sobre cómo aprovechar las llamadas manuales a la API para actualizar el aprovisionamiento de usuarios. 

Si prefieres ver un video explicativo, puedes pasar directamente a esta sección.

Para empezar, un usuario administrador de TI de Workvivo puede acceder a la configuración de aprovisionamiento del panel de administración:

seleccionarás Otro como proveedor de SCIM y generarás el token secreto de SCIM.

Además, hay algunos otros parámetros que puedes modificar:

• Permitir que los usuarios se reactiven desde una llamada POST
• Permitir modificar roles de autenticación en SCIM PUT: recomendamos habilitar esto si los roles de usuario se administran a través de llamadas SCIM. Si se administra en el panel de administración, deje esta configuración en 'No'
• Permitir la actualización del modo de autenticación del usuario: recomendamos habilitar esta opción si el aprovisionamiento está configurado con un enfoque híbrido (usuarios en Workvivo que inician sesión a través de SSO y contraseña)

A continuación, encontrarás nuestros ejemplos de POST, PUT y PATCH para que los uses como referencia. Además, se adjunta una colección JSON de muestra como referencia.

Si le dices a tu contacto de Workvivo (PM de incorporación antes del lanzamiento o nuestro Equipo de Soporte a través de "Enviar una solicitud" después del lanzamiento) qué puntos de datos de los empleados te gustaría tener en cada perfil de empleado (por ejemplo, otros tipos de equipo de campos personalizados), podemos prepararlos nosotros y proporcionarte más detalles sobre las llamadas a los atributos específicos si quieres.

Notas:

• Asegúrese de que ExternalID sea único para cada usuario y no cambie.
• Además, no pase valores NULL a Workvivo. En su lugar, utilice cadenas vacías o elimine la operación.

Ejemplo de solicitud POST SCIM:
URL de la solicitud: https://[dominio de la empresa]/scim/v2/scim/Usuarios/
Ejemplo: https://company.workvivo.com/scim/v2/scim/Users/
Método de solicitud: POST (crear)

Ejemplo de solicitud:

{
    "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"
            }
        ]
    }
}

Ejemplo de solicitud PUT de SCIM:

URL de la solicitud: https://[dominio del cliente]/scim/v2/scim/Usuarios/662096
Ejemplo: https://company.workvivo.com/scim/v2/scim/Usuarios/662096

Método de solicitud: PUT (crear o actualizar)

 

Solicitud de muestra:

{
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
    ],
    "externalId": "8751", // Unique Identifier 
    "userName": "Joe.bloggs2@workvivo.com",
    "name": {
        "formatted": "Joe Bloggs",
        "familyName": "Bloggs",
        "givenName": "Joe"
    },
    "emails": [
        {
            "type": "work",
            "value": "Joe.bloggs2@workvivo.com",
            "primary": true
        }
    ],
    "phoneNumbers": [
        {
            "primary": true,
            "type": "work",
            "value": "3534353"
        },
        {
            "primary": true,
            "type": "mobile",
            "value": "+354769999"
        }
    ],
    "addresses": [
        {
            "locality": "Location Name", // Secondary Team
            "type": "work"
        }
    ],
    "title": "Job Title",
    "active": true,
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
        "department": "Department", // Primary Team
        "costCenter": "Operations", // Tertiary Team
        "manager": {
            "displayName": "",
            "value": "654321", // Workvivo ID
            "$ref": ""
        },
        "taxonomies": [  // Additional Teams
            {
                "displayName": "Dv1",
                "type": "Division"
            },
            {
                "displayName": "Workvivo",
                "type": "Company"
            }
        ]
    }
}

Ejemplo de solicitud SCIM PATCH:

URL de la solicitud: https://[dominio del cliente]/scim/v2/scim/Usuarios/662096
Ejemplo: https://company.workvivo.com/scim/v2/scim/Usuarios/662096

Método de solicitud: Parche (actualización)

 

Solicitud de muestra:

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

Atributos y asignaciones predeterminados para Workvivo:
 

Consulte a continuación las asignaciones de términos específicos. No dude en comunicarse con su contacto de Workvivo, por ejemplo, para realizar solicitudes de llamadas a continuación, si es necesario.

• ExternalID: Identificador único proporcionado por usuario que anclará la información del usuario. Esto determinará cualquier cambio en el perfil del usuario.
• Nombre de usuario y correo electrónico: campo de correo electrónico en Workvivo
• Nombre: Nombre de pila
• Apellido: Apellido
• Nombre para mostrar: Nombre para mostrar
• Activo: si la cuenta del usuario debe estar activa o desactivada
• JobTitle: Título del puesto de trabajo del usuario
• DirectDial: Número de teléfono directo (del trabajo)
• Teléfono móvil: Número de teléfono móvil
• DateOfBirth: Fecha de nacimiento
• Fecha de contratación: Fecha de contratación
• Gerente: Administrador del usuario que genera el organigrama
  • Ten en cuenta que debe estar en formato de correo electrónico o WorkvivoID. Si es por correo electrónico, el proveedor SCIM debe ser Okta en la captura de pantalla al inicio
     

Tipos de equipos adicionales:

Comuníquese con su contacto de Workvivo para agregar o ajustar los tipos de equipo en Workvivo

• Departamento: Tipo de equipo predeterminado, relacionado con la configuración de la estructura principal
• Localidad: Tipo de equipo predeterminado, relacionado con la configuración de la estructura secundaria
• CostCenter: Configuración de la estructura terciaria

Para obtener más información sobre nuestros tipos de equipo y configuraciones de estructura, visita nuestro artículo del centro de ayuda aquí
 

Ve el siguiente clip para ver un video explicativo: