Aprovisionar usuarios y grupos con SCIM

La API de SCIM de Notion te permite hacer lo siguiente:

• Crea y elimina miembros del espacio de trabajo.

• Actualiza la información del perfil de los miembros.

• Recupera miembros del espacio de trabajo.

• Encuentra miembros por correo electrónico o por nombre.

• Crea y elimina grupos del espacio de trabajo.

• Agrega y elimina miembros de cualquier grupo.

• Recupera grupos del espacio de trabajo.

• Encuentra grupos por nombre.

En este momento, Notion es compatible con Okta, OneLogin, Rippling y aplicaciones de SCIM personalizadas. Si tienes otro proveedor de identidades, ponte en contacto con nosotros. Consulta las instrucciones para la configuración del proveedor de identidad para aplicaciones específicas aquí →

Para usar SCIM con Notion:

• El espacio de trabajo debe pertenecer a un plan Enterprise.

• El proveedor de identidades (IDP) debe ser compatible con el protocolo SAML 2.0. Consulta las instrucciones para la configuración del proveedor de identidad para aplicaciones específicas aquí →

• Un propietario del espacio de trabajo de Notion debe configurar SCIM.

• Si deseas usar SCIM para modificar el nombre o la dirección de correo electrónico de un usuario, debes contar con la propiedad verificada de un dominio de correo electrónico. Descubre más sobre la verificación de dominios →

Solo los propietarios de organizaciones en planes Enterprise pueden generar y ver los tokens de la API de SCIM. Para crear un token de API de SCIM:

1. Abre el selector de espacio de trabajo y selecciona Administrar organización. Es posible que tengas que configurar la organización primero si aún no lo hiciste. Descubre más aquí →

2. En la pestaña General de los controles de la organización, selecciona > junto a Aprovisionamiento de SCIM.

Cuando el rol de un propietario de un espacio de trabajo cambie y cuando abandone el espacio de trabajo, se revocará su token. Cuando esto ocurra, se enviará un mensaje automático al resto de los propietarios de espacios de trabajo para avisarles de que deben sustituir el token revocado.

Además, cualquiera de los propietarios del espacio de trabajo puede revocar los tokens activos. Para revocar un token, haz clic en 🗑 junto al token correspondiente.

Si se revoca un token, deberás reemplazarlo en todas las integraciones existentes.

Las integraciones de SCIM y los aprovisionamientos de usuarios que dependan del token revocado se desactivarán hasta que se lo reemplace con un token activo.

Para controlar si los usuarios recibirán invitaciones a espacios de trabajo y grupos por correo electrónico cuando los aprovisione SCIM, los propietarios de la organización en el plan Enterprise pueden:

1. Abre el selector de espacio de trabajo y selecciona Administrar organización.

2. En la pestaña General, activa la opción Suprimir correos electrónicos de invitación del aprovisionamiento de SCIM si no deseas enviar correos electrónicos a los usuarios.

• GET /ServiceProviderConfig

  • GET <https: mem-invalid-attributes-holder=api.notion.com mem-invalid-attributes-holder=scim mem-invalid-attributes-holder=v2 mem-invalid-attributes-holder=serviceproviderconfig>


  • Recupera una descripción de las funciones de la especificación SCIM disponibles.

  • Según la definición proporcionada en la Sección 5 de la especificación del protocolo SCIM.

• GET /ResourceTypes

  • GET <https: mem-invalid-attributes-holder=api.notion.com mem-invalid-attributes-holder=scim mem-invalid-attributes-holder=v2 mem-invalid-attributes-holder=resourcetypes>


  • Recupera una lista de los tipos de recursos de SCIM disponibles.

  • Según la definición proporcionada en la Sección 6 de la especificación del protocolo SCIM.

En la siguiente tabla se detalla la asignación entre los atributos de usuario de SCIM y los campos del perfil de usuario de Notion. Se ignorarán el resto de los atributos de usuario.

• GET /Users

  • GET <https: mem-invalid-attributes-holder=api.notion.com mem-invalid-attributes-holder=scim mem-invalid-attributes-holder=v2 mem-invalid-attributes-holder=users>


  • Recupera una lista paginada de miembros del espacio de trabajo.

  • Puedes usar los parámetros startIndex y count para la numeración. Ten en cuenta que el parámetro startIndex está indexado a 1 y el parámetro count tiene un máximo de 100.

  • 
    Puedes filtrar los resultados con el parámetro filter. Los atributos válidos para filtrar son email, given_namey family_name, por ejemplo, GET <https: mem-invalid-attributes-holder=api.notion.com mem-invalid-attributes-holder=scim mem-invalid-attributes-holder=v2 users?startindex="1&count=50&filter=email">
eq [email protected]

  • Ten en cuenta que given_name y family_name distinguen entre mayúsculas y minúsculas. El correo electrónico se convierte a minúsculas.

• GET /Users/<id>

  • GET <https: mem-invalid-attributes-holder=api.notion.com mem-invalid-attributes-holder=scim mem-invalid-attributes-holder=v2 mem-invalid-attributes-holder=users/><id>

  • Recupera un miembro específico del espacio de trabajo por su ID de usuario de Notion. El identificador es único y universal (UUID) y cuenta con 32 caracteres dispuestos de esta manera: 00000000-0000-0000-0000-000000000000.

  • Ten en cuenta que meta.created y meta.lastModified reflejan valores de marca de tiempo significativos.

• POST /Users

  • POST <https: mem-invalid-attributes-holder=api.notion.com mem-invalid-attributes-holder=scim mem-invalid-attributes-holder=v2 mem-invalid-attributes-holder=users>


  • Si el usuario que quieres agregar ya tiene una cuenta de usuario de Notion con la misma dirección de correo electrónico, se agregará el usuario al espacio de trabajo.

  • Si el usuario no existe, esta llamada creará un nuevo usuario de Notion y lo agregará al espacio de trabajo. Se lo asignará al perfil de usuario de Notion que se creó.

  • La API de SCIM leerá la propiedad de la foto de perfil al crear el usuario, pero no en futuras actualizaciones.

• PATCH /Users/<id>

  • PATCH <https: mem-invalid-attributes-holder=api.notion.com mem-invalid-attributes-holder=scim mem-invalid-attributes-holder=v2 mem-invalid-attributes-holder=users/><id>

  • Actualiza mediante una serie de operaciones y devuelve el registro de usuario actualizado.

• PUT /Users/<id>

  • PUT <https: mem-invalid-attributes-holder=api.notion.com mem-invalid-attributes-holder=scim mem-invalid-attributes-holder=v2 mem-invalid-attributes-holder=users/><id>

  • Actualiza y devuelve el registro de usuario actualizado.

• DELETE /Users/<id>

  • DELETE <https: mem-invalid-attributes-holder=api.notion.com mem-invalid-attributes-holder=scim mem-invalid-attributes-holder=v2 mem-invalid-attributes-holder=users/><id>

  • Elimina un usuario del espacio de trabajo. Se cierran todas las sesiones abiertas del usuario.

    • La cuenta del usuario no se puede eliminar mediante SCIM. Debe llevarse a cabo de forma manual.

    • La eliminación de un usuario de tu espacio de trabajo también se puede lograr estableciendo el atributo de usuario active en false enviando una solicitudPATCH /Users/<id> o PUT /Users/<id>.

    • El propietario del espacio de trabajo que generó el token del bot SCIM no se puede eliminar mediante la API. Cuando se elimine al propietario de un espacio de trabajo mediante la API de SCIM, se revocarán los tokens que haya creado y se cancelarán todas las integraciones que usen ese bot.

• GET /Groups

  • GET <https: mem-invalid-attributes-holder=api.notion.com mem-invalid-attributes-holder=scim mem-invalid-attributes-holder=v2 mem-invalid-attributes-holder=groups>


  • Recupera una lista paginada de grupos del espacio de trabajo.

  • 
    Puedes usar los parámetros startIndex y count para la numeración. Ten en cuenta que el parámetro startIndex está indexado a 1 y el parámetro count tiene un máximo de 100, p. ej. GET <https: mem-invalid-attributes-holder=api.notion.com mem-invalid-attributes-holder=scim mem-invalid-attributes-holder=v2 groups?startindex="1&count=5">


    • Si no se utiliza paginación, se devolverá un máximo de 100 grupos de espacio de trabajo por solicitud.

  • 
    Puedes filtrar los resultados con el parámetro filter. Los grupos pueden filtrarse con el atributo displayName. P. ej. GET <https: mem-invalid-attributes-holder=api.notion.com mem-invalid-attributes-holder=scim mem-invalid-attributes-holder=v2 groups?filter="displayName">
eq Designers

• GET /Groups/<id>

  • GET <https: mem-invalid-attributes-holder=api.notion.com mem-invalid-attributes-holder=scim mem-invalid-attributes-holder=v2 mem-invalid-attributes-holder=groups/><id>

  • Recupera a un grupo específico del grupo del espacio de trabajo por su ID de grupo de Notion. El identificador es único y universal (UUID) y cuenta con 32 caracteres dispuestos de esta manera: 00000000-0000-0000-0000-000000000000.

• POST /Groups

  • POST <https: mem-invalid-attributes-holder=api.notion.com mem-invalid-attributes-holder=scim mem-invalid-attributes-holder=v2 mem-invalid-attributes-holder=groups>


  • Crea un nuevo grupo del espacio de trabajo.

• PATCH /Groups/<id>

  • PATCH <https: mem-invalid-attributes-holder=api.notion.com mem-invalid-attributes-holder=scim mem-invalid-attributes-holder=v2 mem-invalid-attributes-holder=groups/><id>

  • Actualiza un grupo del espacio de trabajo mediante una serie de operaciones.

• PUT /Groups/<id>

  • PUT <https: mem-invalid-attributes-holder=api.notion.com mem-invalid-attributes-holder=scim mem-invalid-attributes-holder=v2 mem-invalid-attributes-holder=groups/><id>

  • Actualiza un grupo del espacio de trabajo.

• DELETE /Groups/<id>

  • DELETE <https: mem-invalid-attributes-holder=api.notion.com mem-invalid-attributes-holder=scim mem-invalid-attributes-holder=v2 mem-invalid-attributes-holder=groups/><id>

  • Elimina un grupo del espacio de trabajo.