Reseller Get User by Email API

POST /resellerGetUserByEmail

Description

This API endpoint retrieves detailed information about a user associated with a reseller using their email address.

Request Body

The request uses GraphQL to perform the resellerGetUserByEmail query, which requires an email variable to specify the user's email.

Query:

query resellerGetUserByEmail ($email: String) {
    resellerGetUserByEmail (email: $email) {
        id
        email
        username
        resellerId
        role
        enabled
        radAccess
        radAccessClear
        createdAt
        updatedAt
    }
}

GraphQL Variables:

{
  "email": ""
}

Example Request:

curl --location '' \
--header 'Content-Type: application/json' \
--data '{"query":"query resellerGetUserByEmail ($email: String) {\n    resellerGetUserByEmail (email: $email) {\n        id\n        email\n        username\n        resellerId\n        role\n        enabled\n        radAccess\n        radAccessClear\n        createdAt\n        updatedAt\n    }\n}","variables":{"email":"user@example.com"}}'

Response:

• Success (200 OK):

  • The response includes detailed information about the user associated with the given email address.

  {
    "data": {
      "resellerGetUserByEmail": {
        "id": 123,
        "email": "user@example.com",
        "username": "username123",
        "resellerId": 45,
        "role": "admin",
        "enabled": true,
        "radAccess": true,
        "radAccessClear": false,
        "createdAt": "2023-01-01T12:00:00Z",
        "updatedAt": "2024-01-01T12:00:00Z"
      }
    }
  }

• Error (4XX/5XX):

  • If there is an issue with the request or server error, the response will include an error message and status code.

Note:

This endpoint is useful for retrieving specific user details within a reseller's organization by providing their email address. Ensure that the email provided is valid to get accurate results.