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

Boundary Controller HTTP API

Scope Service

List Scopes
GET /v1/scopes
Expand

Lists all Scopes within the Scope provided in the request.

Request

Query Parameters

scope_id string
recursive boolean
filter string

Response

Successful Response

items object[]

Scope contains all fields related to a Scope resource

id string

Output only. The ID of the Scope.

scope_id string

The ID of the Scope this resource is in. If this is the "global" Scope this field will be empty.

scope object

Output only. Scope information for this resource.

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.

type string

The type of the resource.

primary_auth_method_id string

The ID of the primary auth method for this scope. A primary auth method is allowed to vivify users when new accounts are created and is the source for the users account info

authorized_actions string[]
authorized_collection_actions object

Output only. The authorized actions for the scope's collections.

Create Scope
POST /v1/scopes
Expand

Creates a single Scope.

Request

Query Parameters

skip_admin_role_creation boolean
skip_default_role_creation boolean

Body Parameters

scope_id string

The ID of the Scope this resource is in. If this is the "global" Scope this field will be empty.

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.

type string

The type of the resource.

primary_auth_method_id string

The ID of the primary auth method for this scope. A primary auth method is allowed to vivify users when new accounts are created and is the source for the users account info

Response

Successful Response

id string

Output only. The ID of the Scope.

scope_id string

The ID of the Scope this resource is in. If this is the "global" Scope this field will be empty.

scope object

Output only. Scope information for this resource.

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.

type string

The type of the resource.

primary_auth_method_id string

The ID of the primary auth method for this scope. A primary auth method is allowed to vivify users when new accounts are created and is the source for the users account info

authorized_actions string[]
authorized_collection_actions object

Output only. The authorized actions for the scope's collections.

Get Scope
GET /v1/scopes/{id}
Expand

Gets a single Scope.

Request

Path Parameters

id string Required

Response

Successful Response

id string

Output only. The ID of the Scope.

scope_id string

The ID of the Scope this resource is in. If this is the "global" Scope this field will be empty.

scope object

Output only. Scope information for this resource.

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.

type string

The type of the resource.

primary_auth_method_id string

The ID of the primary auth method for this scope. A primary auth method is allowed to vivify users when new accounts are created and is the source for the users account info

authorized_actions string[]
authorized_collection_actions object

Output only. The authorized actions for the scope's collections.

Delete Scope
DELETE /v1/scopes/{id}
Expand

Deletes a Scope.

Request

Path Parameters

id string Required

Response

Successful Response

No content.
Update Scope
PATCH /v1/scopes/{id}
Expand

Updates a Scope.

Request

Path Parameters

id string Required

Query Parameters

update_mask string

Body Parameters

scope_id string

The ID of the Scope this resource is in. If this is the "global" Scope this field will be empty.

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.

type string

The type of the resource.

primary_auth_method_id string

The ID of the primary auth method for this scope. A primary auth method is allowed to vivify users when new accounts are created and is the source for the users account info

Response

Successful Response

id string

Output only. The ID of the Scope.

scope_id string

The ID of the Scope this resource is in. If this is the "global" Scope this field will be empty.

scope object

Output only. Scope information for this resource.

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.

type string

The type of the resource.

primary_auth_method_id string

The ID of the primary auth method for this scope. A primary auth method is allowed to vivify users when new accounts are created and is the source for the users account info

authorized_actions string[]
authorized_collection_actions object

Output only. The authorized actions for the scope's collections.