Skip to main content

SCIM API

The Elfsquad SCIM API enables you to retrieve, create, update and delete users within Elfsquad. As the name might give away, this API is a (partial) implementation of the SCIM 2.0 standard.

Open SCIM API Specifcation

Authentication

The SCIM API does not use our normal oauth authentication. Instead, each request should include the SCIM token in the Authorization header.

Creating the SCIM token

The SCIM token can be created in the EMS, by following the steps below.

1. Navigate to the integrations page, click on the plus button and select 'SCIM Provisioning'

Creating the SCIM token

2. Copy the token

3. Use this token in all API requests to the SCIM api

Mapping

Each field that exists on the Elfsquad user is mapped from a field on the SCIM user. For fields that do not exist on the SCIM user object, we've created extension properties.

Elfsquad PropertySCIM Property
UserNameuserName
SSOIdentifierexternalId
Culturelocale
CurrencyIsourn:ietf:params:scim:schemas:extension:elfsquad:2.0:User:currencyIso
LanguageIsourn:ietf:params:scim:schemas:extension:elfsquad:2.0:User:languageIso
CrmAccountIdurn:ietf:params:scim:schemas:extension:elfsquad:2.0:User:crmAccountId
CrmContactIdurn:ietf:params:scim:schemas:extension:elfsquad:2.0:User:crmContactId
IsAdminurn:ietf:params:scim:schemas:extension:elfsquad:2.0:User:isAdmin
OrganizationIdurn:ietf:params:scim:schemas:extension:elfsquad:2.0:User:organizationId