Get an access schema

Suggest Edits

Retrieves the specified access schema for the specified API client. An access schema defines the subset of attributes to which a client has read or write access. 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.

API client permissions

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

owner	access_issuer	direct_access	direct_access_read	login_client
✓	✓	✓	✓	✓

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

This command returns the write access schema associated with the API client 0987fghi0987fghi.

curl -X POST \
  -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.getAccessSchema

Example response

{
  "schema": {
    "attr_defs": [
      {
        "name": "id",
        "description": "simple identifier for this entity",
        "type": "id"
      },
      {
        "name": "uuid",
        "description": "globally unique idetifier for this entity",
        "type": "uuid"
      },
      {
        "name": "created",
        "description": "when this entity was created",
        "type": "dateTime"
      },
      {
        "name": "lastUpdated",
        "description": "when this entity was last updated",
        "type": "dateTime"
      },
      {
        "case-sensitive": false,
        "name": "Description",
        "length": 1000,
        "type": "string"
      },
      {
        "case-sensitive": false,
        "name": "Name",
        "constraints": [
          "alphanumeric"
        ],
        "length": null,
        "type": "string"
      }
    ],
    "name": "user"
  },
  "stat": "ok"
}

Query parameters

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

Parameter	Type	Required	Description
type_name	string	✓	Name of the entity type associated with the API client whose access schema you're returning.
for_client_id	string	✓	Unique identifier of the API client whose access schema you're returning.
access_type	string	✓	Type of access schema. Allowed values are: • read • write • read_with_token •write_with_token

Updated almost 2 years ago