credentials

Creates, updates, deletes, gets or lists a credentials resource.

Overview

Name	credentials
Type	Resource
Id	anthropic.vaults.credentials

Fields

The following fields are returned by SELECT queries:

get

Successful response (OK)

Name	Datatype	Description
id	string	Unique identifier for the credential.
vault_id	string	Identifier of the vault this credential belongs to.
display_name	string	Human-readable name for the credential.
archived_at	string (date-time)	When the credential was archived. Null if not archived.
▶auth	object	Authentication configuration for this credential.
created_at	string (date-time)	A timestamp in RFC 3339 format
metadata	object	Arbitrary key-value metadata attached to the credential.
type	string	(vault_credential)
updated_at	string (date-time)	A timestamp in RFC 3339 format

list

Successful response (OK)

Name	Datatype	Description
id	string	Unique identifier for the credential.
vault_id	string	Identifier of the vault this credential belongs to.
display_name	string	Human-readable name for the credential.
archived_at	string (date-time)	When the credential was archived. Null if not archived.
▶auth	object	Authentication configuration for this credential.
created_at	string (date-time)	A timestamp in RFC 3339 format
metadata	object	Arbitrary key-value metadata attached to the credential.
type	string	(vault_credential)
updated_at	string (date-time)	A timestamp in RFC 3339 format

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	vault_id, credential_id	anthropic-workspace-id
list	select	vault_id	include_archived, anthropic-workspace-id
create	insert	vault_id, auth	anthropic-workspace-id
update	update	vault_id, credential_id	anthropic-workspace-id
delete	delete	vault_id, credential_id	anthropic-workspace-id
archive	exec	vault_id, credential_id	anthropic-workspace-id
mcp_oauth_validate	exec	vault_id, credential_id	anthropic-workspace-id

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
credential_id	string	Path parameter credential_id (example: vcrd_011CZkZEMt8gZan2iYOQfSkw)
vault_id	string	Path parameter vault_id (example: vlt_011CZkZDLs7fYzm1hXNPeRjv)
anthropic-workspace-id	string	Optional header to select the Workspace for this request. The value is a Workspace ID (for example, wrkspc_011CZkZaBF1tNoB5wlCeusgy). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. (example: wrkspc_011CZkZaBF1tNoB5wlCeusgy)
include_archived	boolean	Whether to include archived credentials in the results.

SELECT examples

get

Successful response (OK)

SELECT
id,
vault_id,
display_name,
archived_at,
auth,
created_at,
metadata,
type,
updated_at
FROM anthropic.vaults.credentials
WHERE vault_id = '{{ vault_id }}' -- required
AND credential_id = '{{ credential_id }}' -- required
AND "anthropic-workspace-id" = '{{ anthropic-workspace-id }}'
;

list

Successful response (OK)

SELECT
id,
vault_id,
display_name,
archived_at,
auth,
created_at,
metadata,
type,
updated_at
FROM anthropic.vaults.credentials
WHERE vault_id = '{{ vault_id }}' -- required
AND include_archived = '{{ include_archived }}'
AND "anthropic-workspace-id" = '{{ anthropic-workspace-id }}'
;

INSERT examples

create

No description available.

INSERT INTO anthropic.vaults.credentials (
auth,
display_name,
metadata,
vault_id,
"anthropic-workspace-id"
)
SELECT 
'{{ auth }}' /* required */,
'{{ display_name }}',
'{{ metadata }}',
'{{ vault_id }}',
'{{ anthropic-workspace-id }}'
RETURNING
id,
vault_id,
display_name,
archived_at,
auth,
created_at,
metadata,
type,
updated_at
;

Manifest

# Description fields are for documentation purposes
- name: credentials
props:
  - name: vault_id
    value: "{{ vault_id }}"
    description: Required parameter for the credentials resource.
  - name: auth
    description: |
      Authentication configuration for the credential.
    value:
      type: "{{ type }}"
      mcp_server_url: "{{ mcp_server_url }}"
      access_token: "{{ access_token }}"
      expires_at: "{{ expires_at }}"
      refresh:
        refresh_token: "{{ refresh_token }}"
        token_endpoint: "{{ token_endpoint }}"
        client_id: "{{ client_id }}"
        scope: "{{ scope }}"
        resource: "{{ resource }}"
        token_endpoint_auth:
          type: "{{ type }}"
          client_secret: "{{ client_secret }}"
      token: "{{ token }}"
      secret_name: "{{ secret_name }}"
      secret_value: "{{ secret_value }}"
      networking:
        type: "{{ type }}"
        allowed_hosts:
          - "{{ allowed_hosts }}"
      injection_location:
        header: {{ header }}
        body: {{ body }}
  - name: display_name
    value: "{{ display_name }}"
    description: |
      Human-readable name for the credential. Up to 255 characters.
  - name: metadata
    value: "{{ metadata }}"
    description: |
      Arbitrary key-value metadata to attach to the credential. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars.
  - name: anthropic-workspace-id
    value: "{{ anthropic-workspace-id }}"
    description: Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).  Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. (example: wrkspc_011CZkZaBF1tNoB5wlCeusgy)
    description: Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`).  Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. (example: wrkspc_011CZkZaBF1tNoB5wlCeusgy)

UPDATE examples

update

No description available.

UPDATE anthropic.vaults.credentials
SET 
display_name = '{{ display_name }}',
metadata = '{{ metadata }}',
auth = '{{ auth }}'
WHERE 
vault_id = '{{ vault_id }}' --required
WHERE credential_id = '{{ credential_id }}' --required
AND "anthropic-workspace-id" = '{{ anthropic-workspace-id}}'
RETURNING
id,
vault_id,
display_name,
archived_at,
auth,
created_at,
metadata,
type,
updated_at;

DELETE examples

delete

No description available.

DELETE FROM anthropic.vaults.credentials
WHERE vault_id = '{{ vault_id }}' --required
AND credential_id = '{{ credential_id }}' --required
AND "anthropic-workspace-id" = '{{ anthropic-workspace-id }}'
;

Lifecycle Methods

archive

Successful response (OK)

EXEC anthropic.vaults.credentials.archive 
@vault_id='{{ vault_id }}' --required, 
@credential_id='{{ credential_id }}' --required, 
@anthropic-workspace-id='{{ anthropic-workspace-id }}'
;

mcp_oauth_validate

Successful response (OK)

EXEC anthropic.vaults.credentials.mcp_oauth_validate 
@vault_id='{{ vault_id }}' --required, 
@credential_id='{{ credential_id }}' --required, 
@anthropic-workspace-id='{{ anthropic-workspace-id }}'
;