Boundary controller HTTP API

Managed Group Service

List Managed GroupsGET/v1/managed-groups

Lists all ManagedGroups in a specific Auth Method.

Query Parameters

auth_method_id string

filter string

You can specify that the filter should only return items that match. Refer to filter expressions for more information.

list_token string

An opaque token that Boundary uses to continue an existing iteration or request updated items. If you do not specify a token, pagination starts from the beginning. To learn more about list pagination in Boundary, refer to list pagination.

page_size integer

The maximum size of a page in this iteration. If unset, the default page size configured will be used. If the page_size is greater than the default page configured, the page size will be truncated to this number..

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

The ID of the scope.

type string

The type of the scope.

name string

The name of the scope, if any.

description string

The description of the scope, if any.

parent_scope_id string

The ID of the parent scope, if any. This field is empty if it 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[]

response_type string

The type of response, either "delta" or "complete". Delta signifies that this is part of a paginated result or an update to a previously completed pagination. Complete signifies that it is the last page.

list_token string

An opaque token used to continue an existing pagination or request updated items. Use this token in the next list request to request the next page.

sort_by string

The name of the field which the items are sorted by.

sort_dir string

The direction of the sort, either "asc" or "desc".

removed_ids string[]

est_item_count integer

An estimate at the total items available. This may change during pagination.

Create Managed GroupPOST/v1/managed-groups

Creates a single ManagedGroup in the provided Auth Method.

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.

Successful Response

id string

Output only. The ID of the ManagedGroup.

scope object

Output only. Scope information for the ManagedGroup.

id string

The ID of the scope.

type string

The type of the scope.

name string

The name of the scope, if any.

description string

The description of the scope, if any.

parent_scope_id string

The ID of the parent scope, if any. This field is empty if it 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 GroupGET/v1/managed-groups/{id}

Gets a single ManagedGroup.

Path Parameters

id string

Successful Response

id string

Output only. The ID of the ManagedGroup.

scope object

Output only. Scope information for the ManagedGroup.

id string

The ID of the scope.

type string

The type of the scope.

name string

The name of the scope, if any.

description string

The description of the scope, if any.

parent_scope_id string

The ID of the parent scope, if any. This field is empty if it 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 GroupDELETE/v1/managed-groups/{id}

Deletes a ManagedGroup.

Path Parameters

id string

Update Managed GroupPATCH/v1/managed-groups/{id}

Updates a ManagedGroup.

Path Parameters

id 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.

Successful Response

id string

Output only. The ID of the ManagedGroup.

scope object

Output only. Scope information for the ManagedGroup.

id string

The ID of the scope.

type string

The type of the scope.

name string

The name of the scope, if any.

description string

The description of the scope, if any.

parent_scope_id string

The ID of the parent scope, if any. This field is empty if it 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[]