Boundary controller HTTP API

Group Service

List GroupsGET/v1/groups

Lists all Groups.

Query Parameters

scope_id string

recursive boolean

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[]

Group contains all fields related to a Group resource

id string

Output only. The ID of the Group.

scope_id string

The ID of the scope of which this Group is a part.

scope object

Output only. Scope information for this Group.

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

member_ids string[]

members object[]

id string

Output only. The ID of the member.

scope_id string

Output only. The Scope ID of the member.

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 GroupPOST/v1/groups

Creates a single Group.

Body Parameters

scope_id string

The ID of the scope of which this Group is a part.

name string

Optional name for identification purposes.

description string

Optional user-set descripton 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.

Successful Response

id string

Output only. The ID of the Group.

scope_id string

The ID of the scope of which this Group is a part.

scope object

Output only. Scope information for this Group.

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

member_ids string[]

members object[]

id string

Output only. The ID of the member.

scope_id string

Output only. The Scope ID of the member.

authorized_actions string[]

Get GroupGET/v1/groups/{id}

Gets a single Group.

Path Parameters

id string

Successful Response

id string

Output only. The ID of the Group.

scope_id string

The ID of the scope of which this Group is a part.

scope object

Output only. Scope information for this Group.

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

member_ids string[]

members object[]

id string

Output only. The ID of the member.

scope_id string

Output only. The Scope ID of the member.

authorized_actions string[]

Delete GroupDELETE/v1/groups/{id}

Deletes a Group.

Path Parameters

id string

Update GroupPATCH/v1/groups/{id}

Updates a Group.

Path Parameters

id string

Body Parameters

scope_id string

The ID of the scope of which this Group is a part.

name string

Optional name for identification purposes.

description string

Optional user-set descripton 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.

Successful Response

id string

Output only. The ID of the Group.

scope_id string

The ID of the scope of which this Group is a part.

scope object

Output only. Scope information for this Group.

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

member_ids string[]

members object[]

id string

Output only. The ID of the member.

scope_id string

Output only. The Scope ID of the member.

authorized_actions string[]

Add Group MembersPOST/v1/groups/{id}:add-members

Adds members to a Group.

Path Parameters

id string

Body Parameters

version integer

Version is used to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

member_ids string[]

Successful Response

id string

Output only. The ID of the Group.

scope_id string

The ID of the scope of which this Group is a part.

scope object

Output only. Scope information for this Group.

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

member_ids string[]

members object[]

id string

Output only. The ID of the member.

scope_id string

Output only. The Scope ID of the member.

authorized_actions string[]

Remove Group MembersPOST/v1/groups/{id}:remove-members

Removes the specified members from a Group.

Path Parameters

id string

Body Parameters

version integer

Version is used to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

member_ids string[]

Successful Response

id string

Output only. The ID of the Group.

scope_id string

The ID of the scope of which this Group is a part.

scope object

Output only. Scope information for this Group.

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

member_ids string[]

members object[]

id string

Output only. The ID of the member.

scope_id string

Output only. The Scope ID of the member.

authorized_actions string[]

Set Group MembersPOST/v1/groups/{id}:set-members

Set a Group's members to exactly the list of provided in the request, removing any members that are not specified.

Path Parameters

id string

Body Parameters

version integer

Version is used to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

member_ids string[]

Successful Response

id string

Output only. The ID of the Group.

scope_id string

The ID of the scope of which this Group is a part.

scope object

Output only. Scope information for this Group.

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

member_ids string[]

members object[]

id string

Output only. The ID of the member.

scope_id string

Output only. The Scope ID of the member.

authorized_actions string[]