PATCH: Edit Access Control Group

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

Edit an existing Access Control Group.

Parameters

* Required.

all_companies

[Body] Allow the selected group to access all companies in the Bitsight inventory.

Value: [Boolean] true = Include all companies.

allow_bundled_companies

[Body] 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.

Value: [Boolean] true = Include rating bundles.

can_set_tier_scope

[Body] Allow this group to set group tiers.

Value: [Boolean]

• true = Use group tiers with tiers that are specific to this group.
• false = Use the global tier that’s used by all companies in your organization and all users.

group_guid

* Required.

[Path] Identify the group to edit.

Value: [String] Group unique identifier [group_guid]. See GET: Access Control Groups.

is_default

[Body] Assign this as the new default group. New users are automatically added to the default group.

Value: [Boolean] true = Assign this group as the default.

name

[Body] Assign a name for your group.

Value: [String]

subscription_types

[Body] Change the allocated subscriptions per subscription type.

Value: [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/66e3842c-11b1-4ca4-9426-0c93609a4ddc' -u api_token -X PATCH -H 'Accept: application/json' -H 'Content-Type: application/json' --data-binary '{"is_default": "true","name": "My Group","subscription_types": {continuous_monitoring}}' --compressed

Errors and Status Codes

See the common errors and status codes.

200 – Okay

Everything worked as expected.