Boundary Controller HTTP API

Group Service

List GroupsGET/v1/groups

Lists all Groups.

Query Parameters

scope_id string

recursive boolean

filter string

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

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

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

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

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

Query Parameters

update_mask 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

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

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

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

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