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

# Probe an AWS role Barndoor is meant to assume



## OpenAPI

````yaml /api-reference/openapi.yaml post /api/dlp/admin/v1/provider-connections/aws-role-validate
openapi: 3.1.0
info:
  title: Barndoor.ai Public API
  description: Unified public API specification for Barndoor.ai platform
  version: 2.18.0
servers:
  - url: https://{host}
    description: Barndoor public API
    variables:
      host:
        default: platform.barndoor.ai
        description: >-
          The host serving your Barndoor deployment. Defaults to production;
          override it for another environment or a dedicated deployment.
security:
  - ApiKey: []
  - OAuth2:
      - openid
      - profile
      - email
tags:
  - name: dlp
    x-group: Data Control Center
  - name: identity
    x-group: Identity
  - name: llm-gateway
    x-group: LLM Gateway
  - name: notification
    x-group: Notifications
  - name: policy
    x-group: Policies
  - name: registry
    x-group: MCP Gateway
  - name: system-management
    x-group: Log Exports
paths:
  /api/dlp/admin/v1/provider-connections/aws-role-validate:
    post:
      tags:
        - dlp
      summary: Probe an AWS role Barndoor is meant to assume
      operationId: validate_aws_role
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValidateAwsRoleRequest'
        required: true
      responses:
        '200':
          description: The role was assumed successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AwsRoleValidationResponse'
        '400':
          description: The role could not be assumed with the supplied trust details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DlpErrorResponse'
        '401':
          description: Missing or invalid bearer token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DlpErrorResponse'
        '403':
          description: Caller lacks a tenant-admin role
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DlpErrorResponse'
components:
  schemas:
    ValidateAwsRoleRequest:
      type: object
      required:
        - region
        - iam_role_arn
        - external_id
      properties:
        external_id:
          type: string
        iam_role_arn:
          type: string
        region:
          type: string
    AwsRoleValidationResponse:
      type: object
      description: |-
        Result of a successful `aws_role` credential probe. A failed probe is an
        error response, not `ok: false`.
      required:
        - ok
      properties:
        ok:
          type: boolean
          description: Always true — the role was assumed successfully.
    DlpErrorResponse:
      type: object
      description: >-
        The error body every `/admin/v1` handler returns.


        Two shapes reach the wire and both are modelled here as optional fields:

        the shared auth/role gate in [`super`] emits `{"error": ...}`, while

        [`super::json_message`] — which the handlers themselves use — emits

        `{"message": ...}`. Exactly one is present on any given response. This
        is

        documentation of what the service already does, not a new contract; a

        handler is not free to send both.
      properties:
        error:
          type:
            - string
            - 'null'
          description: Set by the authentication and tenant-admin role gate (401 and 403).
        message:
          type:
            - string
            - 'null'
          description: Set by handler-level validation and store failures.
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      description: >-
        A Barndoor API key, sent as `Authorization: Bearer <key>`. Keys are
        prefixed `bdai_` and are opaque — do not attempt to decode one.
        Interchangeable with an OAuth 2.0 access token.
    OAuth2:
      type: oauth2
      x-issuer: https://auth.barndoor.ai/realms/barndoor
      description: >-
        An OAuth 2.0 access token from Barndoor's identity provider, sent as
        `Authorization: Bearer <token>`. Public clients must use PKCE.
        Interchangeable with an API key.
      flows:
        authorizationCode:
          authorizationUrl: >-
            https://auth.barndoor.ai/realms/barndoor/protocol/openid-connect/auth
          tokenUrl: >-
            https://auth.barndoor.ai/realms/barndoor/protocol/openid-connect/token
          scopes:
            openid: Issue an OIDC ID token identifying the caller.
            profile: Read the caller's basic profile claims.
            email: Read the caller's email address.
            offline_access: Issue a refresh token. Optional — no operation requires it.
        clientCredentials:
          tokenUrl: >-
            https://auth.barndoor.ai/realms/barndoor/protocol/openid-connect/token
          scopes:
            openid: Issue an OIDC ID token identifying the caller.
            profile: Read the caller's basic profile claims.
            email: Read the caller's email address.
            offline_access: Issue a refresh token. Optional — no operation requires it.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.