curl --request PATCH \
--url https://api.sandbox.tesouro.com/identity/v1/roles/{roleId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"description": "<string>",
"key": "<string>",
"name": "<string>",
"sortOrdinal": 123
}
'import requests
url = "https://api.sandbox.tesouro.com/identity/v1/roles/{roleId}"
payload = {
"description": "<string>",
"key": "<string>",
"name": "<string>",
"sortOrdinal": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({description: '<string>', key: '<string>', name: '<string>', sortOrdinal: 123})
};
fetch('https://api.sandbox.tesouro.com/identity/v1/roles/{roleId}', 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.tesouro.com/identity/v1/roles/{roleId}",
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([
'description' => '<string>',
'key' => '<string>',
'name' => '<string>',
'sortOrdinal' => 123
]),
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.sandbox.tesouro.com/identity/v1/roles/{roleId}"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"sortOrdinal\": 123\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.sandbox.tesouro.com/identity/v1/roles/{roleId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"sortOrdinal\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.tesouro.com/identity/v1/roles/{roleId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"<string>\",\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"sortOrdinal\": 123\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdDateTime": "2023-11-07T05:31:56Z",
"key": "bank:admin",
"name": "<string>",
"sortOrdinal": 123,
"status": "<string>",
"updatedDateTime": "2023-11-07T05:31:56Z",
"appliesToOrgType": "<string>",
"description": "<string>",
"icon": "<string>",
"isSystemRole": true,
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"detail": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"detail": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"detail": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"detail": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"detail": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>"
}Update role
Token types: APP, USER | Required scopes: role:write:org
curl --request PATCH \
--url https://api.sandbox.tesouro.com/identity/v1/roles/{roleId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"description": "<string>",
"key": "<string>",
"name": "<string>",
"sortOrdinal": 123
}
'import requests
url = "https://api.sandbox.tesouro.com/identity/v1/roles/{roleId}"
payload = {
"description": "<string>",
"key": "<string>",
"name": "<string>",
"sortOrdinal": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({description: '<string>', key: '<string>', name: '<string>', sortOrdinal: 123})
};
fetch('https://api.sandbox.tesouro.com/identity/v1/roles/{roleId}', 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.tesouro.com/identity/v1/roles/{roleId}",
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([
'description' => '<string>',
'key' => '<string>',
'name' => '<string>',
'sortOrdinal' => 123
]),
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.sandbox.tesouro.com/identity/v1/roles/{roleId}"
payload := strings.NewReader("{\n \"description\": \"<string>\",\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"sortOrdinal\": 123\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.sandbox.tesouro.com/identity/v1/roles/{roleId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"description\": \"<string>\",\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"sortOrdinal\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sandbox.tesouro.com/identity/v1/roles/{roleId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"description\": \"<string>\",\n \"key\": \"<string>\",\n \"name\": \"<string>\",\n \"sortOrdinal\": 123\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdDateTime": "2023-11-07T05:31:56Z",
"key": "bank:admin",
"name": "<string>",
"sortOrdinal": 123,
"status": "<string>",
"updatedDateTime": "2023-11-07T05:31:56Z",
"appliesToOrgType": "<string>",
"description": "<string>",
"icon": "<string>",
"isSystemRole": true,
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"detail": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"detail": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"detail": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"detail": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>"
}{
"detail": "<string>",
"instance": "<string>",
"status": 123,
"title": "<string>",
"type": "<string>"
}Authorizations
Application (M2M) OAuth2 access token (client credentials).
Headers
ID of the organization to scope this operation to. When omitted, the role is updated in the caller's own organization. Must be a valid non-empty UUID. Present but empty or malformed values return 400.
Path Parameters
The ID of the role to update.
Body
Cancellation token.
Two states accepted: absent = leave unchanged, value = set (must be a ranked type the owning org holds). Clearing to null is rejected, roles cannot become unscoped.
BANK, EMBEDDED, PLATFORM, TRANSACTOR, VERTICAL_SOFTWARE_PROVIDER, null Three states: absent = leave unchanged, null = clear, value = set.
Two states accepted: absent = leave unchanged, value = set (must be at least 5000). Clearing to null is rejected.
Response
Role updated successfully.
bank:admin, embedded:admin, embedded:bookkeeper, embedded:employee, embedded:finance_admin, platform:admin, vsp:admin Was this page helpful?