PATCH
/
api
/
v2
/
workspace
/
{projectId}
/
roles
/
{roleId}
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": [
    {
      "subject": "secrets",
      "inverted": true,
      "action": "read",
      "conditions": {
        "environment": "<string>",
        "secretPath": "<string>",
        "secretName": "<string>",
        "secretTags": {
          "$in": [
            "<string>"
          ]
        }
      }
    }
  ]
}'
{
  "role": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "slug": "<string>",
    "permissions": [
      {
        "subject": "<string>",
        "action": "<string>",
        "conditions": "<any>",
        "inverted": true
      }
    ],
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "projectId": "<string>",
    "version": 1
  }
}

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.

Response

200
application/json
Default Response
​
role
object
required

Was this page helpful?

Suggest editsRaise issue