user-rest-api-example.md

User REST API

GetUsersParams

Object containing the following properties:

Property	Type	Default
page	number (int, ≥1)	1
pageSize	number (int, ≥0, ≤100)	30

All properties are optional.

GetUsersResponse

Object containing the following properties:

Property	Type
users (*)	Array of objects: username: string (regex: /^[a-z][a-z0-9.]*$/) email: string (email) firstName: string lastName: string

(*) Required.

GetUserParams

Object containing the following properties:

Property	Type
username (*)	string (regex: /^[a-z][a-z0-9.]*$/)

(*) Required.

GetUserResponse

Object containing the following properties:

Property	Type
username (*)	string (regex: /^[a-z][a-z0-9.]*$/)
email (*)	string (email)
firstName	string
lastName	string

(*) Required.

CreateUserParams

Object containing the following properties:

Property	Type
username (*)	string (regex: /^[a-z][a-z0-9.]*$/)
email (*)	string (email)
firstName	string
lastName	string
password (*)	string (min length: 6)

(*) Required.

CreateUserResponse

Object containing the following properties:

Property	Type
username (*)	string (regex: /^[a-z][a-z0-9.]*$/)
email (*)	string (email)
firstName	string
lastName	string

(*) Required.

UpdateUserParams

Object containing the following properties:

Property	Type
username (*)	string (regex: /^[a-z][a-z0-9.]*$/)

(*) Required.

UpdateUserPayload

Object containing the following properties:

Property	Type
email (*)	string (email)
firstName	string
lastName	string

(*) Required.

DeleteUserParams

Object containing the following properties:

Property	Type
username (*)	string (regex: /^[a-z][a-z0-9.]*$/)

(*) Required.