Skip to main content
GET
/
organization
/
{organizationId}
/
customRole
List organization custom roles
curl --request GET \
  --url https://api.qovery.com/organization/{organizationId}/customRole \
  --header 'Authorization: Bearer <token>'
{
  "results": [
    {
      "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

​
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

Response

List organization custom roles

​
results
object[]