https://api.bitsighttech.com/ratings/v1/users
Get a list of all the users within your account.
Version 2 is available.
Parameters
Parameter | Values |
---|---|
include_details [Query] Include extra user details. |
[Boolean] Default: ↻ |
show_all [Query] Show all users. |
[Boolean] Default: ↻ false , only active users are shown; the user is not a company API token. |
view_company [Query] Include only the users who can view the specified company. |
[String] If Default: ↻ |
Example Request
curl 'https://api.bitsighttech.com/ratings/v1/users' -u api_token:
Example Response
[ { "friendly_name":"Jane", "formal_name":"Jane Smith", "first_name":"Jane", "last_name":"Smith", "email":"jane.smith@domain.com", "guid":"630867c3-c95c-4408-a07a-ed576cda8ede" } ]
Response Attributes
Field | Description |
---|---|
friendly_nameString |
This user’s preferred name. |
formal_nameString |
This user’s full name. |
first_nameString |
[Deprecated] The user’s first name. |
last_nameString |
[Deprecated] The user’s last name. |
|
This user’s email address. |
guidString [ user_guid ] |
This user’s unique identifier. |
- May 20, 2020: Version 2 is available.
Feedback
0 comments
Please sign in to leave a comment.