GetUsers

This method can be used for the following functionality: Get details for all users.

Parameters

The following URL, Headers and Parameters are required for requests to this API endpoint. Where a parameter is optional, it will be indicated. Otherwise treat all parameters as mandatory.

Headers

GET /api/ss/users HTTP/1.1
Host: demo.attackforge.com
X-SSAPI-KEY: APIKey
Content-Type: application/json
Connection: close

Query

order (string) (optional)

Field and direction to sort the returned data. Direction must be ASC or DESC. Default is first_name DESC. The following fields can be sorted - id, first_name, last_name, email_address, username, and custom_field_ followed by the custom field key e.g. custom_field_department. Administrators can also sort by account_expiry, created, email_verified, exempt_global_inactivity_policy, failed_logins, is_deleted, last_active_on_app, last_active_on_ssapi, last_logged_in, last_login_type, mfa_enabled, modified, role and status.

Example:

GET /api/ss/users?order=last_name:DESC HTTP/1.1

userId (string) (optional)

ID of user(s) to include. Add multiple for more than one user e.g. ?userId=id1&userId=id2

Example:

GET /api/ss/users?userId=5d5b27734a83a708c46f4748 HTTP/1.1

firstName (string) (optional)

First name of the user.

Example:

GET /api/ss/users?firstName=John HTTP/1.1

lastName (string) (optional)

Last name of the user.

Example:

GET /api/ss/users?lastName=Citizen HTTP/1.1

email (string) (optional)

Email address of the user.

Example:

GET /api/ss/users?email=[e-mail] HTTP/1.1

username (string) (optional)

Username of the user. This is typically the email address unless your tenant is configured otherwise.

Example:

GET /api/ss/users?username=[e-mail] HTTP/1.1

Example

The following example is a cURL request to get all users with the first name Bob.

Request

Include API Token instead of stars in 'X-SSAPI-KEY: ***************************************' parameter.

curl -X GET 'https://demo.attackforge.com/api/ss/users?firstName=Bob' -H 'Host: demo.attackforge.com' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close'

Response

Response contains an array of user objects.

{
   "count": 999,
   "users":[
      {
         "status": "...",
         "role": "...",
         "first_name": "...",
         "last_name": "...",
         "email_address": "...",
         "username": "...",
         "mfa_enabled": "...",
         "last_logged_in": "...",
         "created": "...",
         "id": "...",
         "custom_fields": [
           { 
              "key": "department", 
              "value": "IT Security" 
           }
         ]
      }
   ]
}