Articles on: Digital Business Cards

User Provisioning with SCIM 2.0

The System for Cross-domain Identity Management (SCIM) specification is designed to make managing user identities in cloud-based applications and services easier. Its intent is to reduce the cost and complexity of user management operations by providing a common user schema and extension model, as well as binding documents to provide patterns for exchanging this schema using standard protocols.

Manage Team members in Spreadly


SCIM is used by Single Sign-On (SSO) services and identity providers to manage people across a variety of tools, including Spreadly. This SCIM implementation targets version 2.0 of the protocol.

Accessing the SCIM API


The SCIM methods are accessed over HTTP. The base URL for all calls to the SCIM API is https://spreadly.app/api/v1/scim. All SCIM methods are branches of this base URL.

Get a secret token


A Bearer token is required to access the SCIM endpoints. You can get your SCIM secret token from Team > Members.

User attributes


Attributes are the details associated with a user's account. You can view those user attributes when you open up the members list of your team. The following tables map SCIM attributes to the profile fields that Spreadly uses.


Spreadly User FieldSCIM attributeRequired
EmailuserName
First namename[givenName]
Last namename[familyName]
Import KeyexternalId
Phonephones[type eq "work"][value]
Mobilephones[type eq "mobile"][value]
Positiontitle
Departmenturn:ietf:params:scim:schemas:extension:enterprise:2.0:User[department]
Divisionurn:ietf:params:scim:schemas:extension:enterprise:2.0:User[division]
Organizationurn:ietf:params:scim:schemas:extension:enterprise:2.0:User[organization]
Streetaddresses[type eq "work"][streetAddress]
Cityaddresses[type eq "work"][locality]
Regionaddresses[type eq "work"][region]
Postal codeaddresses[type eq "work"][postalCode]
Countryaddresses[type eq "work"][country]
Languagelocale
Custom Field 1urn:ietf:params:scim:schemas:extension:spreadly:2.0:User:customField1
Custom Field 2urn:ietf:params:scim:schemas:extension:spreadly:2.0:User:customField2
Custom Field 3urn:ietf:params:scim:schemas:extension:spreadly:2.0:User:customField3
Custom Field 4urn:ietf:params:scim:schemas:extension:spreadly:2.0:User:customField4
Custom Field 5urn:ietf:params:scim:schemas:extension:spreadly:2.0:User:customField5
Custom Field 6urn:ietf:params:scim:schemas:extension:spreadly:2.0:User:customField6
Custom Field 7urn:ietf:params:scim:schemas:extension:spreadly:2.0:User:customField7
Custom Field 8urn:ietf:params:scim:schemas:extension:spreadly:2.0:User:customField8
Custom Field 9urn:ietf:params:scim:schemas:extension:spreadly:2.0:User:customField9
Custom Field 10urn:ietf:params:scim:schemas:extension:spreadly:2.0:User:customField10


Group Attributes



Spreadly Group FieldSCIM attributeRequired
NamedisplayName
Import KeyexternalId
Descriptionurn:ietf:params:scim:schemas:extension:spreadly:2.0:Group:description


Supported Providers


- User Provisioning with Entra-ID (Microsoft)

This is a non-complete list of supported providers. Feel free to contact us and send us your configuration guide for any other provider, missing in this list.

Updated on: 27/07/2024

Was this article helpful?

Share your feedback

Cancel

Thank you!