List custom roles

1 import requests 2 3 url = "https://app.launchdarkly.com/api/v2/roles" 4 5 headers = {"Authorization": "<apiKey>"} 6 7 response = requests.get(url, headers=headers) 8 9 print(response.json())

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

Get a complete list of custom roles. Custom roles let you create flexible policies providing fine-grained access control to everything in LaunchDarkly, from feature flags to goals, environments, and teams. With custom roles, it’s possible to enforce access policies that meet your exact workflow needs. Custom roles are available to customers on our enterprise plans. If you’re interested in learning more about our enterprise plans, contact sales@launchdarkly.com.

Query parameters

limitlongOptional

The maximum number of custom roles to return. Defaults to 20.

offsetlongOptional

Where to start in the list. Defaults to 0. Use this with pagination. For example, an offset of 10 skips the first ten items and then returns the next items in the list, up to the query limit.

Response

Custom roles collection response

itemslist of objects

An array of custom roles

_linksmap from strings to objectsOptional

The location and content type of related resources

totalCountintegerOptional

The total number of custom roles

Headers

Query parameters

Response

Errors