June 20-22 Announcing HashiConf Europe full schedule: keynotes, sessions, labs & more Register Now
  • Infrastructure
    • terraform
    • packer
  • Networking
    • consul
  • Security
    • vault
    • boundary
  • Applications
    • nomad
    • waypoint
    • vagrant
  • HashiCorp Cloud Platform

    A fully managed platform to automate infrastructure on any cloud with HashiCorp products.

    • consul
    • terraform
    • vault
    • packerbeta
    Visit cloud.hashicorp.com
  • Overview
  • Tutorials
  • Docs
  • API
  • Community
GitHub—Stars on GitHub
Download
  • Account Service
  • Auth Method Service
  • Auth Token Service
  • Credential Library Service
  • Credential Store Service
  • Group Service
  • Host Catalog Service
  • Host Service
  • Host Set Service
  • Managed Group Service
  • Role Service
  • Scope Service
  • Session Service
  • Target Service
  • User Service

Boundary Controller HTTP API

Credential Library Service

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

The type of credential this library will issue, defaults to Unspecified

credential_mapping_overrides object

The credential mapping overrides

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.

credential_type string

The type of credential this library will issue, defaults to Unspecified

credential_mapping_overrides object

The credential mapping overrides

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

The type of credential this library will issue, defaults to Unspecified

credential_mapping_overrides object

The credential mapping overrides

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

The type of credential this library will issue, defaults to Unspecified

credential_mapping_overrides object

The credential mapping overrides

Deletes a Credential Library

Request

Path Parameters

id string Required

Response

Successful Response

No content.

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.

credential_type string

The type of credential this library will issue, defaults to Unspecified

credential_mapping_overrides object

The credential mapping overrides

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

The type of credential this library will issue, defaults to Unspecified

credential_mapping_overrides object

The credential mapping overrides

DocsLearnPrivacySecurityPress KitConsent Manager