Create Role

POST

Creates a new role.

Request

This endpoint expects an object.

targetenumRequired

Target object type of the role.

descriptionstringOptionalformat: "text"

The description of the role.

include_all_subtypesbooleanOptional

Whether to include all subtypes of the leaf type as target of the role.

namestringOptionalformat: "text"

The name of the role.

privilegeslist of enumsOptional

Allowed values: createdeleteexecutereadupdate

The privileges the role provides on target.

target_subtypestringOptionalformat: "text"

The subtype of the target.

Response

A response to a request to create a new role.

roleobject

POST

1 curl -X POST https://api.devrev.ai/roles.create \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "target": "article"
6 }'

201Created

1 {
2   "role": {
3     "id": "id",
4     "created_by": {
5       "type": "dev_user",
6       "id": "id",
7       "display_id": "display_id",
8       "display_name": "display_name",
9       "display_picture": {
10         "id": "id",
11         "display_id": "display_id",
12         "file": {}
13       },
14       "email": "email",
15       "full_name": "full_name",
16       "state": "active"
17     },
18     "created_date": "created_date",
19     "display_id": "display_id",
20     "modified_by": {
21       "type": "dev_user",
22       "id": "id",
23       "display_id": "display_id",
24       "display_name": "display_name",
25       "display_picture": {
26         "id": "id",
27         "display_id": "display_id",
28         "file": {}
29       },
30       "email": "email",
31       "full_name": "full_name",
32       "state": "active"
33     },
34     "modified_date": "modified_date",
35     "sync_metadata": {
36       "external_reference": "external_reference",
37       "last_sync_in": {
38         "status": "failed",
39         "sync_date": "sync_date",
40         "sync_unit": {
41           "id": "id",
42           "display_id": "display_id",
43           "external_system_type": "adaas",
44           "is_archived": true,
45           "name": "name",
46           "sync_run": {},
47           "sync_type": "manual"
48         }
49       },
50       "last_sync_out": {
51         "status": "failed",
52         "sync_date": "sync_date",
53         "sync_unit": {
54           "id": "id",
55           "display_id": "display_id",
56           "external_system_type": "adaas",
57           "is_archived": true,
58           "name": "name",
59           "sync_run": {},
60           "sync_type": "manual"
61         }
62       },
63       "origin_system": "origin_system"
64     }
65   }
66 }

Core Search

Up Next

Built with

1	curl -X POST https://api.devrev.ai/roles.create \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"target": "article"
6	}'

1	{
2	"role": {
3	"id": "id",
4	"created_by": {
5	"type": "dev_user",
6	"id": "id",
7	"display_id": "display_id",
8	"display_name": "display_name",
9	"display_picture": {
10	"id": "id",
11	"display_id": "display_id",
12	"file": {}
13	},
14	"email": "email",
15	"full_name": "full_name",
16	"state": "active"
17	},
18	"created_date": "created_date",
19	"display_id": "display_id",
20	"modified_by": {
21	"type": "dev_user",
22	"id": "id",
23	"display_id": "display_id",
24	"display_name": "display_name",
25	"display_picture": {
26	"id": "id",
27	"display_id": "display_id",
28	"file": {}
29	},
30	"email": "email",
31	"full_name": "full_name",
32	"state": "active"
33	},
34	"modified_date": "modified_date",
35	"sync_metadata": {
36	"external_reference": "external_reference",
37	"last_sync_in": {
38	"status": "failed",
39	"sync_date": "sync_date",
40	"sync_unit": {
41	"id": "id",
42	"display_id": "display_id",
43	"external_system_type": "adaas",
44	"is_archived": true,
45	"name": "name",
46	"sync_run": {},
47	"sync_type": "manual"
48	}
49	},
50	"last_sync_out": {
51	"status": "failed",
52	"sync_date": "sync_date",
53	"sync_unit": {
54	"id": "id",
55	"display_id": "display_id",
56	"external_system_type": "adaas",
57	"is_archived": true,
58	"name": "name",
59	"sync_run": {},
60	"sync_type": "manual"
61	}
62	},
63	"origin_system": "origin_system"
64	}
65	}
66	}