Application Research Credentials API

openapi: 3.1.0
info:
  title: Application Research CNAB Bundle API Resources Credentials API
  version: 1.0.0
  description: 'API for managing Cloud Native Application Bundles (CNAB).


    This API provides endpoints for managing CNAB bundles, claims, claim results,

    dependencies, parameter sources, relocation mappings, and installation status.

    '
  contact:
    name: CNAB Specification
    url: https://cnab.io
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: https://api.example.com/v1
  description: Production server
- url: https://staging-api.example.com/v1
  description: Staging server
security:
- bearerAuth: []
- apiKey: []
tags:
- name: Credentials
  description: Credential management operations
paths:
  /planes/azure/{planeName}/providers/System.Azure/credentials/{credentialName}:
    get:
      tags:
      - Credentials
      summary: Application Research Get Azure credential
      operationId: AzureCredentials_Get
      parameters:
      - $ref: '#/components/parameters/PlaneNameParameter'
      - $ref: '#/components/parameters/CredentialNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AzureCredentialResource'
              examples:
                workloadIdentityCredential:
                  $ref: '#/components/examples/AzureWorkloadIdentityCredentialExample'
        default:
          $ref: '#/components/responses/ErrorResponse'
  /planes/aws/{planeName}/providers/System.AWS/credentials/{credentialName}:
    get:
      tags:
      - Credentials
      summary: Application Research Get AWS credential
      operationId: AwsCredentials_Get
      parameters:
      - $ref: '#/components/parameters/PlaneNameParameter'
      - $ref: '#/components/parameters/CredentialNameParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AwsCredentialResource'
              examples:
                irsaCredential:
                  $ref: '#/components/examples/AwsIrsaCredentialExample'
        default:
          $ref: '#/components/responses/ErrorResponse'
components:
  parameters:
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      description: The API version to use for this operation
      schema:
        type: string
        default: 2023-10-01-preview
    CredentialNameParameter:
      name: credentialName
      in: path
      required: true
      description: The name of the credential
      schema:
        type: string
    PlaneNameParameter:
      name: planeName
      in: path
      required: true
      description: The name of the plane
      schema:
        type: string
        pattern: ^[A-Za-z]([-A-Za-z0-9]*[A-Za-z0-9])?$
        maxLength: 63
  schemas:
    ProvisioningState:
      type: string
      description: Provisioning state of the resource at the time the operation was called
      enum:
      - Creating
      - Updating
      - Deleting
      - Accepted
      - Provisioning
      - Succeeded
      - Failed
      - Canceled
      readOnly: true
    AwsCredentialProperties:
      type: object
      properties:
        kind:
          type: string
          enum:
          - AccessKey
          - IRSA
        provisioningState:
          $ref: '#/components/schemas/ProvisioningState'
          readOnly: true
      required:
      - kind
    AzureCredentialProperties:
      type: object
      properties:
        kind:
          type: string
          enum:
          - ServicePrincipal
          - WorkloadIdentity
        provisioningState:
          $ref: '#/components/schemas/ProvisioningState'
          readOnly: true
      required:
      - kind
    AwsCredentialResource:
      type: object
      properties:
        properties:
          $ref: '#/components/schemas/AwsCredentialProperties'
        id:
          type: string
          readOnly: true
        name:
          type: string
          readOnly: true
        type:
          type: string
          readOnly: true
        systemData:
          type: object
          readOnly: true
        tags:
          type: object
          additionalProperties:
            type: string
        location:
          type: string
      required:
      - properties
      - location
    AzureCredentialResource:
      type: object
      properties:
        properties:
          $ref: '#/components/schemas/AzureCredentialProperties'
        id:
          type: string
          readOnly: true
        name:
          type: string
          readOnly: true
        type:
          type: string
          readOnly: true
        systemData:
          type: object
          readOnly: true
        tags:
          type: object
          additionalProperties:
            type: string
        location:
          type: string
      required:
      - properties
      - location
  examples:
    AwsIrsaCredentialExample:
      summary: AWS IRSA credential
      value:
        properties:
          kind: IRSA
          roleARN: arn:aws:iam::123456789012:role/cicd-cross-account-role
          storage:
            kind: Internal
            secretName: aws-irsa-credentials
        location: us-west-2
        tags:
          credential: aws-irsa
    AzureWorkloadIdentityCredentialExample:
      summary: Azure Workload Identity credential
      value:
        properties:
          kind: WorkloadIdentity
          clientId: 00000000-0000-0000-0000-000000000000
          tenantId: 00000000-0000-0000-0000-000000000000
          storage:
            kind: Internal
            secretName: azure-workload-identity
        location: westus2
        tags:
          credential: azure-workload-identity
  responses:
    ErrorResponse:
      description: Error response
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  code:
                    type: string
                    description: Error code
                  message:
                    type: string
                    description: Error message
                  target:
                    type: string
                    description: Error target
                required:
                - code
                - message
            required:
            - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT-based authentication
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key authentication