Security Performance Management
Continuous Monitoring
Cyber Insurance
National Cybersecurity

Articles in this section

POST: Create an Access Control Group

Avatar
Ingrid
Follow
  • December 14, 2020: Added all_companies, allow_bundled_companies, can_set_tier_scope, total_allocated_quota, and total_available_quota parameters.
  • January 28, 2020: Published.

⇤ Access Groups

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

Create a new Access Control Group.

Parameters

*Required.

Parameter Description Values 
name
Body		 Assign the group a name. [String] The name. 
groups
Body		 Edit the group. [Array]
  
all_companies
Body		 Enable group access to all companies in your portfolio. [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. [Boolean] true = Assign the group as the new default group. 
allow_bundled_companies
Body		 Enable group access to all companies in rating bundles. [Boolean] true = The group has access to rating bundles. 
can_set_tier_scope
Body		 Allow the group to set company details (tiers, life cycles, and relationships), with or apart from the global organization. [Boolean]
  • true = Company details are assigned by the group.
  • false = Company details are assigned globally.
 
subscription_types
Body		 Allocate subscriptions per subscription type. [Object] See subscription types.
  Subscription Type
Body		 Set your desired flexibility for Group Admins and Portfolio Managers to manage the companies in the group. [String] Subscription slug name. See subscription types.
  
total_allocated_quota
Body		 Provide limited access to this allocated number of subscriptions. [Integer] 
total_available_quota
Body		 Provide shared access only to existing companies in your portfolio, with no additional subscriptions. [Integer]

Example Request

cURL:

curl -X POST --data-ascii '{
  "name":"This Group",
  "groups":[
    {
      "all_companies":false,
      "is_default":false,
      "allow_bundled_companies":true,
      "can_set_tier_scope":false,
      "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:

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

Status Codes

See the common errors and status codes.

201

Related articles