Articles on: Members

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 Field

SCIM attribute

Required

Email

userName

Academic Degree

name[honorificPrefix]

First name

name[givenName]

Last name

name[familyName]

Name Suffix

name[honorificSuffix]

Import Key

externalId

Phone

phones[type eq "work"][value]

Mobile

phones[type eq "mobile"][value]

Position

title

Department

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department

Division

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division

Organization

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:organization

Street

addresses[type eq "work"][streetAddress]

City

addresses[type eq "work"][locality]

Region

addresses[type eq "work"][region]

Postal code

addresses[type eq "work"][postalCode]

Country

addresses[type eq "work"][country]

Language

locale / preferredLanguage

Custom Field 1

spreadly:scim:User:customField1

Custom Field 2

spreadly:scim:User:customField2

Custom Field 3

spreadly:scim:User:customField3

Custom Field 4

spreadly:scim:User:customField4

Custom Field 5

spreadly:scim:User:customField5

Custom Field 6

spreadly:scim:User:customField6

Custom Field 7

spreadly:scim:User:customField7

Custom Field 8

spreadly:scim:User:customField8

Custom Field 9

spreadly:scim:User:customField9

Custom Field 10

spreadly:scim:User:customField10

Custom Field 11

spreadly:scim:User:customField11

Custom Field 12

spreadly:scim:User:customField12

Custom Field 13

spreadly:scim:User:customField13

Custom Field 14

spreadly:scim:User:customField14

Custom Field 15

spreadly:scim:User:customField15

Custom Field 16

spreadly:scim:User:customField16

Custom Field 17

spreadly:scim:User:customField17

Custom Field 18

spreadly:scim:User:customField18

Custom Field 19

spreadly:scim:User:customField19

Custom Field 20

spreadly:scim:User:customField20


Group Attributes


Spreadly Group Field

SCIM attribute

Required

Name

displayName

Import Key

externalId

Description

spreadly:scim:Group:description


Supported Providers


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/05/2025

Was this article helpful?

Share your feedback

Cancel

Thank you!