User API

Create User

Creates a user.

Request
header Parameters
Authorization
required
string
Default:

Bearer JWT Token

Example: Bearer JWT_TOKEN
Request Body schema: application/json

To create a user, the Login, First Name, Last Name, Email, Password, Question, and Answer fields are required.

login
required
string [ 1 .. 60 ] characters

login

firstName
required
string [ 1 .. 60 ] characters

firstName

lastName
required
string [ 1 .. 60 ] characters

lastName

email
required
string^(.+)@(.+)$

email

password
required
string(?=.*[0-9])(?=.*[a-z])(?=.*[A-Z])(?=\S+$).{8,...

password

question
required
string [ 3 .. 300 ] characters

question

answer
required
string [ 3 .. 2147483647 ] characters

answer

Responses
201

Created

400

Bad Request

401

Unauthorized

500

Internal Server Error

post/users
Request samples
application/json
{
  • "login": "admin",
  • "firstName": "John",
  • "lastName": "Miller",
  • "email": "john@yahoomail.com",
  • "password": "Password123",
  • "question": "What is your best friend's name?",
  • "answer": "Jim"
}

Search Users

Search user By ID or login.

Request
query Parameters
id
integer <int32>
Example: id=1
login
string
Example: login=admin
email
string
Example: email=admin@gmail.com
header Parameters
Authorization
required
string
Default:

Bearer JWT Token

Example: Bearer JWT_TOKEN
Responses
200

OK

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

get/users/search

Activate User

Activate a user.

Request
path Parameters
loginId
required
string

loginId

Example: admin
header Parameters
Authorization
required
string
Default:

Bearer JWT Token

Example: Bearer JWT Token
Responses
200

OK

400

Bad Request

401

Unauthorized

404

Not Found

put/users/{loginId}/activate

Deactivate User

Deactivate a user.

Request
path Parameters
loginId
required
string

loginId

Example: admin
header Parameters
Authorization
required
string
Default:

Bearer JWT Token

Example: Bearer JWT Token
Responses
200

OK

400

Bad Request

401

Unauthorized

404

Not Found

put/users/{loginId}/deactivate

Manage Permission

Manage user permission for the existing user in the system. This will remove the permission mapped earlier and the current request permissions will be considered always.

Request
path Parameters
loginId
required
string

loginId

Example: admin
header Parameters
Authorization
required
string
Default:

Bearer JWT Token

Example: Bearer JWT_TOKEN
Request Body schema: application/json

List of permissions is a required field. Allowable permissions are system_admin, edit_policy, and create_project.

permissions
required
Array of strings

permissions

Responses
200

OK

400

Bad Request

401

Unauthorized

404

Not Found

put/users/{loginId}/permission
Request samples
application/json
{
  • "permissions": [
    ]
}