Security Performance Management
Continuous Monitoring
Cyber Insurance
National Cybersecurity

Articles in this section

See more

GET: Users [v1]

Avatar
Ingrid
Follow
  • May 20, 2020: Version 2 is now available.

⇤ Users

https://api.bitsighttech.com/ratings/v1/users

Get a list of all the users within your account.

Version 2 is now available.

Parameters

Parameter Description Values 
include_details
Query		 Include extra user details. [Boolean] Default: false 
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		 [String] Include only the users who can view the specified company. If null (empty), users are not filtered in this manner. Default: null

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_name
String		 This user’s preferred name. 
formal_name
String		 This user’s full name. 
first_name
String		 [Deprecated] The user’s first name. 
last_name
String		 [Deprecated] The user’s last name. 
email
String		 This user’s email address. 
guid
String [user_guid]		 This user’s unique identifier.

Related articles