Deprecated - Retrieve the list of a schema attributes in Cloud Directory for a tenant.

get deprecatedhttps://{tenanturl}/v2.0/Schema/attributes

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

The filter query parameter supports the options:

"default" - the filter will show the default schema attributes.

"custom" - the filter will show the custom defined schema attributes.

"customAvailable" - the filter will show the custom schema attribute names that are available for use.

"hashedCustomAvailable" - the filter will show the hashed custom schema attribute names that are available for use.

No filter will show all the schema attributes.

You can further narrow your search using the query parameter "fullText".
Supports sorting and paging on the results.

Entitlement required: readUserGroups (Read users and groups) or 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.

Responses

Response body

object

schemas

array of strings

required

An array of Strings containing URIs that are used to indicate the
namespaces of the SCIM schemas that define the attributes present in the
current JSON structure.
The schema "urn:ietf:params:scim:schemas:ibm:core:2.0:SchemaAttributeListResponse" is returned in the response.

schemas*

totalResults

int32

required

Total number of schema attributes found matching the specified search criteria for the specified tenant.

startIndex

int32

The 1-based index of the first result in the current set of list results.

itemsPerPage

int32

The number of resources returned in a list response page.

Resources

array of objects

List of schema attributes

Resources

object

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

The description for the schema attribute.

displayName

string

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

The data type for the schema attribute.

string boolean integer DN

scimName

string

The SCIM name that is associated with the schema attribute.

attributeName

string

The attribute name that is associated with the attribute source.

multiValue

boolean

A flag to indicate this schema attribute supports multiple values.

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.

customAttribute

boolean

A flag that indicates whether this is a custom attribute.

hashedAttribute

boolean

A flag that indicates whether this is a hashed custom attribute.

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://tenant_url/v2.0/Schema/attributes \
3
     --header 'accept: application/scim+json'

Choose an example:

application/scim+json

200The request has succeeded.

400The request is invalid.

500An internal server error occurred.