RestApiCategories.platformAdministration.desc

platform_administration

2025.11

2025.12

The Identities API enables clients to retrieve information about existing identities (users or groups), and provides administrative functions to manage  those identities and create new instances.


Identities

Deletes all SCIM users. Optionally, deletes only inactive SCIM users and permanently removes them from the system.


Delete only inactive SCIM users for this request.


inActiveOnly

The SCIM error response schema as defined in RFC 7644 Section 3.12. Used for error responses across all SCIM endpoints.


scimError

The authenticated user does not have sufficient privileges.

Delete all SCIM users or inactive users

SCIM 2.0 PatchOp request for group per RFC 7644 Section 3.5.2.

groupInScimPatch

A physical mailing address for a SCIM User resource. Addresses are multi-valued and can  include types such as `work`, `home`, or `other`. Follows SCIM Core Schema as defined in RFC 7643.


scimAddress

Email address for a SCIM User resource. Email addresses are multi-valued and can include  types such as `work`, `home`, or `other`. Follows SCIM Core Schema as defined in RFC 7643.


scimEmailAddress

SCIM 2.0 Group resource per RFC 7643. Note that ID is only required for responses from the server, not for group creation requests.

scimGroup

SCIM 2.0 ListResponse for group resources.

scimGroupCollection

SCIM 2.0 Group resource for POST and PUT requests (group creation and updates). Note that id is server-generated and should not be included in requests.

scimGroupRequest

SCIM 2.0 ListResponse for paginated results per RFC 7644.

scimListResponse

Phone number for a SCIM User resource. Phone numbers are multi-valued and can include  types such as `work`, `home`, `mobile`, `fax`, `pager`, or `other`. Follows SCIM Core Schema as defined in RFC 7643.


scimPhoneNumber

SCIM 2.0 ResourceType per RFC 7643 Section 6.

scimResourceType

SCIM 2.0 Schema resource per RFC 7643 Section 7.

scimSchema

SCIM 2.0 Service Provider Configuration per RFC 7643 Section 5.

scimServiceProviderConfig

SCIM 2.0 User resource per RFC 7643. Note that ID is only required for responses from the server, not for user creation requests.

scimUser

SCIM 2.0 ListResponse for user resources.

scimUserCollection

SCIM 2.0 User resource for POST and PUT requests (user creation and updates).  Note that id is server-generated and should not be included in requests.


scimUserRequest

SCIM 2.0 PatchOp request for user per RFC 7644 Section 3.5.2.

Status	Meaning	Description
204	No Content	All SCIM users are deleted.
401	Unauthorized	Authentication is required.
403	Forbidden	The authenticated user does not have sufficient privileges.	Schema

Delete all SCIM users or inactive users

Request Samples

Response Samples

Query Parameters

Responses