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

Boundary Controller HTTP API

Credential Library Service

List Credential Libraries
GET /v1/credential-libraries
Expand

Lists all Credential Library.

Request

Query Parameters

credential_store_id string
filter string

Response

Successful Response

items object[]

CredentialLibrary contains all fields related to an Credential Library resource

id string

Output only. The ID of the Credential Library.

credential_store_id string

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

scope object

Output only. Scope information for this Credential Library.

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 Library type.

attributes object

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

authorized_actions string[]
Create Credential Library
POST /v1/credential-libraries
Expand

Creates a single Credential Library.

Request

Body Parameters

credential_store_id string

The ID of the Credential Store of which this Credential Library 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 Library type.

attributes object

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

Response

Successful Response

id string

Output only. The ID of the Credential Library.

credential_store_id string

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

scope object

Output only. Scope information for this Credential Library.

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 Library type.

attributes object

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

authorized_actions string[]
Get Credential Library
GET /v1/credential-libraries/{id}
Expand

Gets a single Credential Library.

Request

Path Parameters

id string Required

Response

Successful Response

id string

Output only. The ID of the Credential Library.

credential_store_id string

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

scope object

Output only. Scope information for this Credential Library.

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 Library type.

attributes object

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

authorized_actions string[]
Delete Credential Library
DELETE /v1/credential-libraries/{id}
Expand

Deletes a Credential Library

Request

Path Parameters

id string Required

Response

Successful Response

No content.
Update Credential Library
PATCH /v1/credential-libraries/{id}
Expand

Updates a Credential Library.

Request

Path Parameters

id string Required

Query Parameters

update_mask string

Body Parameters

credential_store_id string

The ID of the Credential Store of which this Credential Library 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 Library type.

attributes object

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

Response

Successful Response

id string

Output only. The ID of the Credential Library.

credential_store_id string

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

scope object

Output only. Scope information for this Credential Library.

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 Library type.

attributes object

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

authorized_actions string[]