List custom roles | LaunchDarkly

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

{
  "items": [
    {
      "_id": "1234a56b7c89d012345e678f",
      "_links": {},
      "key": "example-custom-role",
      "name": "Example custom role",
      "policy": [
        {
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "notResources": [
            "string"
          ],
          "actions": [
            "*"
          ],
          "notActions": [
            "string"
          ]
        }
      ],
      "_access": {
        "denied": [
          {
            "action": "string",
            "reason": {
              "effect": "allow",
              "resources": [
                "proj/*:env/*;qa_*:/flag/*"
              ],
              "notResources": [
                "string"
              ],
              "actions": [
                "*"
              ],
              "notActions": [
                "string"
              ],
              "role_name": "string"
            }
          }
        ],
        "allowed": [
          {
            "action": "string",
            "reason": {
              "effect": "allow",
              "resources": [
                "proj/*:env/*;qa_*:/flag/*"
              ],
              "notResources": [
                "string"
              ],
              "actions": [
                "*"
              ],
              "notActions": [
                "string"
              ],
              "role_name": "string"
            }
          }
        ]
      },
      "description": "This custom role is just an example",
      "basePermissions": "reader",
      "resourceCategory": "string",
      "assignedTo": {
        "membersCount": 1,
        "teamsCount": 1
      },
      "_presetBundleVersion": 1,
      "_presetStatements": [
        {
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "notResources": [
            "string"
          ],
          "actions": [
            "*"
          ],
          "notActions": [
            "string"
          ]
        }
      ]
    }
  ],
  "_links": {},
  "totalCount": 1
}

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

{
  "items": [
    {
      "_id": "1234a56b7c89d012345e678f",
      "_links": {},
      "key": "example-custom-role",
      "name": "Example custom role",
      "policy": [
        {
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "notResources": [
            "string"
          ],
          "actions": [
            "*"
          ],
          "notActions": [
            "string"
          ]
        }
      ],
      "_access": {
        "denied": [
          {
            "action": "string",
            "reason": {
              "effect": "allow",
              "resources": [
                "proj/*:env/*;qa_*:/flag/*"
              ],
              "notResources": [
                "string"
              ],
              "actions": [
                "*"
              ],
              "notActions": [
                "string"
              ],
              "role_name": "string"
            }
          }
        ],
        "allowed": [
          {
            "action": "string",
            "reason": {
              "effect": "allow",
              "resources": [
                "proj/*:env/*;qa_*:/flag/*"
              ],
              "notResources": [
                "string"
              ],
              "actions": [
                "*"
              ],
              "notActions": [
                "string"
              ],
              "role_name": "string"
            }
          }
        ]
      },
      "description": "This custom role is just an example",
      "basePermissions": "reader",
      "resourceCategory": "string",
      "assignedTo": {
        "membersCount": 1,
        "teamsCount": 1
      },
      "_presetBundleVersion": 1,
      "_presetStatements": [
        {
          "effect": "allow",
          "resources": [
            "proj/*:env/*;qa_*:/flag/*"
          ],
          "notResources": [
            "string"
          ],
          "actions": [
            "*"
          ],
          "notActions": [
            "string"
          ]
        }
      ]
    }
  ],
  "_links": {},
  "totalCount": 1
}

Get a complete list of custom roles. This includes project and organization roles that you create, or that are provided as presets by LaunchDarkly. It does not include base roles.

Authentication

Authorizationstring

API Key authentication via header

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 objects

The location and content type of related resources

totalCountinteger

The total number of custom roles

Errors

401

Unauthorized Error

403

Forbidden Error

429

Too Many Requests Error

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

1	{
2	"items": [
3	{
4	"_id": "1234a56b7c89d012345e678f",
5	"_links": {},
6	"key": "example-custom-role",
7	"name": "Example custom role",
8	"policy": [
9	{
10	"effect": "allow",
11	"resources": [
12	"proj/:env/;qa_:/flag/"
13	],
14	"notResources": [
15	"string"
16	],
17	"actions": [
18	"*"
19	],
20	"notActions": [
21	"string"
22	]
23	}
24	],
25	"_access": {
26	"denied": [
27	{
28	"action": "string",
29	"reason": {
30	"effect": "allow",
31	"resources": [
32	"proj/:env/;qa_:/flag/"
33	],
34	"notResources": [
35	"string"
36	],
37	"actions": [
38	"*"
39	],
40	"notActions": [
41	"string"
42	],
43	"role_name": "string"
44	}
45	}
46	],
47	"allowed": [
48	{
49	"action": "string",
50	"reason": {
51	"effect": "allow",
52	"resources": [
53	"proj/:env/;qa_:/flag/"
54	],
55	"notResources": [
56	"string"
57	],
58	"actions": [
59	"*"
60	],
61	"notActions": [
62	"string"
63	],
64	"role_name": "string"
65	}
66	}
67	]
68	},
69	"description": "This custom role is just an example",
70	"basePermissions": "reader",
71	"resourceCategory": "string",
72	"assignedTo": {
73	"membersCount": 1,
74	"teamsCount": 1
75	},
76	"_presetBundleVersion": 1,
77	"_presetStatements": [
78	{
79	"effect": "allow",
80	"resources": [
81	"proj/:env/;qa_:/flag/"
82	],
83	"notResources": [
84	"string"
85	],
86	"actions": [
87	"*"
88	],
89	"notActions": [
90	"string"
91	]
92	}
93	]
94	}
95	],
96	"_links": {},
97	"totalCount": 1
98	}