Edit an organization custom role

Edit an organization custom role

PUT /organization/{organizationId}/customRole/{customRoleId}

Edit an organization custom role

cURL

curl --request PUT \
  --url https://api.qovery.com/organization/{organizationId}/customRole/{customRoleId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "cluster_permissions": [
    {
      "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "permission": "VIEWER"
    }
  ],
  "project_permissions": [
    {
      "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "is_admin": false,
      "permissions": [
        {
          "environment_type": "PRODUCTION",
          "permission": "NO_ACCESS"
        }
      ]
    }
  ],
  "description": "<string>"
}
'

200

{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "cluster_permissions": [
    {
      "cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "cluster_name": "<string>",
      "permission": "VIEWER"
    }
  ],
  "project_permissions": [
    {
      "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "project_name": "<string>",
      "is_admin": false,
      "permissions": [
        {
          "environment_type": "PRODUCTION",
          "permission": "NO_ACCESS"
        }
      ]
    }
  ]
}

Authorizations

bearerAuthApiKeyAuth

Authorization · string · header · required

JWT tokens should be used with OIDC account (human to machine). JWT tokens used by the Qovery console to communicate with the API have a TTL. Curl Example ' curl https://console.qovery.com/organization -H "Authorization: Bearer $qovery_token" '

Path Parameters

organizationId · string<uuid> · required

Organization ID

customRoleId · string<uuid> · required

Custom Role ID

Body

application/json

name · string · required

cluster_permissions · object[] · required

Should contain an entry for every existing cluster

Show child attributes

project_permissions · object[] · required

Should contain an entry for every existing project

Show child attributes

description · string

Response

200

application/json

Edit an organization custom role

id · string

name · string

description · string

cluster_permissions · object[]

Show child attributes

project_permissions · object[]

Show child attributes