Red Hat Ansible Automation Platform Credential Input Sources API

openapi: 3.2.0
info:
  title: Red Hat Ansible Automation Platform Credential Input…
  version: '1.0'
  description: 'Operations tagged credential_input_sources across 2 of this provider''s published API definitions: red-hat-ansible-automation-platform-automation-controller-openapi.json, red-hat-ansible-automation-platform-event-driven-ansible-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /api/eda/v1
tags:
- name: credential_input_sources
paths:
  /api/v2/credential_input_sources/:
    get:
      operationId: credential_input_sources_list
      parameters:
      - in: query
        name: order
        schema:
          type: string
        description: Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields.
      - in: query
        name: order_by
        schema:
          type: string
        description: Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields.
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: role_level
        schema:
          type: string
        description: Filter by role level for RBAC
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - in: query
        name: type
        schema:
          type: string
        description: Filter by object type. Supports comma-separated values for multiple types.
      tags:
      - credential_input_sources
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedCredentialInputSourceList'
          description: ''
      x-ai-description: Returns a paginated list of external secret management input sources.
      summary: Credential input sources list
      x-summary-source: derived
    post:
      operationId: credential_input_sources_create
      tags:
      - credential_input_sources
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CredentialInputSourceRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialInputSource'
          description: ''
      x-ai-description: Create a credential input source
      summary: Credential input sources create
      x-summary-source: derived
  /api/v2/credential_input_sources/{id}/:
    get:
      operationId: credential_input_sources_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - credential_input_sources
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialInputSource'
          description: ''
      x-ai-description: Retrieve a credential input source
      summary: Credential input sources retrieve
      x-summary-source: derived
    put:
      operationId: credential_input_sources_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - credential_input_sources
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CredentialInputSourceRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialInputSource'
          description: ''
      x-ai-description: Update a credential input source
      summary: Credential input sources update
      x-summary-source: derived
    patch:
      operationId: credential_input_sources_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - credential_input_sources
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedCredentialInputSourceRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialInputSource'
          description: ''
      x-ai-description: Update a credential input source
      summary: Credential input sources partial update
      x-summary-source: derived
    delete:
      operationId: credential_input_sources_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - credential_input_sources
      responses:
        '204':
          description: No response body
      x-ai-description: Delete a credential input source
      summary: Credential input sources destroy
      x-summary-source: derived
  /credential-input-sources/:
    get:
      operationId: getCredentialInputSources
      description: List all Credential Input Sources
      parameters:
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: page_size
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: source_credential
        schema:
          type: integer
        description: Filter by Source Credential ID.
      - in: query
        name: target_credential
        schema:
          type: integer
        description: Filter by Target Credential ID.
      tags:
      - credential_input_sources
      security:
      - EDAJWTAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedCredentialInputSourceList_2'
          description: Return a list of Credential Input Sources.
      summary: Credential input sources list
      x-summary-source: derived
      x-operation-id-source: normalized
      x-operation-id-original: credential_input_sources_list
    post:
      operationId: postCredentialInputSources
      description: Create a new Credential Input Source.
      tags:
      - credential_input_sources
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CredentialInputSourceCreate'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CredentialInputSourceCreate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CredentialInputSourceCreate'
        required: true
      security:
      - EDAJWTAuthentication: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialInputSource_2'
          description: Return the new Credential Input Source.
      summary: Credential input sources create
      x-summary-source: derived
      x-operation-id-source: normalized
      x-operation-id-original: credential_input_sources_create
    servers:
    - url: /api/eda/v1
  /credential-input-sources/{id}/:
    get:
      operationId: getCredentialInputSourcesById
      description: Get CredentialInputSource by id
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this credential input source.
        required: true
      - in: query
        name: refs
        schema:
          type: string
          enum:
          - 'false'
          - 'true'
        description: Query resources that have reference to the credential input source by its id
      tags:
      - credential_input_sources
      security:
      - EDAJWTAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialInputSource_2'
          description: Return an Credential Input Source by id.
      summary: Credential input sources retrieve
      x-summary-source: derived
      x-operation-id-source: normalized
      x-operation-id-original: credential_input_sources_retrieve
    patch:
      operationId: patchCredentialInputSourcesById
      description: Partial update of an Credential Input Source
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this credential input source.
        required: true
      tags:
      - credential_input_sources
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedCredentialInputSourceUpdate'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedCredentialInputSourceUpdate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedCredentialInputSourceUpdate'
      security:
      - EDAJWTAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialInputSource_2'
          description: Update successful. Return an updated credential input source.
      summary: Credential input sources partial update
      x-summary-source: derived
      x-operation-id-source: normalized
      x-operation-id-original: credential_input_sources_partial_update
    delete:
      operationId: deleteCredentialInputSourcesById
      description: 'The CredentialInputSourceViewSet is used to link fields to external SMS.


        When the linkage happens we need the Source, Target credential and the

        field name'
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this credential input source.
        required: true
      tags:
      - credential_input_sources
      security:
      - EDAJWTAuthentication: []
      responses:
        '204':
          description: No response body
      summary: Credential input sources destroy
      x-summary-source: derived
      x-operation-id-source: normalized
      x-operation-id-original: credential_input_sources_destroy
    servers:
    - url: /api/eda/v1
components:
  schemas:
    CredentialInputSource:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        type:
          type: string
          readOnly: true
        url:
          type: string
          readOnly: true
        related:
          type: string
          readOnly: true
        summary_fields:
          type: string
          readOnly: true
        created:
          type: string
          readOnly: true
        modified:
          type: string
          readOnly: true
        description:
          type:
          - string
          - 'null'
          default: ''
        input_field_name:
          type:
          - string
          - 'null'
          maxLength: 1024
        metadata:
          default: {}
        target_credential:
          type:
          - integer
          - 'null'
        source_credential:
          type:
          - integer
          - 'null'
      required:
      - input_field_name
      - source_credential
      - target_credential
    CredentialInputSourceRequest:
      type: object
      properties:
        description:
          type:
          - string
          - 'null'
          default: ''
        input_field_name:
          type:
          - string
          - 'null'
          minLength: 1
          maxLength: 1024
        metadata:
          default: {}
        target_credential:
          type:
          - integer
          - 'null'
        source_credential:
          type:
          - integer
          - 'null'
      required:
      - input_field_name
      - source_credential
      - target_credential
    PaginatedCredentialInputSourceList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=4
        previous:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?page=2
        results:
          type: array
          items:
            $ref: '#/components/schemas/CredentialInputSource'
    PatchedCredentialInputSourceRequest:
      type: object
      properties:
        description:
          type:
          - string
          - 'null'
          default: ''
        input_field_name:
          type:
          - string
          - 'null'
          minLength: 1
          maxLength: 1024
        metadata:
          default: {}
        target_credential:
          type:
          - integer
          - 'null'
        source_credential:
          type:
          - integer
          - 'null'
    OrganizationRef:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          description: The name of this resource.
          maxLength: 512
        description:
          type: string
          description: The organization description.
      required:
      - id
      - name
    CredentialInputSource_2:
      type: object
      description: Serializer used during a GET.
      properties:
        description:
          type: string
        metadata:
          type: string
        references:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/EdaCredentialReference'
        created_by:
          type: object
          properties:
            id:
              type: integer
            username:
              type: string
            first_name:
              type: string
            last_name:
              type: string
        modified_by:
          type: object
          properties:
            id:
              type: integer
            username:
              type: string
            first_name:
              type: string
            last_name:
              type: string
        input_field_name:
          type: string
          maxLength: 1024
        source_credential:
          type:
          - integer
          - 'null'
          description: External credential
        target_credential:
          type:
          - integer
          - 'null'
          description: Non external credential
        id:
          type: integer
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        modified_at:
          type: string
          format: date-time
          readOnly: true
        organization:
          $ref: '#/components/schemas/OrganizationRef'
      required:
      - created_at
      - created_by
      - id
      - input_field_name
      - modified_at
      - modified_by
      - organization
      - target_credential
    EdaCredentialReference:
      type: object
      properties:
        type:
          type: string
          description: Type of the related resource
        id:
          type: integer
          description: ID of the related resource
        name:
          type: string
          description: Name of the related resource
        uri:
          type: string
          format: uri
          description: URI of the related resource
      required:
      - id
      - name
      - type
      - uri
    PatchedCredentialInputSourceUpdate:
      type: object
      description: Serializer used during update of the instance.
      properties:
        description:
          type: string
        metadata: {}
        organization_id:
          type: integer
        source_credential:
          type:
          - integer
          - 'null'
          description: External credential
        target_credential:
          type:
          - integer
          - 'null'
          description: Non external credential
        input_field_name:
          type: string
          maxLength: 1024
    CredentialInputSourceCreate:
      type: object
      description: Serializer used during the Create process of the instance.
      properties:
        description:
          type: string
        metadata: {}
        target_credential:
          type: integer
        source_credential:
          type: integer
        input_field_name:
          type: string
          maxLength: 1024
        organization_id:
          type: integer
      required:
      - input_field_name
      - metadata
      - organization_id
      - source_credential
      - target_credential
    PaginatedCredentialInputSourceList_2:
      type: object
      properties:
        count:
          type: integer
          example: 123
        next:
          type:
          - string
          - 'null'
          format: uri
          example: /eda/api/v1/example/?page=51&page_size=100
        previous:
          type:
          - string
          - 'null'
          format: uri
          example: /eda/api/v1/example/?page=49&page_size=100
        page_size:
          type:
          - integer
          - 'null'
          example: 100
        page:
          type:
          - integer
          - 'null'
          example: 50
        results:
          type: array
          items:
            $ref: '#/components/schemas/CredentialInputSource_2'
  securitySchemes:
    EDAJWTAuthentication:
      type: apiKey
      name: X-DAB-JW-TOKEN
      in: header
    cookieAuth:
      type: apiKey
      in: cookie
      name: sessionid
x-refined-from:
- red-hat-ansible-automation-platform-automation-controller-openapi.json
- red-hat-ansible-automation-platform-event-driven-ansible-openapi.json