Delete an access schema

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 means that the API client regains access to the default attributes in an entity type. That might, or might not, be all the attributes in an entity type.

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.

❗️

Deleting an access schema can't 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 page for details on error codes.

API client permissions

The following table indicates the API clients that can and can't be used to call this operation:

Authentication

This operation supports both Basic authentication (recommended) and janrain-signed authentication. See Get started for more information.

Base URL

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

https://educationcenter.us-dev.janraincapture.com

Your Capture domain (also known as a Registration domain) can be found in Console on the Manage Application page.

Examples

Example request: Delete an access schema

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 \
  https://my-app.janraincapture.com/entityType.deleteAccessSchema

Example response

If your API call succeeds you'll get the following response:

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

Parameters

All parameters need to be configured as x-www-form-urlencoded body parameters.