Boundary controller HTTP API

Credential Service

List CredentialsGET/v1/credentials

Lists all Credentials.

Query Parameters

credential_store_id string

filter string

You can specify that the filter should only return items that match. Refer to filter expressions for more information.

list_token string

An opaque token that Boundary uses to continue an existing iteration or request updated items. If you do not specify a token, pagination starts from the beginning. To learn more about list pagination in Boundary, refer to list pagination.

page_size integer

The maximum size of a page in this iteration. If you do not set a page size, Boundary uses the configured default page size. If the page_size is greater than the default page size configured, Boundary truncates the page size to this number.

Successful Response

items object[]

Credential contains all fields related to an Credential resource

id string

Output only. The ID of the Credential.

credential_store_id string

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

scope object

Output only. Scope information for this Credential.

id string

The ID of the scope.

type string

The type of the scope.

name string

The name of the scope, if any.

description string

The description of the scope, if any.

parent_scope_id string

The ID of the parent scope, if any. This field is empty if it 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 type.

attributes object

The attributes that are applicable for the specific Credential type.

authorized_actions string[]

response_type string

The type of response, either "delta" or "complete". Delta signifies that this is part of a paginated result or an update to a previously completed pagination. Complete signifies that it is the last page.

list_token string

An opaque token used to continue an existing pagination or request updated items. Use this token in the next list request to request the next page.

sort_by string

The name of the field which the items are sorted by.

sort_dir string

The direction of the sort, either "asc" or "desc".

removed_ids string[]

est_item_count integer

An estimate at the total items available. This may change during pagination.

Create CredentialPOST/v1/credentials

Creates a single Credential.

Body Parameters

credential_store_id string

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

attributes object

The attributes that are applicable for the specific Credential type.

Successful Response

id string

Output only. The ID of the Credential.

credential_store_id string

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

scope object

Output only. Scope information for this Credential.

id string

The ID of the scope.

type string

The type of the scope.

name string

The name of the scope, if any.

description string

The description of the scope, if any.

parent_scope_id string

The ID of the parent scope, if any. This field is empty if it 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 type.

attributes object

The attributes that are applicable for the specific Credential type.

authorized_actions string[]

Get CredentialGET/v1/credentials/{id}

Gets a single Credential.

Path Parameters

id string

Successful Response

id string

Output only. The ID of the Credential.

credential_store_id string

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

scope object

Output only. Scope information for this Credential.

id string

The ID of the scope.

type string

The type of the scope.

name string

The name of the scope, if any.

description string

The description of the scope, if any.

parent_scope_id string

The ID of the parent scope, if any. This field is empty if it 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 type.

attributes object

The attributes that are applicable for the specific Credential type.

authorized_actions string[]

Delete CredentialDELETE/v1/credentials/{id}

Deletes a Credential

Path Parameters

id string

Update CredentialPATCH/v1/credentials/{id}

Updates a Credential.

Path Parameters

id string

Body Parameters

credential_store_id string

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

attributes object

The attributes that are applicable for the specific Credential type.

Successful Response

id string

Output only. The ID of the Credential.

credential_store_id string

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

scope object

Output only. Scope information for this Credential.

id string

The ID of the scope.

type string

The type of the scope.

name string

The name of the scope, if any.

description string

The description of the scope, if any.

parent_scope_id string

The ID of the parent scope, if any. This field is empty if it 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 type.

attributes object

The attributes that are applicable for the specific Credential type.

authorized_actions string[]