AttackForge Enterprise & AttackForge Core
Powered By GitBook
GetUserById
This method can be used for the following functionality: Get details for a user.

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/:id HTTP/1.1
2
Host: demo.attackforge.com
3
X-SSAPI-KEY: APIKey
4
Content-Type: application/json
5
Connection: close
Copied!

Query

id (string)
Id of the user.
Example:
1
GET /api/ss/users/5d5b27734a83a708c46f4748 HTTP/1.1
Copied!

Example

The following example is a cURL request to get a user.

Request

Include API Token instead of stars in 'X-SSAPI-KEY: ***************************************' parameter.
1
curl -X GET 'https://demo.attackforge.com/api/ss/users/5d5b27734a83a708c46f4748' -H 'Host: demo.attackforge.com' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close'
Copied!

Response

Response contains a user object.
1
{
2
"user": {
3
"status": "...",
4
"role": "...",
5
"first_name": "...",
6
"last_name": "...",
7
"email_address": "...",
8
"username": "...",
9
"mfa_enabled": "...",
10
"last_logged_in": "...",
11
"created": "...",
12
"id": "..."
13
}
14
}
Copied!
Last modified 1yr ago