GET: Access Control Groups

Ingrid

https://api.bitsighttech.com/ratings/v1/access-groups

See your organization’s Access Control Groups and the default group.

Example Request

curl https://api.bitsighttech.com/ratings/v1/access-groups -u api_token:

Example Response

{
  "groups":[
    […]
    {
      "guid":"eeeeeeee-8888-eeee-8888-eeeeeeeeeeee",
      "name":"My Group"
    }
  ],
  "default_group":"aaaaaaaa-1212-1212-aaaa-121212121212"
}

Response Attributes

Field		Description
groups Object		Your organization’s groups.
	guid String [`group_guid`]	The unique identifier of this group.
	name String	The name assigned to this group.
	user_count Integer	The number of users assigned to this group.
	company_count Integer	The number of companies for this group.
	all_companies Boolean	`true` = The current default group is the “All Companies” folder. New users are automatically added to the default group.
	is_default Boolean	`true` = The current group is the default group. New users are automatically added to the default group.
	subscription_types Object	Contains a list of subscriptions types and their details, including the number of allocated subscriptions and available quota.
default_group String		Your organization’s default group. This is the “All Companies” folder by default.

January 28, 2020: Published.