Your suggested change has been received. Thank you.

close

Suggest A Change

https://thales.na.market.dpondemand.io/docs/dpod/services/kmo….

Thales Logo

All

  • All
back

SCIM API

SCIM schemas

search

SCIM schemas

The OneWelcome Identity Platform includes SCIM schemas that define the attributes for your user resources:

  • The SCIM core schema defines the attributes for representing user resources.

  • The OneWelcome Identity Platform schema extensions extend the SCIM core schema and define additional attributes for user resources.

Custom schema extension

In addition to the SCIM core schema and the OneWelcome schema extension, you can create a custom schema extension that defines additional attributes for your user resources. The OneWelcome Identity Platform attribute metadata applies to any custom attributes that you add.

You can use your custom attributes as identifiers for users. For example, you might add attributes like customerNumber, subscriptionNumber, or licensePlate.

Your custom schema extension applies to all users in all tenants. The user operations (POST, PUT, PATCH, and GET) support the schema extension in compliance with the SCIM schema extension model. Validations are applied on the attribute or sub-attribute type.

When you create a custom schema, name the extension using your organization name, such as MyCompanyUserExtension.

You must create the custom schema extension before your instance of the OneWelcome Identity Platform goes into production. Changes to the schema that occur after users are created can cause user data to exist in the database that doesn't comply with the updated custom schema.

For details about the SCIM schema extension model, see SCIM: Core Schema 1.1 - Schema Extension Model section.

Schema structure

When creating a custom extension schema, follow the SCIM schema structure.

Both XML and JSON formats are defined. Resource and attribute names must conform to XML naming rules, which means that SCIM names must be valid XML names and should be camel-cased. When marshalling or extending SCIM resources in XML, use the normative SCIM XML schema (.xsd). SCIM resources represented in a schema-less format, such as JSON, must specify the schema with the schemas attribute.

Custom attributes

Follow these guidelines when defining custom attributes:

  • Attribute names cannot contain colons (:).

  • Sub-attributes can only be singular. Multi-valued sub-attributes are not supported.

  • Custom attributes can be simple or complex (having sub-attributes).

  • Custom attributes can be singular or multi-valued.

  • Custom attributes and sub-attributes can have any of the attribute types.

On this page