Update custom role

For the complete documentation index, see llms.txt. For the full documentation snapshot, see llms-full.txt.

Update a single custom role. Uses a JSON patch or JSON merge patch representation of the desired changes.

To add an element to the policy array, set the path to /policy and then append /<array index>. Use /0 to add to the beginning of the array. Use /- to add to the end of the array.

PATCH /api/v2/roles/{customRoleKey}

Update custom role

cURL

curl --request PATCH \
  --url https://app.launchdarkly.com/api/v2/roles/{customRoleKey} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "patch": [
    {
      "op": "add",
      "path": "/policy/0",
      "value": {
        "actions": [
          "updateOn"
        ],
        "effect": "allow",
        "resources": [
          "proj/*:env/qa:flag/*"
        ]
      }
    }
  ]
}
'

200

{
  "_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": 123,
    "teamsCount": 123
  },
  "_presetBundleVersion": 123,
  "_presetStatements": [
    {
      "effect": "allow",
      "resources": [
        "proj/*:env/*;qa_*:/flag/*"
      ],
      "notResources": [
        "<string>"
      ],
      "actions": [
        "*"
      ],
      "notActions": [
        "<string>"
      ]
    }
  ]
}

Authorizations

Authorization · string · header · required

Path Parameters

customRoleKey · string<string> · required

The custom role key

Body

application/json

patch · object[] · required

A JSON patch representation of the change to make

Show child attributes

comment · string

Optional comment

Response

200

application/json

Custom role response

_id · string · required

The ID of the custom role

Example:

"1234a56b7c89d012345e678f"

_links · object · required

The location and content type of related resources

Show child attributes

key · string · required

The key of the custom role

Example:

"example-custom-role"

name · string · required

The name of the custom role

Example:

"Example custom role"

policy · object[] · required

An array of the policies that comprise this custom role

Show child attributes

_access · object

Details on the allowed and denied actions for this custom role

Show child attributes

description · string

The description of the custom role

Example:

"This custom role is just an example"

basePermissions · string

Base permissions to use for this role. Defaults to no_access (older roles defaulted to reader). Recommended to set this to no_access in all cases.

Example:

"reader"

resourceCategory · string

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

assignedTo · object

The number of teams and members this role is assigned to

Show child attributes

_presetBundleVersion · integer

If created from a preset, the preset bundle version

_presetStatements · object[]

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

Show child attributes