Qeo Open Source Project Documentation : /realms/{id}/users (POST)

HTTP Authorization

Path parameter:
    identifier of the realm to be interrogated (value is of type long)

For a Create:
     Body: Must contain the user name 
              {"name":"..."}

               Parameter:
                   "name" : UTF-8 string representing the name of the user in the realm
                                 Leading and trailing spaces are removed from the name.
                                 The provided name cannot be empty.

{
   "name":"My user name"
}

For a Modify:
     Body: Must contain the user name and the user identifier
              {"id":...,"name":"..."}

              Parameters:
                 "id"       : value of type long, representing the user identifier
                 "name" : UTF-8 string representing the name of the user in the realm
                               Leading and trailing spaces are removed from the name.
                               The provided name cannot be empty.

{
   "id":123,
   "name":"My user name"
}

For a Create:
HTTP 201 Created
Content-Type: application/json

For a Modify:
HTTP 200 OK
Content-Type: application/json

Body: Contains the created/modified user in JSON format as it is stored in the database:
          {"id":...,"name":"...","type":"user","realm":...}

          The returned parameters are: 
              "id"       : value of type long, representing the user identifier
              "type"   : type of object returned (always "user")
              "realm" : value of type long, represents the realm identifier
              "name" : UTF-8 string representing the name of the user in the realm

{
   "id":123,
   "realm":103,
   "type":"user",
   "name":"My user name"
}