Create User (Deprecated)
deprecated
This endpoint has been deprecated and may be removed in future versions of the API.
This operation creates a user.
- application/json
Request Body
users object[]
description stringA general description of the user account
email stringThe email address of the user.
fullName stringThe full name of the user
password stringThe password of the user to access the user account. The password must be in Base64 encoded in JSON request
agePasswordDays integerThe number of days to keep the password active.
enableUser booleanThe option to enable/disable the user
userEntity object
userName stringThe name of the user.
securityAssociations object
associations object[]
entities object
entity object[]name of the entity to be associated
properties object
role object
_type_ integerSpecify the type of permissions that are included in the role
roleId integerId of the role
roleName stringName of the role
associationsOperationType stringType of operation. eg: ADD
associatedUserGroups object[]
userGroupName stringThe name of the user group associated with the user
Responses
- 200
OK
- application/json
- Schema
- Example (from schema)
- Create user response
Schema
processinginstructioninfo object
attributes object[]
name stringvalue stringresponse object[]
errorString stringerrorCode integerentity object
userId integeruserName string
{
"processinginstructioninfo": {
"attributes": [
{
"name": "string",
"value": "string"
}
]
},
"response": [
{
"errorString": "string",
"errorCode": 0,
"entity": {
"userId": 0,
"userName": "string"
}
}
]
}
{
"processinginstructioninfo": {
"attributes": [
{
"name": "exitval",
"value": "0"
}
]
},
"response": [
{
"errorString": "Successful",
"errorCode": 0,
"warningMessage": "",
"entity": {
"userId": 3144,
"userGUID": "643DF0A1-900E-4509-BCB4-9BE8543C11A9",
"userName": "j_doe"
}
}
]
}
Loading...