Get List of Users

GET 
/user

This API returns the user information from SSM. This API will return only the user attributes which are not null or blank.

You can search for a user based on any parameters given below and not only the username.

The Authorization must have Bearer followed by Token.

Mandatory params: q

Optional params: offset, max, sort, order, countonly, fields showsecurityanswers - "0"/"1" to display encrypted security answers for the user

Request

Query Parameters

q string
fields string
sort string
order string
offset string
max string
string

Responses

200

Get User

Response Headers

• Date

  string

• Server

  string

• Set-Cookie

  string

• Transfer-Encoding

  string

• X-Frame-Options

  string

application/json

Schema

Schema

count number
errorCode string
msg string
offset string
order string

results

object[]

Array [

Last Name string

User Name string

firstname string

]

sort string

Example (from schema)

{
  "count": 2,
  "errorCode": "0",
  "msg": "Successful",
  "offset": "2",
  "order": "desc",
  "results": [
    {
      "Last Name": "Doe",
      "User Name": "johndoe",
      "firstname": "John"
    },
    {
      "Last Name": "Doe",
      "User Name": "janedoe",
      "firstname": "Jane"
    }
  ],
  "sort": "username"
}

Get User

{
  "count": 2,
  "errorCode": "0",
  "msg": "Successful",
  "offset": "2",
  "order": "desc",
  "results": [
    {
      "Last Name": "Doe",
      "User Name": "johndoe",
      "firstname": "John"
    },
    {
      "Last Name": "Doe",
      "User Name": "janedoe",
      "firstname": "Jane"
    }
  ],
  "sort": "username"
}

Loading...