/entityType.deleteAccessSchema

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. This action 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


POST

Base URL

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

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

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

Examples

Example Request

Deletes the write access schema for a client.


curl -H "Authorization: Basic aW1fYV...NfbXk=" \
    --data-urlencode type_name=user \
    --data-urlencode for_client_id=0987fghi0987fghi \
    --data-urlencode access_type=write \
    https://my-app.janraincapture.com/entityType.deleteAccessSchema
   

Running Code Samples Using Postman

The Janrain REST API code samples are written using Curl, but they can easily be run from within Postman. To use one of our code samples in Postman:

  1. Click the Copy to Clipboard button located directly beneath the code sample
  2. In Postman, click Import to display the Import dialog box.
  3. In the Import dialog box, click Paste Raw Text, and then paste in the copied code. The Import dialog box should look similar to this:

  4. Click Import, and the Curl command will be converted to a format that can be run from within Postman. All you need to do now is configure the command to work with your Janrain implementation.

Example Response


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

Authorized Clients

  • owner

Security

  •  janrain-signed
  •  basic-auth

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