Red Hat Ansible Automation Platform Credential Types API

openapi: 3.2.0
info:
  title: Red Hat Ansible Automation Platform Credential Types API
  version: '1.0'
  description: 'Operations tagged credential_types 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 Types
paths:
  /api/v2/credential_types/:
    get:
      operationId: credential_types_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 Types
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedCredentialTypeList'
          description: ''
      x-ai-description: Returns a paginated list of all credential types (machine, vault, cloud, etc.).
      summary: Credential types list
      x-summary-source: derived
    post:
      operationId: credential_types_create
      tags:
      - Credential Types
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CredentialTypeRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialType'
          description: ''
      x-ai-description: Create a new custom credential type
      summary: Credential types create
      x-summary-source: derived
  /api/v2/credential_types/{id}/:
    get:
      operationId: credential_types_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - Credential Types
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialType'
          description: ''
      x-ai-description: Retrieve a credential type
      summary: Credential types retrieve
      x-summary-source: derived
    put:
      operationId: credential_types_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - Credential Types
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CredentialTypeRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialType'
          description: ''
      x-ai-description: Update a custom credential type.
      summary: Credential types update
      x-summary-source: derived
    patch:
      operationId: credential_types_partial_update
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - Credential Types
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedCredentialTypeRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialType'
          description: ''
      x-ai-description: Update a custom credential type.
      summary: Credential types partial update
      x-summary-source: derived
    delete:
      operationId: credential_types_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - Credential Types
      responses:
        '204':
          description: No response body
      x-ai-description: Delete a custom credential type. Cannot delete managed types or types currently in use.
      summary: Credential types destroy
      x-summary-source: derived
  /api/v2/credential_types/{id}/activity_stream/:
    get:
      operationId: credential_types_activity_stream_list
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      - 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 Types
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedActivityStreamList'
          description: ''
      x-ai-description: Get activity stream for credential type
      summary: Credential types activity stream list
      x-summary-source: derived
  /api/v2/credential_types/{id}/credentials/:
    get:
      operationId: credential_types_credentials_list
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      - 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 Types
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedCredentialList'
          description: ''
      x-ai-description: List credentials of a credential type
      summary: Credential types credentials list
      x-summary-source: derived
    post:
      operationId: credential_types_credentials_create
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - Credential Types
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CredentialRequest'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Credential'
          description: ''
      x-ai-description: Create a credential of a credential type
      summary: Credential types credentials create
      x-summary-source: derived
  /api/v2/credential_types/{id}/test/:
    get:
      operationId: credential_types_test_retrieve
      description: 'Test a complete set of input values for an external credential before

        saving it.'
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - Credential Types
      responses:
        '200':
          description: No response body
      x-ai-description: Retrieve single test for a credential_type
      summary: Credential types test retrieve
      x-summary-source: derived
    post:
      operationId: credential_types_test_create
      description: 'Test a complete set of input values for an external credential before

        saving it.'
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^[0-9]+$
        required: true
      tags:
      - Credential Types
      responses:
        '200':
          description: No response body
      x-ai-description: Test a complete set of input values for an external credential
      summary: Credential types test create
      x-summary-source: derived
  /credential-types/:
    get:
      operationId: getCredentialTypes
      description: List all credential types
      parameters:
      - in: query
        name: name
        schema:
          type: string
        description: Filter by credential type name.
      - in: query
        name: namespace
        schema:
          type: string
        description: Filter by credential type namespace.
      - 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
      tags:
      - Credential Types
      security:
      - EDAJWTAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedCredentialTypeList_2'
          description: Return a list of credential types.
      summary: Credential types list
      x-summary-source: derived
      x-operation-id-source: normalized
      x-operation-id-original: credential_types_list
    post:
      operationId: postCredentialTypes
      description: Create a new credential type.
      tags:
      - Credential Types
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CredentialTypeCreate'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CredentialTypeCreate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CredentialTypeCreate'
        required: true
      security:
      - EDAJWTAuthentication: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialType_2'
          description: Return the new credential type.
      summary: Credential types create
      x-summary-source: derived
      x-operation-id-source: normalized
      x-operation-id-original: credential_types_create
    servers:
    - url: /api/eda/v1
  /credential-types/{id}/:
    get:
      operationId: getCredentialTypesById
      description: Get credential type by id
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this credential type.
        required: true
      tags:
      - Credential Types
      security:
      - EDAJWTAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialType_2'
          description: Return a credential type by id.
      summary: Credential types retrieve
      x-summary-source: derived
      x-operation-id-source: normalized
      x-operation-id-original: credential_types_retrieve
    patch:
      operationId: patchCredentialTypesById
      description: Partial update of a credential type
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this credential type.
        required: true
      tags:
      - Credential Types
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedCredentialTypeCreate'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedCredentialTypeCreate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedCredentialTypeCreate'
      security:
      - EDAJWTAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialType_2'
          description: Update successful. Return an updated credential type.
      summary: Credential types partial update
      x-summary-source: derived
      x-operation-id-source: normalized
      x-operation-id-original: credential_types_partial_update
    delete:
      operationId: deleteCredentialTypesById
      description: Delete a credential type by id
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this credential type.
        required: true
      tags:
      - Credential Types
      security:
      - EDAJWTAuthentication: []
      responses:
        '204':
          description: Delete successful.
        '409':
          description: CredentialType in use by Credentials.
      summary: Credential types destroy
      x-summary-source: derived
      x-operation-id-source: normalized
      x-operation-id-original: credential_types_destroy
    servers:
    - url: /api/eda/v1
  /credential-types/{id}/test/:
    post:
      operationId: postCredentialTypesByIdTest
      description: Run a test on External Credential
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this credential type.
        required: true
      tags:
      - Credential Types
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CredentialTypeTest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CredentialTypeTest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CredentialTypeTest'
        required: true
      security:
      - EDAJWTAuthentication: []
      responses:
        '202':
          description: Test Successful.
        '400':
          description: Test failed.
      summary: Credential types test create
      x-summary-source: derived
      x-operation-id-source: normalized
      x-operation-id-original: credential_types_test_create
    servers:
    - url: /api/eda/v1
components:
  schemas:
    PaginatedActivityStreamList:
      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/ActivityStream'
    PatchedCredentialTypeRequest:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          minLength: 1
          maxLength: 512
        description:
          type:
          - string
          - 'null'
          default: ''
        kind:
          enum:
          - cloud
          - net
          - null
          type:
          - string
          - 'null'
          description: '* `cloud` - Cloud\n* `net` - Network'
          x-spec-enum-id: 8c34823df94b101f
        inputs:
          default: {}
          description: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.
        injectors:
          default: {}
          description: Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax.
    PaginatedCredentialTypeList:
      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/CredentialType'
    CredentialRequest:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          minLength: 1
          maxLength: 512
        description:
          type:
          - string
          - 'null'
          default: ''
        organization:
          type:
          - integer
          - 'null'
        credential_type:
          type: integer
          description: Specify the type of credential you want to create. Refer to the documentation for details on each type.
        inputs:
          default: {}
          description: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.
      required:
      - credential_type
      - name
    ActivityStream:
      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
        timestamp:
          type: string
          format: date-time
          readOnly: true
        operation:
          enum:
          - create
          - update
          - delete
          - associate
          - disassociate
          - null
          type:
          - string
          - 'null'
          x-spec-enum-id: d1cf1307b8aa394e
          description: 'The action taken with respect to the given object(s).


            * `create` - Entity Created

            * `update` - Entity Updated

            * `delete` - Entity Deleted

            * `associate` - Entity Associated with another Entity

            * `disassociate` - Entity was Disassociated with another Entity'
        changes:
          type: string
          readOnly: true
          description: A summary of the new and changed values when an object is created, updated, or deleted
        object1:
          type:
          - string
          - 'null'
          description: For create, update, and delete events this is the object type that was affected. For associate and disassociate events this is the object type associated or disassociated with object2.
        object2:
          type:
          - string
          - 'null'
          description: Unpopulated for create, update, and delete events. For associate and disassociate events this is the object type that object1 is being associated with.
        object_association:
          type: string
          readOnly: true
          description: When present, shows the field name of the role or relationship that changed.
        action_node:
          type: string
          readOnly: true
          description: The cluster node the activity took place on.
        object_type:
          type: string
          readOnly: true
          description: When present, shows the model on which the role or relationship was defined.
      required:
      - object1
      - object2
      - operation
    PaginatedCredentialList:
      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/Credential'
    CredentialTypeRequest:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          minLength: 1
          maxLength: 512
        description:
          type:
          - string
          - 'null'
          default: ''
        kind:
          enum:
          - cloud
          - net
          type:
          - string
          - 'null'
          description: '* `cloud` - Cloud\n* `net` - Network'
          x-spec-enum-id: 8c34823df94b101f
        inputs:
          default: {}
          description: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.
        injectors:
          default: {}
          description: Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax.
      required:
      - kind
      - name
    Credential:
      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
        name:
          type:
          - string
          - 'null'
          maxLength: 512
        description:
          type:
          - string
          - 'null'
          default: ''
        organization:
          type:
          - integer
          - 'null'
        credential_type:
          type: integer
          description: Specify the type of credential you want to create. Refer to the documentation for details on each type.
        managed:
          type: boolean
          readOnly: true
        inputs:
          default: {}
          description: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.
        kind:
          type: string
          readOnly: true
        cloud:
          type: string
          readOnly: true
        kubernetes:
          type: string
          readOnly: true
      required:
      - credential_type
      - name
    CredentialType:
      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
        name:
          type:
          - string
          - 'null'
          maxLength: 512
        description:
          type:
          - string
          - 'null'
          default: ''
        kind:
          enum:
          - ssh
          - vault
          - net
          - scm
          - cloud
          - registry
          - token
          - insights
          - external
          - kubernetes
          - galaxy
          - cryptography
          - null
          type:
          - string
          - 'null'
          description: '* `ssh` - Machine

            * `vault` - Vault

            * `net` - Network

            * `scm` - Source Control

            * `cloud` - Cloud

            * `registry` - Container Registry

            * `token` - Personal Access Token

            * `insights` - Insights

            * `external` - External

            * `kubernetes` - Kubernetes

            * `galaxy` - Galaxy/Automation Hub

            * `cryptography` - Cryptography'
          x-spec-enum-id: 8c34823df94b101f
        namespace:
          type:
          - string
          - 'null'
          readOnly: true
        managed:
          type: boolean
          readOnly: true
        inputs:
          default: {}
          description: Enter inputs using either JSON or YAML syntax. Refer to the documentation for example syntax.
        injectors:
          default: {}
          description: Enter injectors using either JSON or YAML syntax. Refer to the documentation for example syntax.
      required:
      - kind
      - name
    PaginatedCredentialTypeList_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/CredentialType_2'
    PatchedCredentialTypeCreate:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        inputs:
          description: Inputs of the credential type
        injectors:
          description: Injectors of the credential type
    CredentialTypeCreate:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        inputs:
          description: Inputs of the credential type
        injectors:
          description: Injectors of the credential type
      required:
      - name
    CredentialTypeTest:
      type: object
      properties:
        inputs:
          description: Inputs of the credential type for test
        metadata:
          description: Metadata of the credential type for testing
      required:
      - inputs
    CredentialType_2:
      type: object
      properties:
        name:
          type: string
        namespace:
          type:
          - string
          - 'null'
        kind:
          type: string
        description:
          type: string
        inputs: {}
        injectors: {}
        id:
          type: integer
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        modified_at:
          type: string
          format: date-time
          readOnly: true
        managed:
          type: boolean
          readOnly: true
      required:
      - created_at
      - id
      - managed
      - modified_at
      - name
  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