AttackForge Enterprise

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

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=john.citizen@attackforge.com 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=john.citizen@attackforge.com 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": "..."
}
]
}