Documentation menu
Provider Credentials

Create a provider credential

POST /api/v1/organizations/{organizationIdOrSlug}/provider-credentials

Parameters

path

NameTypeRequiredDescription
organizationIdOrSlugone of 2 typesrequiredIdentifies the organization by its stable identifier or slug. For a session, an identifier-shaped value is resolved as a stable identifier. Applies to Create a provider credential.

Request body

Required — Request body for: Create a provider credential.

application/json

NameTypeRequiredDescription
labelstringrequired
providerstringrequired
credentialType"api_key" | "service_account" | "connection_string"required
secretstringrequired
expiresAtstring | nulloptional

Responses

StatusDescriptionBody
200Response for status 200application/json — object — data: object (required)
400The request is malformed or cannot be processed.application/json — PublicApiError — error: object (required)
401Authentication failed. The Authorization header is missing, or the credential is invalid or expired.application/json — PublicApiError — error: object (required)
403Access denied. The authenticated user does not have permission to perform this action.application/json — PublicApiError — error: object (required)
404Resource not found.application/json — PublicApiError — error: object (required)
409Request conflicts with current state of the resource, including safe deployment conflict classifications.application/json — PublicApiError — error: object (required)
422Request validation failed. Check the request body, query parameters, or path parameters.application/json — PublicApiError — error: object (required)
429Too many requests.application/json — PublicApiError — error: object (required)
500The server could not complete the request.application/json — PublicApiError — error: object (required)
503Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.application/json — PublicApiError — error: object (required)