- August 25, 2021: Added
landing_page
,preferred_contact_for_entities
, &mfa_status
fields. - May 26, 2020: Published.
https://api.bitsighttech.com/ratings/v2/users
Get the users within your Bitsight account.
Parameters
See query parameters for details on the following parameters:
limit
(Default:100
)offset
(Default100
)q
– See response attributes.sort
Parameter | Description | Values |
---|---|---|
|
Filter by the user’s email address. | [String] |
email_qQuery |
Search by the user’s email address. | [String] |
formal_name_qQuery |
Search by the user’s full name. | [String] |
group.guidQuery |
Filter the Access Control Group of the user. | [Array] Comma-separated group unique identifiers [group_guid ]. See GET: Access Control Groups. |
guidQuery |
Filter by a specific user. | [String] User unique identifier [user_guid ]. |
is_available_for_contactQuery |
Filter by Admin, Group Admin, or Portfolio Admin users that have been assigned as a point-of-contact when other users request to add companies to the portfolio. | [Boolean] true = Include users that have been assigned as a point-of-contact for subscription requests. |
is_company_api_tokenQuery |
Filter by actual users or user accounts for the company API token. | [Boolean] true = Include user accounts that are company API tokens. |
roles.slugQuery |
Filter by user role. | [Array] Comma-separated user role slug name. See user roles. |
statusQuery |
Filter by user account status. | [Array] Comma-separated user account status.
|
Example Request
curl 'https://api.bitsighttech.com/ratings/v2/users' -u api_token:
Example Response
{ "links":{ "next":"https://api.bitsighttech.com/ratings/v2/users?limit=100&offset=200", "previous":"https://api.bitsighttech.com/ratings/v2/users?limit=100" }, "count":123, "results":[ { "guid":"33333333-dddd-3333-dddd-dddddddddddd", "friendly_name":"Diane Jones", "formal_name":"Diane Jones", "email":"diane@actorsfilms.us", "group":{ "guid":"dddddddd-3333-dddd-3333-dddddddddddd", "name":"Central Pacific" }, "landing_page":"DEFAULT", "status":"Activated", "last_login_time":"2021-01-29T20:44:53.879238Z", "joined_time":"2020-07-16T21:11:23Z", "roles":[ { "name":"Admin", "slug":"customer_admin" } ], "is_available_for_contact":false, "is_company_api_token":false, "features":[ { "slug":"wfh-ro", "value":true, "can_update":false } ], "preferred_contact_for_entities":[ "1b3d260c-9e23-4e19-b3a5-a0bcf67d74d9" ], "mfa_status":"not_enabled" } ] }
Response Attributes
Field | Description | ||||
---|---|---|---|---|---|
linksObject |
Navigation for multiple pages of results. See pagination. | ||||
nextString |
The URL for navigating to the next page of results. | ||||
previousString |
The URL for navigating to the previous page of results. | ||||
countInteger |
The number of users. | ||||
resultsArray |
User details. | ||||
Object | A user. | ||||
guidString [ user_guid ] |
The unique identifier of this user. | ||||
friendly_nameString |
The preferred name of this user. | ||||
formal_nameString |
The full name of this user. | ||||
|
The email address of this user. | ||||
groupObject |
Access Control Group details of this user. | ||||
guidString [ group_guid ] |
The unique identifier of this group. | ||||
nameString |
The name of this group. | ||||
landing_pageString |
The landing page set by this user when first logging in to the Bitsight platform. Switching to an application negates this configuration.
Values: |
||||
statusString |
The account status of this user. | ||||
last_login_timeString [ YYYY‑MM‑DDTHH:MM:SSZ ] |
The date and time when this user last logged in to the Bitsight platform. | ||||
joined_timeString [ YYYY‑MM‑DDTHH:MM:SSZ ] |
The date and time when this user was added to the Bitsight platform. | ||||
rolesArray |
The roles of this user. See user roles. | ||||
Object | A user role. | ||||
nameString |
The name of this role. | ||||
slugString |
The slug name of this role. | ||||
is_available_for_contactBoolean |
true = This user is an Admin, Group Admin, or Portfolio Manager who has been assigned as a point-of-contact when other users request to add companies to the portfolio. |
||||
is_company_api_tokenBoolean |
true = This user account is a company API token and is not an actual user. |
||||
featuresArray |
User-managed feature details of this user. See features. | ||||
Object | A feature. | ||||
slugString |
The slug name of this feature. | ||||
valueBoolean |
true = This feature is enabled for this user. |
||||
can_updateBoolean |
true = This user can manage settings for this feature. |
||||
preferred_contact_for_entitiesArray [ entity_guid ] |
Companies where this user is their preferred contact. | ||||
mfa_statusString |
The multi-factor or 2-factor authentication (2FA) status of this user. Values: |