SCIM v2 Provisioning Overview

Declaree supports SCIM v2 (System for Cross-domain Identity Management) for provisioning users and groups. This page provides an overview of the available endpoints and example requests.

📘 Official SCIM protocol specification: RFC 7644

Service Configuration

Retrieve the SCIM configuration for your Declaree environment:
GET /SCIM/v2/ServiceProviderConfig

Resource Types and Schemas

List available resource types (with schema links):

GET /SCIM/v2/ResourceTypes

Request (individual) resource type schemas:

GET /SCIM/v2/Schemas

Request schema for resource type user:

GET /SCIM/v2/ResourceTypes/urn:ietf:params:scim:schemas:core:2.0:User

Retrieve a user by externalId "ABC123":

GET /SCIM/v2/Users?filter=externalId+eq+%22ABC123%22

Add a new user (example with managerId linked to externalId):
POST /SCIM/v2/Users

CODE

{
	"schemas": ["urn:scim:schemas:core:1.0", "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"],
	"userName": "scim_test",
	"externalId": "scim0001",
	"name": {
		"familyName": "Jones",
		"givenName": "Taylor"
	},
	"emails": [
		{
			"value": "jones@scim.com",
			"type": "work",
			"primary": true
		}
	],
	"locale": "en_US",
	"active":true,
	"password":"t1meMa$heen",
	"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
		"employeeNumber":   "701984",
		"costCenter":       "4130",
		"organization":     "Universal Studios",
		"division":         "Theme Park",
		"department":       "1000",
		"manager": {
			"managerId":    "U0XE15NHQ",
			"displayName":  "Mary Johnes"
		}
	}
}

Partially edit a user (deactivate, update name and email):
PATCH/SCIM/v2/Users/6639add5-fa72-460b-afbd-a681bc6b579e

CODE

{
	"schemas":["urn:ietf:params:scim:api:messages:2.0:PatchOp"],
	"Operations":[
		{
			"op":"replace",
			"path":"active",
			"value": "false"
		},{
			"op":"replace",
			"path":"familyName",
			"value": "Janes"
		},{
			"op":"replace",
			"path":"emails[email.type eq 'work']",
			"value": "jack@scim.com"
		}
	]
}

Update full user profile:
PUT /SCIM/v2/Users

CODE

{
	"schemas": [
		"urn:scim:schemas:core:1.0"
	],
	"userName": "scim_test",
	"externalId": "scim0001",
	"name": {
		"familyName": "Janes"
	},
	"active":false,
	"emails": [
		{
			"value": "jack@scim.com",
			"type": "work",
			"primary": true
		}
	]
}

Delete a user:
DELETE /SCIM/v2/Users/31c926dc-ae32-4df0-9b8f-f461a43586cc

Retrieve a group by name without listing members:
GET /SCIM/v2/Groups?excludedAttributes=members&filter=displayName+eq+%22Sales%22