CYcyberdesk-hq
provider-credentials

Upsert Provider Credential

Changed on

Add or replace the organization's credential for a provider slot.

Once a slot has a credential, Cyberdesk stops using its own keys for that provider.

put/v1/provider-credentials/{slot}

Request

  • Base URL
    https://api.cyberdesk.io
  • URL
    https://api.cyberdesk.io/v1/provider-credentials/{slot}
  • Auth
    HTTP bearer

Path parameters

slot'anthropic' | 'openai' | 'google' | 'aws_bedrock' required

Headers

Idempotency-Keystring
Example:550e8400-e29b-41d4-a716-446655440000

Unique key for idempotent requests. If provided, the server ensures the request is processed at most once. Retries with the same key return the original response. SDKs auto-generate this for write requests.

Request body

api_keystring nullable

API key for the anthropic/openai slots, or the Bedrock API key when bedrock_auth_mode=api_key.

service_account_jsonstring nullable

Google Cloud service account key file contents (JSON string) for the google slot.

bedrock_auth_mode'api_key' | 'iam'
aws_access_key_idstring nullable
aws_secret_access_keystring nullable
aws_regionstring nullable

AWS region for Bedrock. One of: us-east-1, us-east-2, us-west-2.

Response

Successful Response

slot'anthropic' | 'openai' | 'google' | 'aws_bedrock' required
display_namestring required
source'cyberdesk' | 'organization' required
covered_providersstring[] required
status'active' | 'invalid' | 'missing'
auth_type'api_key' | 'service_account_json' | 'aws_bedrock_api_key' | 'aws_iam'
last_errorstring nullable
activated_atstring date-time nullable
last_validated_atstring date-time nullable
created_atstring date-time nullable
updated_atstring date-time nullable

Changes