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

Boundary Controller HTTP API

Credential Store Service

List Credential Stores
GET /v1/credential-stores
Expand

Lists all Credential Stores.

Request

Query Parameters

scope_id string
recursive boolean
filter string

Response

Successful Response

items object[]

CredentialStore contains all fields related to an Credential Store resource

id string

Output only. The ID of the Credential Store.

scope_id string

The ID of the Scope of which this Credential Store is a part.

scope object

Output only. Scope information for this Credential Store.

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 Credential Store type.

attributes object

The attributes that are applicable for the specific Credential Store type.

authorized_actions string[]
authorized_collection_actions object

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

Create Credential Store
POST /v1/credential-stores
Expand

Creates a single Credential Store.

Request

Body Parameters

scope_id string

The ID of the Scope of which this Credential Store is a part.

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 Credential Store type.

attributes object

The attributes that are applicable for the specific Credential Store type.

Response

Successful Response

id string

Output only. The ID of the Credential Store.

scope_id string

The ID of the Scope of which this Credential Store is a part.

scope object

Output only. Scope information for this Credential Store.

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 Credential Store type.

attributes object

The attributes that are applicable for the specific Credential Store type.

authorized_actions string[]
authorized_collection_actions object

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

Get Credential Store
GET /v1/credential-stores/{id}
Expand

Gets a single Credential Store.

Request

Path Parameters

id string Required

Response

Successful Response

id string

Output only. The ID of the Credential Store.

scope_id string

The ID of the Scope of which this Credential Store is a part.

scope object

Output only. Scope information for this Credential Store.

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 Credential Store type.

attributes object

The attributes that are applicable for the specific Credential Store type.

authorized_actions string[]
authorized_collection_actions object

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

Delete Credential Store
DELETE /v1/credential-stores/{id}
Expand

Deletes a CredentialStore

Request

Path Parameters

id string Required

Response

Successful Response

No content.
Update Credential Store
PATCH /v1/credential-stores/{id}
Expand

Updates a Credential Store.

Request

Path Parameters

id string Required

Query Parameters

update_mask string

Body Parameters

scope_id string

The ID of the Scope of which this Credential Store is a part.

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 Credential Store type.

attributes object

The attributes that are applicable for the specific Credential Store type.

Response

Successful Response

id string

Output only. The ID of the Credential Store.

scope_id string

The ID of the Scope of which this Credential Store is a part.

scope object

Output only. Scope information for this Credential Store.

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 Credential Store type.

attributes object

The attributes that are applicable for the specific Credential Store type.

authorized_actions string[]
authorized_collection_actions object

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