Get custom role

1 curl https://app.launchdarkly.com/api/v2/roles/customRoleKey \ 2 -H "Authorization: <apiKey>"

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 "_presetBundleVersion": 1, 54 "_presetStatements": [ 55 { 56 "effect": "allow", 57 "resources": [ 58 "proj/*:env/*;qa_*:/flag/*" 59 ], 60 "notResources": [ 61 "notResources" 62 ], 63 "actions": [ 64 "*" 65 ], 66 "notActions": [ 67 "notActions" 68 ] 69 } 70 ] 71 }

Get a single custom role by key or ID

Path parameters

customRoleKeystringRequired

The custom role key or ID

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

_accessobject or null

Details on the allowed and denied actions for this custom role

descriptionstring or null

The description of the custom role

basePermissionsstring or null

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

resourceCategorystring or null

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

assignedToobject or null

The number of teams and members this role is assigned to

_presetBundleVersioninteger or null

If created from a preset, the preset bundle version

_presetStatementslist of objects or null

If created from a preset, the read-only statements copied from the preset

Path parameters

Headers

Response

Errors