Update a realm

PUT 
https://demo.openremote.io/api/master/realm/:name

Update a realm

Request

Path Parameters

name stringrequired

Header Parameters

Authorization string
X-Forwarded-Proto string
X-Forwarded-Host string

application/json

Body

idstring
namestring
displayNamestring
enabledboolean
notBeforedouble
passwordPolicystring[]
resetPasswordAllowedboolean
duplicateEmailsAllowedboolean
rememberMeboolean
registrationAllowedboolean
registrationEmailAsUsernameboolean
verifyEmailboolean
loginWithEmailboolean
loginThemestring
accountThemestring
adminThemestring
emailThemestring
accessTokenLifespanint32

realmRoles

object[]

Array [

namestring

descriptionstring

]

Responses

default

default response

application/json

Schema

Schema

any

Authorization: oauth2

name: openidtype: oauth2flows: {
  "clientCredentials": {
    "tokenUrl": "/auth/realms/master/protocol/openid-connect/token",
    "refreshUrl": "/auth/realms/master/protocol/openid-connect/token",
    "scopes": {
      "profile": "profile"
    }
  },
  "authorizationCode": {
    "authorizationUrl": "/auth/realms/master/protocol/openid-connect/auth",
    "tokenUrl": "/auth/realms/master/protocol/openid-connect/token",
    "refreshUrl": "/auth/realms/master/protocol/openid-connect/token",
    "scopes": {
      "profile": "profile"
    }
  }
}

• curl
• nodejs
• java
• python
• ruby
• csharp
• go
• php
• powershell

• CURL

curl -L -X PUT 'https://demo.openremote.io/api/master/realm/:name' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <token>' \
-d '{
  "id": "string",
  "name": "string",
  "displayName": "string",
  "enabled": true,
  "notBefore": 0,
  "passwordPolicy": [
    "string"
  ],
  "resetPasswordAllowed": true,
  "duplicateEmailsAllowed": true,
  "rememberMe": true,
  "registrationAllowed": true,
  "registrationEmailAsUsername": true,
  "verifyEmail": true,
  "loginWithEmail": true,
  "loginTheme": "string",
  "accountTheme": "string",
  "adminTheme": "string",
  "emailTheme": "string",
  "accessTokenLifespan": 0,
  "realmRoles": [
    {
      "name": "string",
      "description": "string"
    }
  ]
}'

Request Collapse all

Base URL

https://demo.openremote.io/api/master

Auth

Bearer Token

Parameters

name — pathrequired

Authorization — header

X-Forwarded-Proto — header

X-Forwarded-Host — header

Body

{
  "id": "string",
  "name": "string",
  "displayName": "string",
  "enabled": true,
  "notBefore": 0,
  "passwordPolicy": [
    "string"
  ],
  "resetPasswordAllowed": true,
  "duplicateEmailsAllowed": true,
  "rememberMe": true,
  "registrationAllowed": true,
  "registrationEmailAsUsername": true,
  "verifyEmail": true,
  "loginWithEmail": true,
  "loginTheme": "string",
  "accountTheme": "string",
  "adminTheme": "string",
  "emailTheme": "string",
  "accessTokenLifespan": 0,
  "realmRoles": [
    {
      "name": "string",
      "description": "string"
    }
  ]
}

ResponseClear

Click the Send API Request button above and see the response here!