Skip to main content
Version: 1.4.0

Create a new user in a realm

POST 
https://demo.openremote.io/api/master/user/:realm/users

Create a new user in a realm

Request​

Path Parameters

    realm stringrequired

Header Parameters

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

Body

    realmstring
    realmIdstring
    idstring
    firstNamestring
    lastNamestring
    emailstring
    enabledboolean
    createdOndate-time
    secretstring
    attributes object
    property name* string[]
  • Array [
    • string
  • ]
    • serviceAccountboolean
    usernamestring

    Possible values: >= 3 characters and <= 255 characters, Value must match regular expression ^(?=[\p{IsLatin}|\p{IsCommon}]+$)(?=[^<>&"'\s\v\h$%!#?§,;:*~/\\|^=\[\]{}()\p{Cntrl}]+$).*$`

Responses​

default response

Schema
    realmstring
    realmIdstring
    idstring
    firstNamestring
    lastNamestring
    emailstring
    enabledboolean
    createdOndate-time
    secretstring
    attributes object
    property name* string[]
  • Array [
    • string
  • ]
    • serviceAccountboolean
    usernamestring

    Possible values: >= 3 characters and <= 255 characters, Value must match regular expression ^(?=[\p{IsLatin}|\p{IsCommon}]+$)(?=[^<>&"'\s\v\h$%!#?§,;:*~/\\|^=\[\]{}()\p{Cntrl}]+$).*$`

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 -L 'https://demo.openremote.io/api/master/user/:realm/users' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <token>' \
-d '{
  "realm": "string",
  "realmId": "string",
  "id": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "enabled": true,
  "createdOn": "2024-07-29T15:51:28.071Z",
  "secret": "string",
  "attributes": {},
  "serviceAccount": true,
  "username": "string"
}'
Request Collapse all
Base URL
https://demo.openremote.io/api/master
Auth
Parameters
— pathrequired
— header
— header
— header
Body
{
  "realm": "string",
  "realmId": "string",
  "id": "string",
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "enabled": true,
  "createdOn": "2024-07-29T15:51:28.071Z",
  "secret": "string",
  "attributes": {},
  "serviceAccount": true,
  "username": "string"
}
ResponseClear

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