GetUserByEmail

This method can be used for the following: Get details for a user, searching by email address;

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/email/:email HTTP/1.1
Host: demo.attackforge.com
X-SSAPI-KEY: APIKey
Content-Type: application/json
Connection: close

Query

email (string)

Email address of the user.

Example:

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

Example

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

Request

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

curl -X GET 'https://demo.attackforge.com/api/ss/users/email/[e-mail]' -H 'Host: demo.attackforge.com' -H 'X-SSAPI-KEY: ***************************************' -H 'Content-Type: application/json' -H 'Connection: close'

Response

Response contains a user object.

{
    "user": {
        "status": "...",
        "role": "...",
        "first_name": "...",
        "last_name": "...",
        "email_address": "...",
        "username": "...",
        "mfa_enabled": "...",
        "last_logged_in": "...",
        "created": "...",
        "id": "..."
    }
}