Resource groups

An Okta Privileged Access resource group is a collection of projects.

See Resource groups.

List all resource groups
Admin roles: resource_admindelegated_resource_admin

Lists all resource groups available to the requesting user

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
Admin roles: resource_admin

Creates a resource group for your team. To assign the delegated_resource_admin role, specify an existing group in the delegated_resource_admin_groups parameter.

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 Okta Privileged Access groups that own this resource group. This parameter 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
Admin roles: resource_admindelegated_resource_admin

Retrieves the specified resource group

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
Admin roles: resource_admindelegated_resource_admin

Updates the specified resource group. To assign the delegated_resource_admin role, specify an existing group in the delegated_resource_admin_groups parameter.

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 Okta Privileged Access groups that own this resource group. This parameter 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
Admin roles: resource_admin

Deletes the specified resource group

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