Deprecated - Create a custom schema attribute to extend the SCIM API model for managing user accounts.

Deprecated - This API is deprecated and will be removed after May 2022. Use this API: POST /v1.0/attributes

You can create up to 150 custom schema attributes. The schema attribute names are predefined and named customAttribute1 through customAttribute150. To find an available custom schema attribute name, use the API "GET /Schema/attributes?filter=customAvailable". Pick an available custom schema attribute name from the list of returned attributes and then create a new schema attribute by using this API, which will map it to a SCIM name and extend the SCIM API model for managing user accounts.

You can also create up to 10 hashed custom schema attributes. The schema attribute names are predefined and named hashedCustomAttribute1 through hashedCustomAttribute10. To find an available hashed custom schema attribute name, use the API "GET /Schema/attributes?filter=hashedCustomAvailable". A hashed custom attribute supports a single value that is stored as a one-way hash to prevent clear data from being accessed.

Entitlement required: manageUserGroups (Manage users and groups) or manageAllUserGroups (Synchronize users and groups) or manageUserStandardGroups (Manage users and standard groups).
Note: You only need one entitlement, but you can have more than one.

🚧

Suggestion: Use the new Attributes API

While the schema attributes API is supported, it is not the preferred method of managing user attributes in Verify. We suggest using the (Attributes API)[https://docs.verify.ibm.com/verify/reference/attributes#createattribute_0] which encompasses user schema attributes, rules & functions, fixed values, and identity source attributes.

Body Params

Custom schema attribute payload.

schemas
array of strings
required

An array of strings that contains the URIs that indicate the namespaces of the SCIM schemas that define the attributes present in the
current JSON structure.
The schema URI must be "urn:ietf:params:scim:schemas:ibm:core:2.0:SchemaAttribute" as required by the SCIM specification.

schemas*
string
required

The schema attribute name.

string
required

The description for the schema attribute.

string
required

The display name for a custom attribute. Its used to show the attribute name in the email that is sent to the end user when the attribute value changes.

string
required

The data type for the schema attribute. For a custom attribute the allowed type is "string".

string
required

The unqualified SCIM name that is associated with the schema attribute. For a custom attribute, the SCIM name must be unique and use the alphanumeric character set.

string

The attribute name that is associated with the attribute source. The attribute name must be unique and use the alphanumeric character set and underscore. The attribute name defaults to the SCIM name if not specified.

boolean

A flag to indicate this schema attribute supports multiple values. Defaults to false. The flag is set to false for hashed custom attributes which support a single value.

boolean

A flag to indicate this schema attribute is read only. Defaults to false. Any value that is specified for a user in a read only attribute is ignored, except for custom attributes where it can be set on a POST. Values specified in a PUT or PATCH request payload for read only attributes are ignored.

Responses

Language
URL
Choose an example:
application/scim+json