POST: Create an Access Control Group

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

Create a new Access Control Group.

Parameters

* Required.

name

* Required.

[Body] Assign the group a name.

Value: [String] The name.

can_set_tier_scope

[Body] Allow the group to set company details (tiers, life cycles, and relationships), with or apart from the global organization.

Value: [Boolean]

• true = Company details are assigned by the group.
• false = Company details are assigned globally.

groups

[Body] Edit the group.

Value: [Array]

all_companies

[Body] Set the group's access to all companies in your portfolio.

Value: [Boolean] true = The group has access to all companies in your portfolio.

is_default

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

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

allow_bundled_companies

[Body] Enable group access to all companies in rating bundles.

Value: [Boolean] true = The group has access to rating bundles.

subscription_types

[Body] Allocate subscriptions per subscription type.

Value: [Object] See subscription types.

Subscription Type

[Body] Set your desired flexibility for Group Admins and Portfolio Managers to manage the companies in the group.

Value: [String] Subscription slug name.

total_allocated_quota

[Body] Provide limited access to this allocated number of subscriptions.

Value: [Integer]

total_available_quota

[Body] Provide shared access only to existing companies in your portfolio, with no additional subscriptions.

Value: [Integer]

Example Request

cURL Example

curl -X POST --data-ascii '{
  "name":"This Group",
  "can_set_tier_scope":false,
  "groups":[
    {
      "all_companies":false,
      "is_default":false,
      "allow_bundled_companies":true,
      "subscription_types":{
        "continuous_monitoring":{
          "total_allocated_quota":2,
          "total_available_quota":0
        }
      }
    }
  ]
}' https://api.bitsighttech.com/ratings/v1/access-groups -u api_token: --header "Content-Type:application/json"

JSON Example

{
  "name":"This Group",
  "can_set_tier_scope":false,
  "groups":[
    {
      "all_companies":false,
      "is_default":false,
      "allow_bundled_companies":true,
      "subscription_types":{
        "continuous_monitoring":{
          "total_allocated_quota":2,
          "total_available_quota":0
        }
      }
    }
  ]
}

Status Codes

See the common errors and status codes.

201