Skip to main content
PUT
/
organization
/
{organizationId}
/
customRole
/
{customRoleId}
Edit an organization custom role
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>"
}
'
import requests

url = "https://api.qovery.com/organization/{organizationId}/customRole/{customRoleId}"

payload = {
"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>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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>'
})
};

fetch('https://api.qovery.com/organization/{organizationId}/customRole/{customRoleId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.qovery.com/organization/{organizationId}/customRole/{customRoleId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'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>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.qovery.com/organization/{organizationId}/customRole/{customRoleId}"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"cluster_permissions\": [\n {\n \"cluster_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"permission\": \"VIEWER\"\n }\n ],\n \"project_permissions\": [\n {\n \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"is_admin\": false,\n \"permissions\": [\n {\n \"environment_type\": \"PRODUCTION\",\n \"permission\": \"NO_ACCESS\"\n }\n ]\n }\n ],\n \"description\": \"<string>\"\n}")

req, _ := http.NewRequest("PUT", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://api.qovery.com/organization/{organizationId}/customRole/{customRoleId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"cluster_permissions\": [\n {\n \"cluster_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"permission\": \"VIEWER\"\n }\n ],\n \"project_permissions\": [\n {\n \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"is_admin\": false,\n \"permissions\": [\n {\n \"environment_type\": \"PRODUCTION\",\n \"permission\": \"NO_ACCESS\"\n }\n ]\n }\n ],\n \"description\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.qovery.com/organization/{organizationId}/customRole/{customRoleId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"cluster_permissions\": [\n {\n \"cluster_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"permission\": \"VIEWER\"\n }\n ],\n \"project_permissions\": [\n {\n \"project_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"is_admin\": false,\n \"permissions\": [\n {\n \"environment_type\": \"PRODUCTION\",\n \"permission\": \"NO_ACCESS\"\n }\n ]\n }\n ],\n \"description\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "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

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

project_permissions
object[]
required

Should contain an entry for every existing project

description
string

Response

Edit an organization custom role

id
string
name
string
description
string
cluster_permissions
object[]
project_permissions
object[]