Create custom role — LaunchDarkly

Create a new custom role

Request

This endpoint expects an object.

namestringRequired

A human-friendly name for the custom role

keystringRequired

The custom role key

policylist of objectsRequired

Resource statements for custom role

descriptionstringOptional

Description of custom role

basePermissionsstringOptional

Base permissions to use for this role. Only applicable to roles created prior to October 2024.

resourceCategorystringOptional

The category of resources this role is intended to manage. Can be organization, project, or any

Response

Custom role response

_idstring

The ID of the custom role

_linksmap from strings to objects

The location and content type of related resources

keystring

The key of the custom role

namestring

The name of the custom role

policylist of objects

An array of the policies that comprise this custom role

_accessobjectOptional

Details on the allowed and denied actions for this custom role

descriptionstringOptional

The description of the custom role

basePermissionsstringOptional

Base permissions to use for this role. Only applicable to roles created prior to October 2024.

resourceCategorystringOptional

The category of resources this role is intended to manage. Can be organization, project, or any. Once set, this field cannot be changed.

assignedToobjectOptional

The number of teams and members this role is assigned to

Errors

1 curl -X POST https://app.launchdarkly.com/api/v2/roles \ 2 -H "Authorization: <apiKey>" \ 3 -H "Content-Type: application/json" \ 4 -d '{ 5 "name": "Ops team", 6 "key": "role-key-123abc", 7 "policy": [ 8 { 9 "effect": "allow", 10 "resources": [ 11 "proj/*:env/production:flag/*" 12 ], 13 "actions": [ 14 "updateOn" 15 ] 16 } 17 ], 18 "description": "An example role for members of the ops team", 19 "basePermissions": "reader" 20 }'

1 { 2 "_id": "1234a56b7c89d012345e678f", 3 "_links": { 4 "key": { 5 "href": "href", 6 "type": "type" 7 } 8 }, 9 "key": "example-custom-role", 10 "name": "Example custom role", 11 "policy": [ 12 { 13 "effect": "allow", 14 "resources": [ 15 "proj/*:env/*;qa_*:/flag/*" 16 ], 17 "notResources": [ 18 "notResources" 19 ], 20 "actions": [ 21 "*" 22 ], 23 "notActions": [ 24 "notActions" 25 ] 26 } 27 ], 28 "_access": { 29 "denied": [ 30 { 31 "action": "action", 32 "reason": { 33 "effect": "allow" 34 } 35 } 36 ], 37 "allowed": [ 38 { 39 "action": "action", 40 "reason": { 41 "effect": "allow" 42 } 43 } 44 ] 45 }, 46 "description": "This custom role is just an example", 47 "basePermissions": "basePermissions", 48 "resourceCategory": "resourceCategory", 49 "assignedTo": { 50 "membersCount": 1, 51 "teamsCount": 1 52 } 53 }

1	curl -X POST https://app.launchdarkly.com/api/v2/roles \
2	-H "Authorization: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"name": "Ops team",
6	"key": "role-key-123abc",
7	"policy": [
8	{
9	"effect": "allow",
10	"resources": [
11	"proj/:env/production:flag/"
12	],
13	"actions": [
14	"updateOn"
15	]
16	}
17	],
18	"description": "An example role for members of the ops team",
19	"basePermissions": "reader"
20	}'

1	{
2	"_id": "1234a56b7c89d012345e678f",
3	"_links": {
4	"key": {
5	"href": "href",
6	"type": "type"
7	}
8	},
9	"key": "example-custom-role",
10	"name": "Example custom role",
11	"policy": [
12	{
13	"effect": "allow",
14	"resources": [
15	"proj/:env/;qa_:/flag/"
16	],
17	"notResources": [
18	"notResources"
19	],
20	"actions": [
21	"*"
22	],
23	"notActions": [
24	"notActions"
25	]
26	}
27	],
28	"_access": {
29	"denied": [
30	{
31	"action": "action",
32	"reason": {
33	"effect": "allow"
34	}
35	}
36	],
37	"allowed": [
38	{
39	"action": "action",
40	"reason": {
41	"effect": "allow"
42	}
43	}
44	]
45	},
46	"description": "This custom role is just an example",
47	"basePermissions": "basePermissions",
48	"resourceCategory": "resourceCategory",
49	"assignedTo": {
50	"membersCount": 1,
51	"teamsCount": 1
52	}
53	}