SMsmokeball
Users

Get a user

Retrieves a specified user.

get/users/{id}

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/users/{id}
  • Auth
    API key in header x-api-key and API key in header Authorization

Path parameters

idstring uuid required

Response

When request is successful. Returns a 'User' object.

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable
userIdstring nullable

Unique identifier of the user.

emailstring nullable

Email address of the user.

isInternalboolean

Returns true if the user is flagged as an internal user.

bypassMfaboolean

Returns true if multi-factor authentication is bypassed for the user.

Example response

{
  "userId": "23d2a4bc-8529-462e-8560-dfbf4fa24e49",
  "email": "user@domain.com",
  "isInternal": true,
  "bypassMfa": true
}

Changes

No recorded changes to this operation across all 15 revisions of this API.