SCIM 2.0

Introduction

The SCIM (System for Cross-domain Identity Management) API is a standardized protocol for managing user identity and access across different systems and domains. The SCIM API is based on RESTful principles and provides a simple, lightweight, and efficient way to manage user identity and access.

Authentication

The SCIM API supports API Key Authentication. More information can be found here: Authentication & Authorization

Mapping

Our SCIM API accepts Users, and supports the following values for mapping:

Name	Type	Usage
userName	string	Unique username
active	boolean
mail	string	Email address
givenName	string	First name
surname	string	Last name
userType	string	For resourcing (see below)

Resourcing

It is also possible to leverage the SCIM API for the management of people in the resource module. By defining the userType value in the User mapping it is possible to specifiy whether the user being presented is an active User with a login, or a Person record.

The following values are accepted for userType. If no value is provided the system will default to user.

Value	Usage
user	A full user who can login to PPM
resource	A person record for resourcing