Create Element User (v2.1)

POST 
/v2.1/api/tenants/:tenant_id/elementusers

Create an element user.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

application/json

Body

Details of the element user to be created

id string

The ID.

is_tenant_level boolean

The tenant level is flagged.

login_id string

The element user log in ID. Login Id length should be between 4 and 16. = ^[a-z][-a-z0-9]*$

password string

The new password. Password should have atleast one alphabet, one numeric and a special character. Allowed special characters are ? = . * ! @ # % ^ & _ -; Password Length should be between 8 to 64.

role string

Possible values: [SUPER, READONLY, MONITOR, EVAL]

The user role.

tenant_id stringrequired

ID of the tenant.

username string

The username. Max length = 255.

Responses

200

Successful Operation

application/json

Schema

Schema

id string

The ID.

is_tenant_level booleanrequired

The tenant level is flagged.

login_id stringrequired

The element user log in ID. Login Id length should be between 4 and 16. = ^[a-z][-a-z0-9]*$

role stringrequired

Possible values: [SUPER, READONLY, MONITOR, EVAL]

The user role.

tenant_id stringrequired

ID of the tenant.

username string

The username. Max length = 255.

Example (from schema)

{
  "id": "string",
  "is_tenant_level": true,
  "login_id": "string",
  "role": "SUPER",
  "tenant_id": "string",
  "username": "string"
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "INVALID_USERNAME"
      },
      {
        "code": "LOGIN_ID_REQUIRED"
      },
      {
        "code": "RESERVED_ELEMENT_USER_LOGIN_ID"
      },
      {
        "code": "IS_TENANT_LEVEL_FLAG_REQUIRED"
      },
      {
        "code": "INVALID_USER_ROLE"
      },
      {
        "code": "LOGIN_ID_CONSTRAINT_LENGTH"
      },
      {
        "code": "INVALID_LOGIN_ID"
      }
    ]
  }
}

Loading...