AttackForge Enterprise & AttackForge Core
Powered By GitBook
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

1
GET /api/ss/users HTTP/1.1
2
Host: demo.attackforge.com
3
X-SSAPI-KEY: APIKey
4
Content-Type: application/json
5
Connection: close
Copied!

Query

firstName (string) (optional)
First name of the user.
Example:
1
GET /api/ss/users?firstName=John HTTP/1.1
Copied!
lastName (string) (optional)
Last name of the user.
Example:
1
GET /api/ss/users?lastName=Citizen HTTP/1.1
Copied!
email (string) (optional)
Email address of the user.
Example:
1
GET /api/ss/[email protected] HTTP/1.1
Copied!
username (string) (optional)
Username of the user. This is typically the email address unless your tenant is configured otherwise.
Example:
1
GET /api/ss/[email protected] HTTP/1.1
Copied!

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.
1
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'
Copied!

Response

Response contains an array of user objects.
1
{
2
"count": 999,
3
"users":[
4
{
5
"status": "...",
6
"role": "...",
7
"first_name": "...",
8
"last_name": "...",
9
"email_address": "...",
10
"username": "...",
11
"mfa_enabled": "...",
12
"last_logged_in": "...",
13
"created": "...",
14
"id": "..."
15
}
16
]
17
}
Copied!
Last modified 1yr ago