PingOne Platform APIs

SCIM Operations

The PingOne SCIM API supports retrieveing information regarding SCIM and the service itself. Specifically, you can retrieve:

SCIM2 Resource Types data model

Property Type Required? Mutable? Description

schemas

String[]

N/A

Read-only

Array of schema URNs used by the service for ResourceTypes.

totalResults

Integer

N/A

Read-only

Number of resource types returned.

Resources

Object[]

N/A

Read-only

Array of objects that describe each resource type.

Resources.schemas

String[]

N/A

Read-only

Array of schemas used by the resource type.

Resources.id

String

N/A

Read-only

Unique identifier of the resource type.

Resources.meta

Object

N/A

Read-only

This information is assembled by the PingOne SCIM API itself. All sub-attributes have a mutability of Read-only. This attribute should be ignored when it is provided by clients.

Resources.meta.resourceType

String

N/A

Read-only

The resource type of the resource type, which is always ResourceType for this request.

Resources.meta.location

String

N/A

Read-only

A URI indicating the path to the SCIM resource. This is generated by the PingOne SCIM API itself, and indicates the path to the resource from a SCIM client’s perspective.

Resources.name

String

N/A

Read-only

Name of the resource type.

Resources.description

String

N/A

Read-only

Description of the resource type.

Resources.endpoint

String

N/A

Read-only

The endpoint to reach the resource type. This is what appears in the URL after the scheme (protocol), domain, and /environment/{{environment identifier}}/v2.

Resources.schema

String[]

N/A

Read-only

URN of the schema of the resource type.

Resources.schemaExtensions

Object[]

N/A

Read-only

Any extension schemas used by the resource type.

Resources.schemaExtensions.schema

String

N/A

Read-only

URN of the extension schema.

Resources.schemaExtensions.required

Boolean

N/A

Read-only

Whether the extension schema is required for the resource type.

Schema data model

The response to Read SCIM2 Schemas is the definition, in JSON format, of the data models in SCIM Users and Direct-mapped Users.

Service Provider Configuration data model

Property Type Required? Mutable? Description

authenticationSchemes

Object[]

N/A

Read-only

Array that specifies supported authentication scheme properties.

authenticationSchemes.description

String

N/A

Read-only

A description of the authentication scheme.

authenticationSchemes.documentationUri

String

N/A

Read-only

An HTTP-addressable URL pointing to the authentication scheme’s usage documentation.

authenticationSchemes.name

String

N/A

Read-only

The common authentication scheme name.

authenticationSchemes.primary

Boolean

N/A

Read-only

Whether this scheme is the primary (preferred) authentication scheme.

authenticationSchemes.specUri

String

N/A

Read-only

An HTTP-addressable URL pointing to the authentication scheme’s specification.

authenticationSchemes.type

String

N/A

Read-only

The authentication type. Can be oauth, oauth2, oauthbearertoken, httpbasic, or httpdigest.

bulk.maxOperations

Integer

N/A

Read-only

Maximum number of bulk operations permitted in a request.

bulk.maxPayloadSize

Integer

N/A

Read-only

Maximum size of a request body for bulk operations.

bulk.supported

Boolean

N/A

Read-only

Whether bulk operations are supported.

changePassword.supported

Boolean

N/A

Read-only

Whether changing user passwords is supported.

etag.supported

Boolean

N/A

Read-only

Whether HTTP entity-tags are supported in the SCIM meta.version attribute.

filter.maxResults

Integer

N/A

Read-only

Maximum number of results returned by a request.

filter.supported

Boolean

N/A

Read-only

Whether filtering of results is supported.

meta

Object

N/A

Read-only

This information is assembled by the PingOne SCIM API itself. All sub-attributes have a mutability of Read-only. This attribute should be ignored when it is provided by clients.

meta.created

DateTime

N/A

Read-only

Date and time when the resource was created.

meta.lastModified

DateTime

N/A

Read-only

Date and time when the resource was last updated.

meta.location

String

N/A

Read-only

A URI indicating the path to the SCIM resource. This is generated by the PingOne SCIM API itself, and indicates the path to the resource from a SCIM client’s perspective.

meta.resourceType

String

N/A

Read-only

Type of the SCIM resource, which is always ServiceProviderConfig for this request.

meta.version

String

N/A

Read-only

Version of the SCIM resource.

patch.supported

Boolean

N/A

Read-only

Whether SCIM PATCH operations are supported.

schemas

String[]

N/A

Read-only

Array of schemas used by the service for ServiceProviderConfig.

sort

Boolean

N/A

Read-only

Whether sorting of results is supported.