Adds a new user
post
/service/user
This endpoint is used to add a new user.
Request
Supported Media Types
- application/json
- application/xml
Header Parameters
-
sourceCode(required): string
Source from which request is initiated
Request Body that contains data required for creating a new user
Nested Schema : GenericDto
Match All
Show Source
-
object
GenericDto-allOf[0]
Discriminator:
resource_type
Nested Schema : GenericDto-allOf[0]
Type:
objectDiscriminator:
resource_typeNested Schema : UserDto-allOf[1]
Type:
Show Source
object-
customerNo:
string
-
endDate:
string
-
homeBranch(required):
string
Minimum Length:
0Maximum Length:3 -
homePhone:
string
Minimum Length:
0Maximum Length:50 -
isSupervisor(required):
string
Minimum Length:
0Maximum Length:1 -
languageCode(required):
string
Minimum Length:
0Maximum Length:3 -
locale:
string
Minimum Length:
0Maximum Length:10 -
managerId:
string
Minimum Length:
0Maximum Length:12 -
piiEnabled:
boolean
PII Enabled
-
staffAccRestriction:
string
-
startDate(required):
string
-
statusChangedOn:
string
-
telephoneNumber:
string
Minimum Length:
0Maximum Length:50 -
theme:
string
Minimum Length:
0Maximum Length:100 -
UserApplications:
array UserApplications
-
userEmail:
string
Minimum Length:
0Maximum Length:50 -
userFax:
string
Minimum Length:
0Maximum Length:50Pattern:^$|^\+?[0-9]{6,}$ -
userLoginId(required):
string
Minimum Length:
0Maximum Length:12 -
userMobile:
string
Minimum Length:
0Maximum Length:50Pattern:^$|^\+[1-9]{1}[0-9]{3,14}$ -
userName(required):
string
Minimum Length:
0Maximum Length:100 -
UserRoleBranches:
array UserRoleBranches
-
userStatus(required):
string
Minimum Length:
0Maximum Length:1
Nested Schema : UserApplications
Type:
Show Source
object-
applicationDescription:
string
Application description
-
applicationId(required):
string
Minimum Length:
0Maximum Length:36 -
applicationName:
string
Application name
-
id:
string
Minimum Length:
0Maximum Length:36 -
userId:
string
Minimum Length:
0Maximum Length:36
Nested Schema : UserRoleBranches
Type:
Show Source
object-
branchCode(required):
string
Minimum Length:
0Maximum Length:3 -
branchId(required):
string
Minimum Length:
0Maximum Length:36 -
id:
string
Minimum Length:
0Maximum Length:36 -
roleCode:
string
-
roleDescription:
string
-
roleId(required):
string
Minimum Length:
0Maximum Length:36 -
userId:
string
Minimum Length:
0Maximum Length:36
Response
Supported Media Types
- application/json
- application/xml
201 Response
Returns message of success or failure
Headers
-
Location: string
URL of newly created user
Nested Schema : GenericDto
Match All
Show Source
-
object
GenericDto-allOf[0]
Discriminator:
resource_type
Nested Schema : GenericDto-allOf[0]
Type:
objectDiscriminator:
resource_typeNested Schema : UserDto-allOf[1]
Type:
Show Source
object-
customerNo:
string
-
endDate:
string
-
homeBranch(required):
string
Minimum Length:
0Maximum Length:3 -
homePhone:
string
Minimum Length:
0Maximum Length:50 -
isSupervisor(required):
string
Minimum Length:
0Maximum Length:1 -
languageCode(required):
string
Minimum Length:
0Maximum Length:3 -
locale:
string
Minimum Length:
0Maximum Length:10 -
managerId:
string
Minimum Length:
0Maximum Length:12 -
piiEnabled:
boolean
PII Enabled
-
staffAccRestriction:
string
-
startDate(required):
string
-
statusChangedOn:
string
-
telephoneNumber:
string
Minimum Length:
0Maximum Length:50 -
theme:
string
Minimum Length:
0Maximum Length:100 -
UserApplications:
array UserApplications
-
userEmail:
string
Minimum Length:
0Maximum Length:50 -
userFax:
string
Minimum Length:
0Maximum Length:50Pattern:^$|^\+?[0-9]{6,}$ -
userLoginId(required):
string
Minimum Length:
0Maximum Length:12 -
userMobile:
string
Minimum Length:
0Maximum Length:50Pattern:^$|^\+[1-9]{1}[0-9]{3,14}$ -
userName(required):
string
Minimum Length:
0Maximum Length:100 -
UserRoleBranches:
array UserRoleBranches
-
userStatus(required):
string
Minimum Length:
0Maximum Length:1
Nested Schema : UserApplications
Type:
Show Source
object-
applicationDescription:
string
Application description
-
applicationId(required):
string
Minimum Length:
0Maximum Length:36 -
applicationName:
string
Application name
-
id:
string
Minimum Length:
0Maximum Length:36 -
userId:
string
Minimum Length:
0Maximum Length:36
Nested Schema : UserRoleBranches
Type:
Show Source
object-
branchCode(required):
string
Minimum Length:
0Maximum Length:3 -
branchId(required):
string
Minimum Length:
0Maximum Length:36 -
id:
string
Minimum Length:
0Maximum Length:36 -
roleCode:
string
-
roleDescription:
string
-
roleId(required):
string
Minimum Length:
0Maximum Length:36 -
userId:
string
Minimum Length:
0Maximum Length:36
Nested Schema : items
Type:
object400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
405 Response
Invalid input
500 Response
Internal error