Thank youHashiConf Europe is a wrap. Watch this year’s sessions on-demand. Watch Now

Boundary Controller HTTP API

Managed Group Service

List Managed Groups
GET /v1/managed-groups
Expand

Lists all ManagedGroups in a specific Auth Method.

Request

Query Parameters

auth_method_id string
filter string

Response

Successful Response

items object[]

ManagedGroup contains all fields related to an ManagedGroup resource

id string

Output only. The ID of the ManagedGroup.

scope object

Output only. Scope information for the ManagedGroup.

id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

name string

Optional name for identification purposes.

description string

Optional user-set description for identification purposes.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

version integer

Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

type string

The type of this ManagedGroup.

auth_method_id string

The ID of the Auth Method that is associated with this ManagedGroup.

attributes object

The attributes that are applicable for the specific ManagedGroup type.

member_ids string[]
authorized_actions string[]
Create Managed Group
POST /v1/managed-groups
Expand

Creates a single ManagedGroup in the provided Auth Method.

Request

Body Parameters

name string

Optional name for identification purposes.

description string

Optional user-set description for identification purposes.

version integer

Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

type string

The type of this ManagedGroup.

auth_method_id string

The ID of the Auth Method that is associated with this ManagedGroup.

attributes object

The attributes that are applicable for the specific ManagedGroup type.

Response

Successful Response

id string

Output only. The ID of the ManagedGroup.

scope object

Output only. Scope information for the ManagedGroup.

id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

name string

Optional name for identification purposes.

description string

Optional user-set description for identification purposes.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

version integer

Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

type string

The type of this ManagedGroup.

auth_method_id string

The ID of the Auth Method that is associated with this ManagedGroup.

attributes object

The attributes that are applicable for the specific ManagedGroup type.

member_ids string[]
authorized_actions string[]
Get Managed Group
GET /v1/managed-groups/{id}
Expand

Gets a single ManagedGroup.

Request

Path Parameters

id string Required

Response

Successful Response

id string

Output only. The ID of the ManagedGroup.

scope object

Output only. Scope information for the ManagedGroup.

id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

name string

Optional name for identification purposes.

description string

Optional user-set description for identification purposes.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

version integer

Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

type string

The type of this ManagedGroup.

auth_method_id string

The ID of the Auth Method that is associated with this ManagedGroup.

attributes object

The attributes that are applicable for the specific ManagedGroup type.

member_ids string[]
authorized_actions string[]
Delete Managed Group
DELETE /v1/managed-groups/{id}
Expand

Deletes a ManagedGroup.

Request

Path Parameters

id string Required

Response

Successful Response

No content.
Update Managed Group
PATCH /v1/managed-groups/{id}
Expand

Updates a ManagedGroup.

Request

Path Parameters

id string Required

Query Parameters

update_mask string

Body Parameters

name string

Optional name for identification purposes.

description string

Optional user-set description for identification purposes.

version integer

Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

type string

The type of this ManagedGroup.

auth_method_id string

The ID of the Auth Method that is associated with this ManagedGroup.

attributes object

The attributes that are applicable for the specific ManagedGroup type.

Response

Successful Response

id string

Output only. The ID of the ManagedGroup.

scope object

Output only. Scope information for the ManagedGroup.

id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

name string

Optional name for identification purposes.

description string

Optional user-set description for identification purposes.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

version integer

Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

type string

The type of this ManagedGroup.

auth_method_id string

The ID of the Auth Method that is associated with this ManagedGroup.

attributes object

The attributes that are applicable for the specific ManagedGroup type.

member_ids string[]
authorized_actions string[]