API SCIM
La API SCIM de Wrike permite el aprovisionamiento y la gestión de usuarios de forma automática al sincronizar los datos de usuario desde tu proveedor de identidad. Úsala para crear, actualizar y desactivar usuarios mientras mantienes un control centralizado sobre el acceso y la información de identidad.
|
Disponibilidad: Legacy Enterprise.; No disponibilidad: Legacy Free, Legacy Professional, Legacy Business.; |
|
Disponibilidad: Pinnacle, Apex. ; Unavailability: Free, Team, Business; |
El System for Cross-domain Identity Management (SCIM) es un estándar para automatizar el intercambio de información de identidad de usuarios entre dominios de identidad o sistemas de TI. Hay soluciones listas para usar de aprovisionamiento SCIM en Wrike con OKTA, OneLogin, y Azure AD, que se describen en detalle en los artículos de ayuda enlazados. Esta página trata sobre el aprovisionamiento SCIM personalizado a través de la API.
Se puede usar para:
-
Aprovisionar nuevos usuarios en Wrike
-
Aprovisionar y actualizar atributos de usuario compatibles
-
Aprovisionar y actualizar atributos personalizados de usuario
-
Desactivar o eliminar usuarios en Wrike
-
Crear y actualizar grupos de usuarios en Wrike
-
Agregar o quitar membresías de grupos
-
Funciona solo en los niveles de suscripción Legacy Enterprise, Pinnacle y Apex.
-
La sincronización es unidireccional: del IdP a Wrike.
-
Las contraseñas de los usuarios no se almacenan en Wrike. Si un usuario se crea mediante SCIM en una cuenta sin SAML SSO, deberá usar la página de restablecimiento de contraseña para crearla.
-
La búsqueda solo se admite por dirección de correo electrónico.
-
Wrike utiliza la dirección de correo electrónico como nombre de usuario. Al aprovisionar o integrar, Wrike buscará un correo electrónico válido en userName o en emails para usarlo como inicio de sesión.
Nota
Como las formas de implementar SCIM varían mucho entre los distintos proveedores de identidad (por ejemplo, mensajes de error, acciones que se admiten o no, etc.), los aspectos específicos de la funcionalidad SCIM y los mensajes de error propios de cada IdP deben revisarse con los administradores de tu IdP y en estrecha colaboración con ellos. La resolución de problemas y la consulta sobre los detalles de la implementación de SCIM en distintos proveedores de identidad están fuera del alcance de trabajo del Equipo de soporte de Wrike.
-
Debes tener una cuenta con suscripción Legacy Enterprise, Pinnacle o Apex y ser administrador con los derechos de «editar nombres y correos, añadir/quitar personas de grupos, exportar una lista de usuarios, desactivar y eliminar cuentas de usuario individuales», «Configurar opciones de seguridad avanzadas» y «Conceder/revocar derechos de admin» habilitados.
-
Add approved domains. Solo los usuarios de dominios aprobados se aprovisionarán automáticamente en Wrike.
-
Genera un token API permanente.
-
En Apps y Integraciones, obtén la URL SCIM de tu cuenta desde la pestaña SCIM de la tarjeta de OKTA, OneLogin o Azure AD.
-
Puedes usar Postman para aprovechar nuestro entorno y colección de llamadas predefinidos. Para preparar un entorno en Postman, descarga e importa:
-
Colección de llamadas SCIM de Wrike para Postman: Wrike SCIM.postman_collection.json
-
Descarga e importa el entorno SCIM de Wrike y añade tu URL base + token permanente: Wrike_SCIM_API.postman_environment.json
-
. Usuarios
-
Listar usuarios integrados - GET {{base_url}}/Users - devuelve un JSON con la información sobre los usuarios existentes de la cuenta que están integrados mediante SCIM. Estos son los usuarios que se crearon mediante invitación y luego se vincularon con la llamada POST /Users, Y los usuarios que se aprovisionaron directamente mediante SCIM. Si creaste algunos usuarios manualmente y aún no los integraste con la llamada n.º 2, no aparecerán en el JSON.
-
Obtener usuario integrado - GET {{base_url}}/Users/ - añade el ID de usuario para recibir un JSON con la información sobre ese usuario, por ejemplo GET {{base_url}}/Users/KUAH4WFR donde KUAH4WFR es el ID de API del usuario.
-
Buscar usuarios integrados usando el filtro eq - GET {{base_url}}/Users?filter=userName eq \"jerome.chef@scim.test\" - busca al usuario por la dirección de correo primaria completa.
-
-
Creación de usuario - POST {{base_url}}/Users + cuerpo de solicitud con formato correcto (puedes ver un ejemplo de cuerpo más abajo) - crea un usuario con los atributos especificados en el cuerpo.
-
Reemplazo de atributos de usuario - PUT {{base_url}}/Users/{{user_id}} + un cuerpo de solicitud con el formato correcto (ejemplo más abajo) - reescribe todos los atributos del usuario según el cuerpo. Esta llamada se puede usar para actualizar el tipo de usuario y desactivar/activar al usuario.
-
Modificación de atributos de usuario - PATCH {{base_url}}/Users/{{user_id}} + un cuerpo de solicitud con el formato correcto (ejemplo más abajo) - prácticamente lo mismo, con la diferencia de que el cuerpo solo contiene los atributos que se van a actualizar y sus nuevos valores.
-
Eliminación de usuario - DELETE {{base_url}}/Users/{{user_id}}.
Atributos personalizados de usuario
-
Los atributos personalizados de usuario se pueden aprovisionar y actualizar mediante la extensión SCIM de Wrike como parte de POST /Users, PUT /Users/{{user_id}}, y PATCH /Users/{{user_id}}.
Grupos
-
Listar grupos - GET {{base_url}}/Groups - devuelve un JSON con la información sobre los grupos de usuarios de Wrike aprovisionados.
-
Obtener grupo - GET {{base_url}}/Groups/{{group_id}} - devuelve un JSON con la información sobre ese grupo.
-
Creación de grupo - POST {{base_url}}/Groups + cuerpo de solicitud con formato correcto - crea un grupo de usuarios de Wrike.
-
Modificación de grupo - PATCH {{base_url}}/Groups/{{group_id}} + cuerpo de solicitud con formato correcto - actualiza los atributos del grupo y los cambios de membresía.
-
Eliminación de grupo - DELETE {{base_url}}/Groups/{{group_id}}.
Este es un ejemplo de cuerpo de solicitud para crear un usuario / vincular un usuario existente / actualizar atributos de usuario:
*userName, correos electrónicos primario y secundarios:
-
El campo userName es obligatorio.
-
Los correos electrónicos (principal y secundarios) son opcionales; puede haber tantos correos en este bloque como necesites.
-
Si NO hay un correo principal en el cuerpo de la solicitud, userName se añade como correo principal del usuario en Wrike.
-
Si hay un correo principal en el cuerpo de la solicitud, este se usa como correo principal del usuario en Wrike.
-
Si hay correos en emails y ninguno está marcado como principal, userName se añade como dirección principal del usuario en Wrike y los demás se añaden como correos secundarios.
**Locales disponibles y su descripción:
Aquí tienes un ejemplo de cuerpo de solicitud para modificar atributos de usuario:
La integración SCIM de Wrike permite definir los tipos de usuario de los usuarios vinculados por SCIM en las solicitudes de aprovisionamiento o actualización mediante el parámetro wrikeUserType.
Los valores aceptados para el atributo wrikeUserType que corresponden a los tipos de usuario predeterminados son \"Regular\", \"External\", \"Collaborator\", \"Viewer\" y \"Contributor\" (en mayúsculas o no).
Nota
"Viewer" y "Contributor" se aceptan si estos tipos de usuario están habilitados en tu cuenta.
El vínculo a los tipos de usuario predeterminados sigue activo aunque los tipos predeterminados se hayan renombrado o modificado (p. ej., si \"Regular user\" se renombró como External, la solicitud con el valor “Regular” se vinculará al mismo tipo de usuario).
Los valores de los IDs de tipo de usuario predeterminado son los siguientes:
-
Owner: -1
-
Admin: -2
-
Regular: -3
-
External: -4
-
Collaborator: -5
-
Viewer: -8
-
Contributor: -10
Nota
Los tipos de usuario Viewer y Contributor pueden o no estar habilitados en tu cuenta. Si tienes dudas, ponte en contacto con tu representante de Customer Success para aclarar si están habilitados.
Un método más sólido y fiable es hacer referencia a los tipos de usuario por sus UID de la API, así que te recomendamos usar siempre este método. Las UID se pueden obtener usando uno de los siguientes métodos:
-
con el método GET /user_types en la API de Wrike.
-
a partir de la respuesta de los métodos CREATE, GET o PATCH para usuarios existentes.
-
El equipo de soporte de Wrike puede proporcionarte las UID de tipos de usuario de tu cuenta tras una solicitud del propietario o admin de la cuenta.
Importante
Ten en cuenta que el atributo name.formatted no se puede modificar mediante el método PATCH. Su valor se genera automáticamente basándose en los atributos de usuario name.familyName y name.givenName.
Wrike admite campos personalizados a nivel de usuario. Estos pueden aprovisionarse mediante SCIM usando una extensión SCIM personalizada:
Cada campo personalizado de usuario se referencia como:
Ejemplo:
El aprovisionamiento de grupos permite:
-
Creación automática de grupos de usuarios de Wrike según los grupos definidos en el IdP
-
Agregar y quitar miembros del grupo
-
Eliminación del grupo cuando se quita del IdP
-
Actualizaciones delta continuas
Los grupos se sincronizan a través del endpoint SCIM /Groups.