Endpoint URL: {registrationDomain} /entityType.getAccessSchema
Description
Retrieves the 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.
Respects the API Client Allow List: Yes
API Client Permissions
The following table indicates the API clients that can (and the API clients that can't) be used to call this endpoint:
owner | access_issuer | direct_access | direct_read_access | login_client |
Yes | Yes | Yes | Yes | Yes |
Authentication
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:
https://educationcenter.us-
Your Capture domains (also known as Registration domains) can be found in the 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
Running this command in Postman
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
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 returned. |
access_type | string | Yes | Type of access schema. Allowed values are:
|