Update

Update a project role

PATCH /api/v2/workspace/{projectId}/roles/{roleId}

cURL

cURL

curl --request PATCH \
  --url https://us.infisical.com/api/v2/workspace/{projectId}/roles/{roleId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "<string>",
  "name": "<string>",
  "description": "<string>",
  "permissions": [
    {
      "inverted": true,
      "conditions": {
        "environment": "<string>",
        "secretPath": "<string>",
        "secretName": "<string>",
        "secretTags": {
          "$in": [
            "<string>"
          ],
          "$all": [
            "<string>"
          ]
        },
        "eventType": "<string>"
      }
    }
  ]
}
'

200

{
  "role": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "slug": "<string>",
    "permissions": [
      {
        "action": "<string>",
        "subject": "<string>",
        "conditions": "<unknown>",
        "inverted": true
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "projectId": "<string>",
    "description": "<string>"
  }
}

Authorizations

Authorization · string · header · required

An access token in Infisical

Path Parameters

projectId · string · required

The ID of the project to update the role for.

roleId · string · required

The ID of the role to update

Body

application/json

slug · string

The slug of the role.

Required string length: 1 - 64

name · string

The name of the role.

description · string | null

The description for the role.

permissions · object[]

The permissions assigned to the role.

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

Option 9

Option 10

Option 11

Option 12

Option 13

Option 14

Option 15

Option 16

Option 17

Option 18

Option 19

Option 20

Option 21

Option 22

Option 23

Option 24

Option 25

Option 26

Option 27

Option 28

Option 29

Option 30

Option 31

Option 32

Option 33

Option 34

Option 35

Option 36

Option 37

Option 38

Option 39

Option 40

Option 41

Option 42

Option 43

Option 44

Option 45

Option 46

Option 47

Option 48

Option 49

Option 50

Option 51

Option 52

Option 53

Option 54

Option 55

Option 56

Option 57

Option 58

Show child attributes

Response

200

application/json

Default Response

role · object · required

Show child attributes