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     "created_by": {
4       "type": "dev_user",
5       "display_picture": {
6         "file": {
7           "type": "type",
8           "name": "name"
9         },
10         "id": "id",
11         "display_id": "display_id"
12       },
13       "id": "id",
14       "state": "active",
15       "display_id": "display_id",
16       "display_name": "display_name",
17       "email": "email",
18       "full_name": "full_name"
19     },
20     "id": "id",
21     "modified_by": {
22       "type": "dev_user",
23       "display_picture": {
24         "file": {
25           "type": "type",
26           "name": "name"
27         },
28         "id": "id",
29         "display_id": "display_id"
30       },
31       "id": "id",
32       "state": "active",
33       "display_id": "display_id",
34       "display_name": "display_name",
35       "email": "email",
36       "full_name": "full_name"
37     },
38     "sync_metadata": {
39       "last_sync_in": {
40         "status": "failed",
41         "sync_unit": {
42           "external_system_type": "adaas",
43           "id": "id",
44           "sync_run": {
45             "mode": "initial",
46             "progress": {
47               "state": "completed"
48             }
49           },
50           "sync_type": "manual",
51           "display_id": "display_id",
52           "is_archived": true,
53           "name": "name"
54         },
55         "sync_date": "sync_date"
56       },
57       "last_sync_out": {
58         "status": "failed",
59         "sync_unit": {
60           "external_system_type": "adaas",
61           "id": "id",
62           "sync_run": {
63             "mode": "initial",
64             "progress": {
65               "state": "completed"
66             }
67           },
68           "sync_type": "manual",
69           "display_id": "display_id",
70           "is_archived": true,
71           "name": "name"
72         },
73         "sync_date": "sync_date"
74       },
75       "external_reference": "external_reference",
76       "origin_system": "origin_system"
77     },
78     "created_date": "created_date",
79     "display_id": "display_id",
80     "modified_date": "modified_date"
81   }
82 }

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	"created_by": {
4	"type": "dev_user",
5	"display_picture": {
6	"file": {
7	"type": "type",
8	"name": "name"
9	},
10	"id": "id",
11	"display_id": "display_id"
12	},
13	"id": "id",
14	"state": "active",
15	"display_id": "display_id",
16	"display_name": "display_name",
17	"email": "email",
18	"full_name": "full_name"
19	},
20	"id": "id",
21	"modified_by": {
22	"type": "dev_user",
23	"display_picture": {
24	"file": {
25	"type": "type",
26	"name": "name"
27	},
28	"id": "id",
29	"display_id": "display_id"
30	},
31	"id": "id",
32	"state": "active",
33	"display_id": "display_id",
34	"display_name": "display_name",
35	"email": "email",
36	"full_name": "full_name"
37	},
38	"sync_metadata": {
39	"last_sync_in": {
40	"status": "failed",
41	"sync_unit": {
42	"external_system_type": "adaas",
43	"id": "id",
44	"sync_run": {
45	"mode": "initial",
46	"progress": {
47	"state": "completed"
48	}
49	},
50	"sync_type": "manual",
51	"display_id": "display_id",
52	"is_archived": true,
53	"name": "name"
54	},
55	"sync_date": "sync_date"
56	},
57	"last_sync_out": {
58	"status": "failed",
59	"sync_unit": {
60	"external_system_type": "adaas",
61	"id": "id",
62	"sync_run": {
63	"mode": "initial",
64	"progress": {
65	"state": "completed"
66	}
67	},
68	"sync_type": "manual",
69	"display_id": "display_id",
70	"is_archived": true,
71	"name": "name"
72	},
73	"sync_date": "sync_date"
74	},
75	"external_reference": "external_reference",
76	"origin_system": "origin_system"
77	},
78	"created_date": "created_date",
79	"display_id": "display_id",
80	"modified_date": "modified_date"
81	}
82	}