Publication Date – January 28, 2020
https://api.bitsighttech.com/ratings/v1/access-groups/group_guid
Get details of a particular Access Control Group, including companies for the group, the total and allocated subscription quota, users in the group, and the default group.
Parameters
* Required.
Parameter | Values |
---|---|
group_guid * [Path] Identify the Access Control Group to query. |
[String] Access Control Group unique identifier [group_guid ]. See GET: Access Control Groups. |
Example Request
curl https://api.bitsighttech.com/ratings/v1/access-groups/77777777-cccc-4444-bbbb-222222222222 -u api_token:
Example Response
{ "guid":"77777777-cccc-4444-bbbb-222222222222", "name":"My Group", "company_count":3, "subscription_types":{ "continuous_monitoring":{ "total_allocated_quota":null, "total_available_quota":123 } }, "user_count":5, "all_companies":false, "is_default":false }
Response Attributes
Field | Description | ||
---|---|---|---|
guidString [ group_guid ] |
The unique identifier of this group. | ||
nameString |
The name of this group. | ||
company_countInteger |
The number of companies in this group. | ||
subscription_typesObject |
The available subscriptions for this group. | ||
Subscription Type Object |
The name of this subscription type. | ||
total_allocated_quotaInteger |
The number of used subscriptions. | ||
total_available_quotaInteger |
The remaining number of subscriptions. | ||
user_countInteger |
The number of users in this group. | ||
all_companiesBoolean |
true = The current default group is the “All Companies” folder. New users are automatically added to the default group. |
||
is_defaultBoolean |
true = The current group is the default group. New users are automatically added to the default group. |
Feedback
0 comments
Please sign in to leave a comment.