> ## Documentation Index
> Fetch the complete documentation index at: https://developers.askparable.com/llms.txt
> Use this file to discover all available pages before exploring further.

# validateCredentials

> POST /api/connectors/validate
Validate stored credentials by testing against the third-party service.
Updates credential_metadata status based on validation result.



## OpenAPI

````yaml /api-reference/openapi.json post /api/connectors/validate
openapi: 3.0.3
info:
  title: Parable API
  description: >-
    The REST API for your Parable workspace: manage connectors and taps, explore
    your data catalog, upload artifacts, and administer users and roles.
  version: v1
servers:
  - url: https://api.askparable.com
    description: Production
security: []
paths:
  /api/connectors/validate:
    post:
      tags:
        - connectors
      summary: validateCredentials
      description: |-
        POST /api/connectors/validate
        Validate stored credentials by testing against the third-party service.
        Updates credential_metadata status based on validation result.
      operationId: ConnectorsValidateCredentialsHandler
      parameters:
        - description: >-
            Workspace slug. Overrides subdomain-based workspace resolution when
            provided.
          in: header
          name: X-Tenant
          required: false
          schema:
            example: acme
            type: string
        - description: Optional request correlation ID echoed back in the response.
          in: header
          name: X-Request-ID
          required: false
          schema:
            example: 550e8400-e29b-41d4-a716-446655440000
            format: uuid
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValidateCredentialsInput'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/ValidateCredentialsResult'
                  links:
                    $ref: '#/components/schemas/ResponseLinks'
                  meta:
                    $ref: '#/components/schemas/ResponseMeta'
                required:
                  - data
                  - meta
                type: object
          description: Successful response
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Bad request
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Internal server error
      security:
        - bearerAuth: []
components:
  schemas:
    ValidateCredentialsInput:
      description: Input for validating stored credentials.
      properties:
        credentialMetadataId:
          description: The credential metadata ID to validate.
          type: string
      required:
        - credentialMetadataId
      type: object
    ValidateCredentialsResult:
      description: Result of credential validation.
      properties:
        details:
          description: >-
            Additional details about the validation (e.g., available scopes,
            user info).
          type: object
        errorCode:
          $ref: '#/components/schemas/ValidationErrorCode'
          description: Error category when validation fails. Null when success is true.
        message:
          description: Human-readable message about the validation result.
          type: string
        status:
          $ref: '#/components/schemas/CredentialStatus'
          description: Updated credential status after validation.
        success:
          description: Whether the validation was successful (credentials work).
          type: boolean
        validatedAt:
          description: When the validation was performed.
          type: string
      required:
        - success
        - status
      type: object
    ResponseLinks:
      properties:
        first:
          nullable: true
          type: string
        last:
          nullable: true
          type: string
        next:
          nullable: true
          type: string
        prev:
          nullable: true
          type: string
      type: object
    ResponseMeta:
      properties:
        requestId:
          description: Unique identifier for the request
          type: string
        totalCount:
          description: Total count of items for paginated responses
          nullable: true
          type: integer
      required:
        - requestId
      type: object
    Error:
      properties:
        error:
          type: string
      type: object
    ValidationErrorCode:
      description: Error category when credential validation fails.
      enum:
        - auth_failed
        - internal_error
        - insufficient_permissions
        - expired
        - config_invalid
      type: string
    CredentialStatus:
      description: >-
        Credential Types for Workspace Connector Configuration

        These types define how credentials are stored and referenced for
        connector authentication.

        Credentials are stored securely in GCP Secret Manager - only
        metadata/references are in the DB.

        These types are created when customers configure connectors through the
        UI,

        as part of the workspace connector setup workflow.

        ============================================================================

        Credential Enums

        ============================================================================

        Status of stored credentials.
      enum:
        - valid
        - expired
        - invalid
        - pending
        - unvalidated
      type: string
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      scheme: bearer
      type: http

````