GET: User Details

Ingrid

https://api.bitsighttech.com/ratings/v2/users/user_guid

Get details about a particular user.

Parameters

* Required.

user_guid

* Required.

[Path] Identify the user to query.

Value: [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
guid String [`user_guid`]		The unique identifier of this user.
friendly_name String		The preferred name of this user.
formal_name String		The full name of this user.
email String		The email address of this user. This is also used as part of their Bitsight platform login credentials.
group Object		The Access Control Group of this user.
	guid String [`group_guid`]	The unique identifier of this group.
	name String	The name of this group.
status String		The account status of this user.
last_login_time String [`YYYY‑MM‑DDTHH:MM:SSZ`]		The date and time when this user last logged in to the Bitsight platform.
joined_time String [`YYYY‑MM‑DDTHH:MM:SSZ`]		The date and time when this user was added to the Bitsight platform.
roles Array		The user role details of this user. See user roles.
	name String	The name of this user role.
	slug String	The slug name of this user role.
is_available_for_contact Boolean		`true` = This user has been assigned as a point-of-contact when other users request to add companies to the portfolio.
is_company_api_token Boolean		`true` = This user account is a company API token and is not an actual user.
features Array		User-managed feature details of this user.
	slug String	The slug name of this feature.
	value String or Boolean	Can be a `string` or a `boolean` value as appropriate for the feature.
	can_update Boolean	`true` = This user can manage settings for this feature.

May 20, 2020: Published.