Update a role
PATCH
/v1/iam/roles/{id}
const url = 'http://localhost:8080/v1/iam/roles/example';const options = { method: 'PATCH', headers: {'Content-Type': 'application/json'}, body: '{"name":"example","description":"example","permissions":["example"]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url http://localhost:8080/v1/iam/roles/example \ --header 'Content-Type: application/json' \ --data '{ "name": "example", "description": "example", "permissions": [ "example" ] }'Roles isSystem=true cannot be mutated. New permissions revalidated via assertCanonicalPermission(C1=a+C12).
Parameters
Section intitulée « Parameters »Path Parameters
Section intitulée « Path Parameters » id
required
string
Request Body required
Section intitulée « Request Body required » Media type application/json
object
name
string
description
string | null
permissions
Array<string>
Example generated
{ "name": "example", "description": "example", "permissions": [ "example" ]}Responses
Section intitulée « Responses »Role updated.
Media type application/json
object
status
required
string
code
required
string
data
required
object
id
required
string
tenantId
required
string
name
required
string
description
required
string | null
permissions
required
Array<string>
isSystem
required
boolean
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
cache
object
hit
required
boolean
key
string
ageSeconds
integer
expiresAt
string format: date-time
timing
object
totalMs
required
integer
dbMs
integer
externalMs
integer
deprecation
object
sunset
required
string format: date-time
successor
string
note
string
Example
{ "status": "success"}Requête mal formée (validation_error, invalid_idempotency_key, invalid_sort_field, invalid_filter).
Media type application/json
object
status
required
string
code
required
string
error
required
object
message
string
requestId
required
string
details
Array<object>
object
path
string
code
string
message
string
key
additional properties
Example
{ "status": "error"}Authentification manquante ou invalide.
Media type application/json
object
status
required
string
code
required
string
error
required
object
message
string
requestId
required
string
details
Array<object>
object
path
string
code
string
message
string
key
additional properties
Example
{ "status": "error"}Scope insuffisant (forbidden, no_active_plan, service_disabled_on_plan).
Media type application/json
object
status
required
string
code
required
string
error
required
object
message
string
requestId
required
string
details
Array<object>
object
path
string
code
string
message
string
key
additional properties
Example
{ "status": "error"}Ressource introuvable (ou hors-tenant).
Media type application/json
object
status
required
string
code
required
string
error
required
object
message
string
requestId
required
string
details
Array<object>
object
path
string
code
string
message
string
key
additional properties
Example
{ "status": "error"}Conflit d’état (cannot_replay_<status>, idempotency_mismatch).
Media type application/json
object
status
required
string
code
required
string
error
required
object
message
string
requestId
required
string
details
Array<object>
object
path
string
code
string
message
string
key
additional properties
Example
{ "status": "error"}