Publication Date – April 30, 2020
https://api.bitsighttech.com/ratings/v1/access-groups/group_guid
Edit an existing Access Control Group.
Parameters
*Required.
Parameter | Description | Values |
---|---|---|
all_companiesBody |
Allow the selected group to access all companies in the Bitsight inventory. | [Boolean] true = Include all companies. |
allow_bundled_companiesBody |
Provide the users in the selected group visibility into companies that are bundled with their group’s subscribed companies (rating bundles), even if they are not directly subscribed to that company. | [Boolean] true = Include rating bundles. |
can_set_tier_scopeBody |
Allow this group to set group tiers. | [Boolean]
|
group_guidPath |
The group to edit. | [String] Group unique identifier [group_guid ]. See GET: Access Control Groups. |
is_defaultBody |
Assign this as the new default group. New users are automatically added to the default group. | [Boolean] true = Assign this group as the default. |
nameBody |
The name to assign to your group. | [String] |
subscription_typesBody |
Change the allocated subscriptions per subscription type. | [Object] See subscription types. |
Example Request
This is an example body of the JSON data sent in the “data” field of a request:
curl 'https://api.bitsighttech.com/ratings/v1/access-groups/group_guid' -u <a" href="/hc/en-us/articles/115014888388-API-Token-Management" class="dynamic" rel="noopener" target="_blank">api_token -X PATCH -H 'Accept: application/json' -H 'Content-Type: application/json' --data-binary '{"is_default": "boolean","name": "string","subscription_types": {subscription_types}}' --compressed</a">
Errors and Status Codes
See the common errors and status codes.
Code | Description |
---|---|
200 – Okay |
Everything worked as expected. |