文档

SCIM Client API

SCIM Client API

Unity Identity SCIM

SCIM 2.0 user provisioning API for SSO-enabled organizations.
Download OpenAPI specification:

List SCIM users

Lists the SCIM users provisioned for the given tenant organization. Supports the standard SCIM 2.0 query parameters (filter, sortBy, startIndex, count) per RFC 7644 §3.4.

Path parameters for "{title}"

organizationId

string
必填
Genesis ID of the organization

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://services.api.unity.com/scim/v2/tenants/{organizationId}/Users"

Response example

{}

Create a SCIM user

Provisions a new SCIM user in the given tenant organization. The request body is a SCIM 2.0 User resource per RFC 7643 §4.1.

Path parameters for "{title}"

organizationId

string
必填
Genesis ID of the organization

Request body for "{title}"

Media Type:
application/scim+json
Schema:
Opaque SCIM 2.0 resource. The gateway forwards the body verbatim to the SCIM service, which validates against RFC 7643/7644.
{}

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X POST \ -H "Content-Type: application/scim+json" \ -d '{}' \ "https://services.api.unity.com/scim/v2/tenants/{organizationId}/Users"

Response example

{}

Get a SCIM user

Returns the SCIM user with the given identifier from the tenant organization.

Path parameters for "{title}"

organizationId

string
必填
Genesis ID of the organization

id

string
必填
SCIM resource identifier.

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://services.api.unity.com/scim/v2/tenants/{organizationId}/Users/{id}"

Response example

{}

Replace a SCIM user

Replaces the entire SCIM user resource with the provided representation per RFC 7644 §3.5.1. Attributes omitted from the request are cleared.

Path parameters for "{title}"

organizationId

string
必填
Genesis ID of the organization

id

string
必填
SCIM resource identifier.

Request body for "{title}"

Media Type:
application/scim+json
Schema:
Opaque SCIM 2.0 resource. The gateway forwards the body verbatim to the SCIM service, which validates against RFC 7643/7644.
{}

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X PUT \ -H "Content-Type: application/scim+json" \ -d '{}' \ "https://services.api.unity.com/scim/v2/tenants/{organizationId}/Users/{id}"

Response example

{}

Patch a SCIM user

Applies a partial update to the SCIM user resource using the SCIM PatchOp envelope per RFC 7644 §3.5.2. Supports add, replace, and remove operations.

Path parameters for "{title}"

organizationId

string
必填
Genesis ID of the organization

id

string
必填
SCIM resource identifier.

Request body for "{title}"

Media Type:
application/scim+json
Schema:
SCIM 2.0 PatchOp envelope (RFC 7644 §3.5.2). Forwarded verbatim to the SCIM service for validation.
{}

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X PATCH \ -H "Content-Type: application/scim+json" \ -d '{}' \ "https://services.api.unity.com/scim/v2/tenants/{organizationId}/Users/{id}"

Response example

{}

Delete a SCIM user

Deprovisions the SCIM user from the tenant organization per RFC 7644 §3.6.

Path parameters for "{title}"

organizationId

string
必填
Genesis ID of the organization

id

string
必填
SCIM resource identifier.

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X DELETE \ "https://services.api.unity.com/scim/v2/tenants/{organizationId}/Users/{id}"

Response example

{ "schemas": [ "urn:ietf:params:scim:api:messages:2.0:Error" ], "status": "404", "scimType": "uniqueness", "detail": "Resource 5770009990009 not found."}

Get the SCIM service provider configuration

Returns the SCIM ServiceProviderConfig resource describing the SCIM features supported by Unity for the given tenant per RFC 7644 §4.

Path parameters for "{title}"

organizationId

string
必填
Genesis ID of the organization

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://services.api.unity.com/scim/v2/tenants/{organizationId}/ServiceProviderConfig"

Response example

{}

List SCIM resource types

Lists the SCIM resource types supported by Unity for the given tenant per RFC 7644 §4. Each entry describes a resource (User, Group, etc.) and its endpoint, schema, and supported extensions.

Path parameters for "{title}"

organizationId

string
必填
Genesis ID of the organization

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://services.api.unity.com/scim/v2/tenants/{organizationId}/ResourceTypes"

Response example

{}

Get a SCIM resource type

Returns metadata for a single SCIM resource type per RFC 7644 §4, including its endpoint, base schema, and supported extensions.

Path parameters for "{title}"

organizationId

string
必填
Genesis ID of the organization

id

string
必填
SCIM resource identifier.

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://services.api.unity.com/scim/v2/tenants/{organizationId}/ResourceTypes/{id}"

Response example

{}

List SCIM schemas

Lists the SCIM attribute schemas supported by Unity for the given tenant per RFC 7644 §4. Used by SCIM clients to discover the attributes available on each resource type.

Path parameters for "{title}"

organizationId

string
必填
Genesis ID of the organization

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://services.api.unity.com/scim/v2/tenants/{organizationId}/Schemas"

Response example

{}

Get a SCIM schema

Returns a single SCIM attribute schema by URI per RFC 7644 §4, including the attribute definitions used to validate the corresponding resource type.

Path parameters for "{title}"

organizationId

string
必填
Genesis ID of the organization

id

string
必填
SCIM schema URN per RFC 7643 §8 (e.g. 
urn:ietf:params:scim:schemas:core:2.0:User
). Distinct from 
scimResourceId
because schema ids are URNs containing RFC 3986 reserved characters (notably 
:
), which the gateway's default path-segment matcher does not accept.

HTTP response status codes for "{title}":

Code samples for "{title}":

Request example

curl -X GET \ "https://services.api.unity.com/scim/v2/tenants/{organizationId}/Schemas/{id}"

Response example

{}