Update Role

Partial update of a custom role. Note: role_type is immutable.

PATCH /organizations/roles/{role_id}

Update Role

cURL

curl --request PATCH \
  --url https://api-sandbox.y.uno/v1/organizations/roles/{role_id} \
  --header 'Content-Type: application/json' \
  --header 'PRIVATE-SECRET-KEY: <api-key>' \
  --header 'PUBLIC-API-KEY: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "permission_ids": [
    "<string>"
  ],
  "testing_permission_ids": [
    "<string>"
  ]
}
'

import requests

url = "https://api-sandbox.y.uno/v1/organizations/roles/{role_id}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "permission_ids": ["<string>"],
    "testing_permission_ids": ["<string>"]
}
headers = {
    "PUBLIC-API-KEY": "<api-key>",
    "PRIVATE-SECRET-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {
    'PUBLIC-API-KEY': '<api-key>',
    'PRIVATE-SECRET-KEY': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    permission_ids: ['<string>'],
    testing_permission_ids: ['<string>']
  })
};

fetch('https://api-sandbox.y.uno/v1/organizations/roles/{role_id}', 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-sandbox.y.uno/v1/organizations/roles/{role_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'permission_ids' => [
        '<string>'
    ],
    'testing_permission_ids' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "PRIVATE-SECRET-KEY: <api-key>",
    "PUBLIC-API-KEY: <api-key>"
  ],
]);

$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-sandbox.y.uno/v1/organizations/roles/{role_id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"permission_ids\": [\n    \"<string>\"\n  ],\n  \"testing_permission_ids\": [\n    \"<string>\"\n  ]\n}")

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

	req.Header.Add("PUBLIC-API-KEY", "<api-key>")
	req.Header.Add("PRIVATE-SECRET-KEY", "<api-key>")
	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.patch("https://api-sandbox.y.uno/v1/organizations/roles/{role_id}")
  .header("PUBLIC-API-KEY", "<api-key>")
  .header("PRIVATE-SECRET-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"permission_ids\": [\n    \"<string>\"\n  ],\n  \"testing_permission_ids\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.y.uno/v1/organizations/roles/{role_id}")

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

request = Net::HTTP::Patch.new(url)
request["PUBLIC-API-KEY"] = '<api-key>'
request["PRIVATE-SECRET-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"permission_ids\": [\n    \"<string>\"\n  ],\n  \"testing_permission_ids\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

200

{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "admin": true,
  "permission_ids": [
    "<string>"
  ],
  "testing_permission_ids": [
    "<string>"
  ],
  "role_type": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Partial update of a custom role. Note that role_type is immutable.

Authorizations

PUBLIC-API-KEY · string · header · default: <Your PUBLIC-API-KEY> · required

PRIVATE-SECRET-KEY · string · header · default: <Your PRIVATE-SECRET-KEY> · required

Path Parameters

role_id · string · required

The unique identifier of the role.

Body

application/json

name · string

Maximum string length: 255

description · string

Maximum string length: 1024

permission_ids · string[]

testing_permission_ids · string[]

Response

200

application/json

OK

id · string

name · string

description · string | null

admin · boolean

permission_ids · string[]

testing_permission_ids · string[]

role_type · string

created_at · string<date-time>

updated_at · string<date-time>