Deprecated - Modify a custom schema attribute for the specified tenant in Cloud Directory

put deprecatedhttps://{tenanturl}/v2.0/Schema/attributes/{name}

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

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.

Path Params

name

string

required

The name of the custom schema attribute to modify.

Body Params

Custom 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*

name

string

required

The schema attribute name.

description

string

required

The description for the schema attribute.

displayName

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.

type

string

required

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

scimName

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.

attributeName

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.

multiValue

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.

readOnly

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


xxxxxxxxxx
10
1
curl --request PUT \
2
     --url https://tenant_url/v2.0/Schema/attributes/customAttribute1 \
3
     --header 'accept: application/scim+json' \
4
     --header 'content-type: application/scim+json' \
5
     --data '
6
{
7
  "name": "customAttribute1",
8
  "type": "string"
9
}
10
'

Choose an example:

application/scim+json

200The request has succeeded.

400The request is invalid.

403The request is forbidden.

404The request does not exist.

409A conflict exists.

500An internal server error occurred.