Skip to navigation
OneIDScim

List all schemas of resources

View as Markdown

Lists all schemas for all supported resources. A schema is a collection of attribute definitions that describe the contents of an entire or partial resource, e.g., “urn:ietf:params:scim:schemas:core:2.0:User”.

The attribute definitions specify the name of the attribute, and metadata such as type (e.g., string, binary), cardinality (singular, multi, complex), mutability, and returnability.

Authentication

AuthorizationBearer

Use Bearer {{token}} in the Authorization header for authentication.

Headers

Idempotency-KeystringOptional
Unique key used to ensure idempotent behavior.
Accept-EncodingstringOptional

Indicates the response’s preferred content encoding. Supported values are gzip and identity.

Content-EncodingstringOptional

This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.

AuthorizationstringOptional

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Zuora-Track-IdstringOptional

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Entity-Ids-SinglestringOptional

Response headers

Content-EncodingstringOptional
RateLimit-LimitstringOptional
RateLimit-Remainingdouble
RateLimit-Resetdouble
Zuora-Request-IdstringOptional
Zuora-Track-IdstringOptional

Response

OK
schemaslist of stringsOptional
List of schema identifiers defining the structure of the response.
patchobjectOptional
Information about support for patch operations.
bulkobjectOptional
Information about support for bulk operations.
filterobjectOptional
Information about support for filtering.
changePasswordobjectOptional
Information about support for password change operations.
sortobjectOptional
Information about support for sorting.
etagobjectOptional
Information about support for ETag operations.
authenticationSchemeslist of objectsOptional
List of supported authentication schemes.
idstring or nullOptional
externalIdstring or nullOptional
metaobject or nullOptional
Metadata about the resource type.
totalResultsintegerOptional
Total number of user groups returned in the response.
resourceslist of objectsOptional
List of resource types available.