User Management
      Back to home
      1. snapADDY Knowledge Base
      2. Global Settings
      3. User Management

      Configure SCIM User Provisioning

      Learn how to configure SCIM for automatic user provisioning from your identity provider to snapADDY

      This article explains how to configure a SCIM client for snapADDY. By following these steps, you can streamline user provisioning and management in one centralized location.

      If you're using Microsoft Entra ID, please refer to a separate article here:

      👉 Configuring SCIM User Provisioning With Azure Active Directory / Entra ID

      Prerequisites 

      • You have an SCIM API key configured in the User provisioning section of your organization.
      • You have the permissions to configure user provisioning in your identity provider.

      We recommend to use SCIM along with either SAML or OpenID-Connect Single-SignOn and to disable login via username and password in the Login & Security section of your organization. Make sure to also disable the snapADDY invitation email for your users under Invitation & Onboarding. This way users will not be asked to configure a password for their account.

      Configure User Provisioning

      1. Create a SCIM API key in the administration settings of your organization under User provisioning
      2. Use this endpoint for the SCIM integration: https://backend.snapaddy.com/auth/v1/scim
      3. Configure the SCIM field mapping in your identity provider as follows:
      snapADDY property SCIM attribute
      city addresses[type eq "work"][locality]
      country addresses[type eq "work"][country]
      email ✨ userName
      external_id externalId
      fax phoneNumbers[type eq "fax"][value]
      firstName name[givenName]
      lastName name[familyName]
      locale

      locale

      Supported: (de, en, es, it, fr)
      mobile phoneNumbers[type eq "mobile"][value]
      organization urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:organization
      phone phoneNumbers[type eq "work"][value]
      position title
      state addresses[type eq "work"][region]
      street addresses[type eq "work"][streetAddress]
      zip addresses[type eq "work"][postalCode]

      Note: The email field is the primary identifier for mapping users and must be unique across all provisioned users.

      Configure Group Provisioning

      The following steps are required only if you plan to provision licenses or business card templates via SCIM.

      1. Configure the SCIM field mapping in your identity provider as follows:

      snapADDY property SCIM attribute
      externalId yourEntityId (optional)
      displayName displayName
      members members