User

API to get Auth Token.

post
/user/login

Return Auth token - use this token to Authorize on using the secured API.

Body
usernamestringOptionalExample: **username**
passwordstringOptionalExample: ####pwd####
extendedExpirybooleanOptionalExample: true
Responses
chevron-right
200

Login Successful!

application/json
usernamestringOptionalExample: **username**
passwordstringOptionalExample: ####pwd####
extendedExpirybooleanOptionalExample: true
post
/user/login
get
/user

Get all users with their roles and details

Authorizations
authorizationstringRequired

Use User's Api for authorization

Responses
chevron-right
200

OK

No content

get
/user

No content

get
/user/role

Get all user roles with their permissions

Responses
chevron-right
200

OK

No content

get
/user/role

No content

post
/user/alterPermission

Alter role permissions (action or navigation)

Authorizations
authorizationstringRequired

Use User's Api for authorization

Body
typestringOptionalExample: object
Responses
chevron-right
200

OK

No content

post
/user/alterPermission

No content

post
/user/suspend

Suspend one or more users by their IDs

Authorizations
authorizationstringRequired

Use User's Api for authorization

Body
typestringOptionalExample: object
Responses
chevron-right
200

OK

No content

post
/user/suspend

No content

post
/user/restore

Restore suspended users by their IDs

Authorizations
authorizationstringRequired

Use User's Api for authorization

Body
typestringOptionalExample: object
Responses
chevron-right
200

OK

No content

post
/user/restore

No content

post
/user/alterPassword

Change password for a user (admin action)

Authorizations
authorizationstringRequired

Use User's Api for authorization

Body
typestringOptionalExample: object
Responses
chevron-right
200

OK

No content

post
/user/alterPassword

No content

post
/user/update-self-pwd

Update own password (self-service)

Authorizations
authorizationstringRequired

Use User's Api for authorization

Body
typestringOptionalExample: object
Responses
chevron-right
200

OK

No content

post
/user/update-self-pwd

No content

get
/user/preferences

Returns user-specific preferences and settings.

Authorizations
authorizationstringRequired

Use User's Api for authorization

Responses
chevron-right
200

OK

No content

get
/user/preferences

No content

Last updated