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

Errors

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 }'

201rolesCreateExample

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