Deletes the specified access schema for a client. Access schemas define the subset of attributes that a client has read or write access to. Deleting an access schema will grant a client read or write access to all attributes again. 

Note that access schemas only apply to API-based implementations of the Identity Cloud. If you are using a JavaScript SDK-based implementation then access to forms ands fields is managed by the flow.

Note. Deleting an access schema cannot be undone. Before deleting an access schema we recommend saving a backup of the current access schema using the entityType.getAccessSchema API.

Refer to the Registration Error Codes section for details on error codes.

This endpoint includes the following methods:

  • POST



This endpoint supports both Basic authentication (recommended) and janrain-signed authentication.

How to Create an Authentication String

Base URL

The base URL for this endpoint is your Capture domain; for example:


Your Capture domains (also known as Registration domains) can be found in the Console on the Manage Application page:


Example Request

This command deletes the write access schema assigned to the API client 0987fghi0987fghi.

curl -G\
  -H "Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg" \
  --data-urlencode type_name=user \
  --data-urlencode for_client_id=0987fghi0987fghi \
  --data-urlencode access_type=write \
      Running this command in Postman

Example Response

  "result": "access schema was deleted.",
  "stat": "ok"

Authorized Clients

  • owner

Query Parameters

Parameter Type Required Description
type_name string Yes Name of the entityType.
for_client_id string Yes Client ID of the client whose access schema is being deleted.
access_type string Yes Type of access schema to be deleted. Allowed values are:
  • read
  • write
  • read_with_token
  • write_with_token