Get an access schema

post https://{hostname}/entityType.getAccessSchema

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 of Identity Cloud then access to forms and fields is managed by the flow rather than by an access schema.

Response

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://hostname/entityType.getAccessSchema \
# Add Authorization header to this snippet
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/x-www-form-urlencoded'


xxxxxxxxxx
18
 
1
{
2
  "schema": {
3
    "name": "user",
4
    "attr_defs": [
5
      {
6
        "length": 1000,
7
        "case-sensitive": true,
8
        "name": "displayName",
9
        "features": [
10
          "query"
11
        ],
12
        "type": "string",
13
        "description": "The name of this Contact, suitable for display to end-users."
14
      }
15
    ]
16
  },
17
  "stat": "ok"
18
}

200Successful response