Resource Groups

An OPA Resource Group is a collection of Projects.

See Resource groups.

List all Resource Groups

Lists all Resource Groups available to the requesting User

This endpoint requires one of the following roles: resource_admin, delegated_resource_admin.

SecuritybearerAuth
Request
path Parameters
team_name
required
string

The name of your Team

Responses
200

OK

get/v1/teams/{team_name}/resource_groups
Request samples 
Response samples 
application/json
{
  • "list": [
    • {
      },
    • {
      }
    ]
}
Create a Resource Group
Creates a Resource Group for your Team. To assign the delegated_resource_admin role, specify an existing Group in the delegated_resource_admin_groups param.


This endpoint requires the following role: resource_admin.


SecuritybearerAuth 
Request 
path Parameters
team_name
required
string
The name of your Team


 
Request Body schema: application/json
Array of objects (NamedObject) 
An array of OPA groups that own this Resource Group. This param is only available to users with the resource_admin role.


 
 Array 
id
string
The UUID of the object


 
missing
boolean
Boolean value determining if the named object with the given id is valid or not.


 
description
string
A description of the Resource Group


 
name
string
The name of the Resource Group


 
Responses 
201
Created


post/v1/teams/{team_name}/resource_groups
Request samples 
application/json
{
  • "delegated_resource_admin_groups": [
    • {
      }
    ],
  • "description": "string",
  • "name": "string"
}
Response samples 
application/json
{
  • "delegated_resource_admin_groups": [
    • {
      }
    ],
  • "description": "string",
  • "id": "string",
  • "name": "string",
  • "team_id": "string"
}
Retrieve a Resource Group
Retrieves the specified Resource Group


This endpoint requires one of the following roles: resource_admin, delegated_resource_admin.


SecuritybearerAuth 
Request 
path Parameters
team_name
required
string
The name of your Team


 
resource_group_id
required
string
The UUID of a Resource Group


 
Responses 
200
OK


get/v1/teams/{team_name}/resource_groups/{resource_group_id}
Request samples 
Response samples 
application/json
{
  • "delegated_resource_admin_groups": [
    • {
      }
    ],
  • "description": "string",
  • "id": "string",
  • "name": "string",
  • "team_id": "string"
}
Update a Resource Group
Updates the specified Resource Group. To assign the delegated_resource_admin role, specify an existing Group in the delegated_resource_admin_groups param.


This endpoint requires one of the following roles: resource_admin, delegated_resource_admin.


SecuritybearerAuth 
Request 
path Parameters
team_name
required
string
The name of your Team


 
resource_group_id
required
string
The UUID of a Resource Group


 
Request Body schema: application/json
Array of objects (NamedObject) 
An array of OPA groups that own this Resource Group. This param is only available to users with the resource_admin role.


 
 Array 
id
string
The UUID of the object


 
missing
boolean
Boolean value determining if the named object with the given id is valid or not.


 
description
string
A description of the Resource Group


 
name
string
The name of the Resource Group


 
Responses 
200
OK


put/v1/teams/{team_name}/resource_groups/{resource_group_id}
Request samples 
application/json
{
  • "delegated_resource_admin_groups": [
    • {
      }
    ],
  • "description": "string",
  • "name": "string"
}
Response samples 
application/json
{
  • "delegated_resource_admin_groups": [
    • {
      }
    ],
  • "description": "string",
  • "id": "string",
  • "name": "string",
  • "team_id": "string"
}
Delete a Resource Group
Deletes the specified Resource Group


This endpoint requires the following role: resource_admin.


SecuritybearerAuth 
Request 
path Parameters
team_name
required
string
The name of your Team


 
resource_group_id
required
string
The UUID of a Resource Group


 
Responses 
204
No Content


delete/v1/teams/{team_name}/resource_groups/{resource_group_id}
Request samples