The PingDirectory and PingDirectoryProxy SCIM 2.0 APIs are a set of REST interfaces based on the SCIM (System for Cross-domain Identity Management) 2.0 standard. With these APIs, you can:

• Create users.

• Search for users.

• Retrieve and update a user’s profile.

• Change a user’s password.

• Manage a user’s login sessions.

• Retrieve a user’s history of consent to data access.

• Manage second factor authentication settings.

With SCIM 2.0, any type of data is called a resource type. One or more schemas specify the attributes available for any given resource type. Resources are formatted as JSON and are requested using standard HTTP methods such as GET, POST, or PATCH. For more information about SCIM 2.0, see RFC 7642, RFC 7643, and RFC 7644.

To use these APIs, you must configure PingDirectory or PingDirectoryProxy for SCIM 2.0. You can set up PingDirectory as a stand-alone server. Whereas, you must set up PingDirectoryProxy with an external PingDirectory server.

For more information on configuring PingDirectory for SCIM 2.0, see Configuring SCIM 2.0 on Your Server. For more information on configuring PingDirectoryProxy for SCIM 2.0, see the PingDirectoryProxy Server Administration Guide.

These topics provide the following information about the PingDirectory and PingDirectoryProxy SCIM 2.0 APIs:

• Data types and resources: Data types and resource format specified by the SCIM 2.0 schema standard.

• Authorization: Authorization to access SCIM API resources.

• Authentication: Authentication requirement to access SCIM APIs.

• Requests and responses: SCIM API requests and responses.

• Errors: SCIM 2.0 errors.

• Service metadata endpoints: SCIM 2.0 service metadata endpoints.

• User profile endpoints: SCIM 2.0 user profile endpoints.