Create an access schema

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

Creates an access schema for the specified API client. An access schema defines the subset of attributes to which a client has read or write access. Each client can have one read access schema and one write access schema. 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.setAccessSchema \
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": 256,
7
        "case-sensitive": true,
8
        "constraints": [
9
          "unique"
10
        ],
11
        "name": "email",
12
        "type": "string"
13
      }
14
    ]
15
  },
16
  "stat": "ok",
17
  "notice": "reserved attributes (id, uuid, created, lastUpdated) are automatically included in the access schema"
18
}

200Successful response