https://api.bitsighttech.com/ratings/v2/users/user_guid
Get details about a particular user.
Parameters
* Required.
Parameter | Values |
---|---|
user_guid * [Path] Identify the user to query. |
[String] User unique identifier [user_guid ]. See Get: Users. |
Example Request
curl 'https://api.bitsighttech.com/ratings/v2/users/11111111-aaaa-1111-aaaa-111111111111' -u api_token:
Example Response
{ "guid":"11111111-aaaa-1111-aaaa-111111111111", "friendly_name":"Arnold", "formal_name":"Arnold Brown", "email":"arnold@actorsfilms.us", "group":{ "guid":"aaaaaaaa-1111-aaaa-1111-aaaaaaaaaaaa", "name":"Analytics Team" }, "status":"Activated", "last_login_time":"2020-05-18T17:57:54.400803Z", "joined_time":"2020-02-02T20:20:20Z", "roles":[ { "name":"Group Admin", " slug":"customer_group_admin" } ], "is_available_for_contact":false, "is_company_api_token":false, "features":[ { "slug":"wfh-ro", "value":true, "can_update":false } ] }
Response Attributes
Field | Description | |
---|---|---|
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. This is also used as part of their Bitsight platform login credentials. | |
groupObject |
The Access Control Group of this user. | |
guidString [ group_guid ] |
The unique identifier of this group. | |
nameString |
The name of this group. | |
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 user role details of this user. See user roles. | |
nameString |
The name of this user role. | |
slugString |
The slug name of this user role. | |
is_available_for_contactBoolean |
true = This user 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. | |
slugString |
The slug name of this feature. | |
valueString or Boolean |
Can be a string or a boolean value as appropriate for the feature. |
|
can_updateBoolean |
true = This user can manage settings for this feature. |
- May 20, 2020: Published.
Feedback
0 comments
Please sign in to leave a comment.