Create or update a realm
PUT
/auth/realms/{name}
const url = 'https://sylve.lan:8181/api/auth/realms/example';const options = { method: 'PUT', headers: {Authorization: '<Authorization>', 'Content-Type': 'application/json'}, body: '{"acrValues":"example","autoCreate":true,"caCert":"example","clientId":"example","clientSecret":"example","default":true,"enabled":true,"groupMappings":[{"claim":"example","group":"example"}],"groupsClaim":"example","hasSecret":true,"hostedDomains":"example","id":1,"issuer":"example","label":"example","name":"example","prompt":"example","queryUserInfo":true,"scopes":"example","sessionHours":1,"usernameClaim":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://sylve.lan:8181/api/auth/realms/example \ --header 'Authorization: <Authorization>' \ --header 'Content-Type: application/json' \ --data '{ "acrValues": "example", "autoCreate": true, "caCert": "example", "clientId": "example", "clientSecret": "example", "default": true, "enabled": true, "groupMappings": [ { "claim": "example", "group": "example" } ], "groupsClaim": "example", "hasSecret": true, "hostedDomains": "example", "id": 1, "issuer": "example", "label": "example", "name": "example", "prompt": "example", "queryUserInfo": true, "scopes": "example", "sessionHours": 1, "usernameClaim": "example" }'Issuer and client ID are fixed once a realm exists; a missing clientSecret keeps the stored one
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”name
required
string
Realm name
Request Body
Section titled “Request Body”Realm
Media typeapplication/json
object
acrValues
string
autoCreate
boolean
caCert
string
clientId
string
clientSecret
string
default
boolean
enabled
boolean
groupMappings
Array<object>
object
claim
string
group
string
groupsClaim
string
hasSecret
boolean
hostedDomains
string
id
integer
issuer
string
label
string
name
string
prompt
string
queryUserInfo
boolean
scopes
string
sessionHours
integer
usernameClaim
string
Examplegenerated
{ "acrValues": "example", "autoCreate": true, "caCert": "example", "clientId": "example", "clientSecret": "example", "default": true, "enabled": true, "groupMappings": [ { "claim": "example", "group": "example" } ], "groupsClaim": "example", "hasSecret": true, "hostedDomains": "example", "id": 1, "issuer": "example", "label": "example", "name": "example", "prompt": "example", "queryUserInfo": true, "scopes": "example", "sessionHours": 1, "usernameClaim": "example"}Responses
Section titled “Responses”Realm Set
Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{ "data": "example", "error": "example", "message": "example", "status": "example"}Bad Request
Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{ "data": "example", "error": "example", "message": "example", "status": "example"}Forbidden
Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{ "data": "example", "error": "example", "message": "example", "status": "example"}Service Unavailable
Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{ "data": "example", "error": "example", "message": "example", "status": "example"}