Red Hat Ansible Automation Platform Access Policies API

openapi: 3.2.0
info:
  title: Automation Hub Access Policies API
  version: v3
  description: Fetch, Upload, Organize, and Distribute Ansible Collections
  contact:
    name: Automation Hub Team
    email: ansible-galaxy-team@redhat.com
    url: https://www.ansible.com/products/automation-hub
  license:
    name: GPLv2+
    url: https://raw.githubusercontent.com/ansible/galaxy_ng/main/LICENSE
  x-logo:
    url: https://pulp.plan.io/attachments/download/517478/pulp_logo_word_rectangle.svg
  x-pulp-app-versions:
    core: 3.49.40
    galaxy: 4.12.0dev
    ansible: 0.25.1
    container: 2.19.5
    certguard: 3.49.40
    file: 3.49.40
  x-pulp-domain-enabled: false
servers:
- url: http://automation-hub-backend-cwa.automation-hub-prod.svc.cluster.local:8000/
tags:
- name: Access Policies
paths:
  /api/automation-hub/pulp/api/v3/access_policies/:
    get:
      operationId: access_policies_list
      description: 'ViewSet for AccessPolicy.


        NOTE: This API endpoint is in "tech preview" and subject to change'
      summary: List access policys
      parameters:
      - in: query
        name: customized
        schema:
          type: boolean
        description: Filter results where customized matches value
      - name: limit
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - in: query
        name: ordering
        schema:
          type: array
          items:
            type: string
            enum:
            - -creation_hooks
            - -customized
            - -pk
            - -pulp_created
            - -pulp_id
            - -pulp_last_updated
            - -queryset_scoping
            - -statements
            - -viewset_name
            - creation_hooks
            - customized
            - pk
            - pulp_created
            - pulp_id
            - pulp_last_updated
            - queryset_scoping
            - statements
            - viewset_name
        description: 'Ordering


          * `pulp_id` - Pulp id

          * `-pulp_id` - Pulp id (descending)

          * `pulp_created` - Pulp created

          * `-pulp_created` - Pulp created (descending)

          * `pulp_last_updated` - Pulp last updated

          * `-pulp_last_updated` - Pulp last updated (descending)

          * `creation_hooks` - Creation hooks

          * `-creation_hooks` - Creation hooks (descending)

          * `statements` - Statements

          * `-statements` - Statements (descending)

          * `viewset_name` - Viewset name

          * `-viewset_name` - Viewset name (descending)

          * `customized` - Customized

          * `-customized` - Customized (descending)

          * `queryset_scoping` - Queryset scoping

          * `-queryset_scoping` - Queryset scoping (descending)

          * `pk` - Pk

          * `-pk` - Pk (descending)'
        explode: false
        style: form
      - in: query
        name: pulp_href__in
        schema:
          type: array
          items:
            type: string
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: pulp_id__in
        schema:
          type: array
          items:
            type: string
            format: uuid
        description: Multiple values may be separated by commas.
        explode: false
        style: form
      - in: query
        name: q
        schema:
          type: string
      - in: query
        name: viewset_name
        schema:
          type: string
        description: Filter results where viewset_name matches value
      - in: query
        name: viewset_name__contains
        schema:
          type: string
        description: Filter results where viewset_name contains value
      - in: query
        name: viewset_name__icontains
        schema:
          type: string
        description: Filter results where viewset_name contains value
      - in: query
        name: viewset_name__iexact
        schema:
          type: string
        description: Filter results where viewset_name matches value
      - in: query
        name: viewset_name__in
        schema:
          type: array
          items:
            type: string
        description: Filter results where viewset_name is in a comma-separated list of values
        explode: false
        style: form
      - in: query
        name: viewset_name__iregex
        schema:
          type: string
        description: Filter results where viewset_name matches regex value
      - in: query
        name: viewset_name__istartswith
        schema:
          type: string
        description: Filter results where viewset_name starts with value
      - in: query
        name: viewset_name__regex
        schema:
          type: string
        description: Filter results where viewset_name matches regex value
      - in: query
        name: viewset_name__startswith
        schema:
          type: string
        description: Filter results where viewset_name starts with value
      - in: query
        name: fields
        schema:
          type: array
          items:
            type: string
        description: A list of fields to include in the response.
      - in: query
        name: exclude_fields
        schema:
          type: array
          items:
            type: string
        description: A list of fields to exclude from the response.
      tags:
      - Access Policies
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedAccessPolicyResponseList'
          description: ''
  /api/automation-hub/pulp/api/v3/access_policies/{pulp_id}/:
    get:
      operationId: access_policies_read
      description: 'ViewSet for AccessPolicy.


        NOTE: This API endpoint is in "tech preview" and subject to change'
      summary: Inspect an access policy
      parameters:
      - in: path
        name: pulp_id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this access policy.
        required: true
      - in: query
        name: fields
        schema:
          type: array
          items:
            type: string
        description: A list of fields to include in the response.
      - in: query
        name: exclude_fields
        schema:
          type: array
          items:
            type: string
        description: A list of fields to exclude from the response.
      tags:
      - Access Policies
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessPolicyResponse'
          description: ''
    put:
      operationId: access_policies_update
      description: 'ViewSet for AccessPolicy.


        NOTE: This API endpoint is in "tech preview" and subject to change'
      summary: Update an access policy
      parameters:
      - in: path
        name: pulp_id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this access policy.
        required: true
      tags:
      - Access Policies
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccessPolicy'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/AccessPolicy'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/AccessPolicy'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessPolicyResponse'
          description: ''
    patch:
      operationId: access_policies_partial_update
      description: 'ViewSet for AccessPolicy.


        NOTE: This API endpoint is in "tech preview" and subject to change'
      summary: Update an access policy
      parameters:
      - in: path
        name: pulp_id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this access policy.
        required: true
      tags:
      - Access Policies
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedAccessPolicy'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedAccessPolicy'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedAccessPolicy'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessPolicyResponse'
          description: ''
  /api/automation-hub/pulp/api/v3/access_policies/{pulp_id}/reset/:
    post:
      operationId: access_policies_reset
      description: Reset the access policy to its uncustomized default value.
      parameters:
      - in: path
        name: pulp_id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this access policy.
        required: true
      tags:
      - Access Policies
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessPolicyResponse'
          description: ''
      summary: Access policies reset
      x-summary-source: derived
components:
  schemas:
    PatchedAccessPolicy:
      type: object
      description: Serializer for AccessPolicy.
      properties:
        permissions_assignment:
          type: array
          items:
            type: object
          description: List of callables that define the new permissions to be created for new objects.This is deprecated. Use `creation_hooks` instead.
        creation_hooks:
          type: array
          items:
            type: object
          description: List of callables that may associate user roles for new objects.
        statements:
          type: array
          items:
            type: object
          description: List of policy statements defining the policy.
        queryset_scoping:
          type: object
          description: A callable for performing queryset scoping. See plugin documentation for valid callables. Set to blank to turn off queryset scoping.
    AccessPolicy:
      type: object
      description: Serializer for AccessPolicy.
      properties:
        permissions_assignment:
          type: array
          items:
            type: object
          description: List of callables that define the new permissions to be created for new objects.This is deprecated. Use `creation_hooks` instead.
        creation_hooks:
          type: array
          items:
            type: object
          description: List of callables that may associate user roles for new objects.
        statements:
          type: array
          items:
            type: object
          description: List of policy statements defining the policy.
        queryset_scoping:
          type: object
          description: A callable for performing queryset scoping. See plugin documentation for valid callables. Set to blank to turn off queryset scoping.
      required:
      - statements
    PaginatedAccessPolicyResponseList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?offset=400&limit=100
        previous:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?offset=200&limit=100
        results:
          type: array
          items:
            $ref: '#/components/schemas/AccessPolicyResponse'
    AccessPolicyResponse:
      type: object
      description: Serializer for AccessPolicy.
      properties:
        pulp_href:
          type: string
          format: uri
          readOnly: true
        pulp_created:
          type: string
          format: date-time
          readOnly: true
          description: Timestamp of creation.
        pulp_last_updated:
          type: string
          format: date-time
          readOnly: true
          description: 'Timestamp of the last time this resource was updated. Note: for immutable resources - like content, repository versions, and publication - pulp_created and pulp_last_updated dates will be the same.'
        permissions_assignment:
          type: array
          items:
            type: object
          description: List of callables that define the new permissions to be created for new objects.This is deprecated. Use `creation_hooks` instead.
        creation_hooks:
          type: array
          items:
            type: object
          description: List of callables that may associate user roles for new objects.
        statements:
          type: array
          items:
            type: object
          description: List of policy statements defining the policy.
        viewset_name:
          type: string
          readOnly: true
          description: The name of ViewSet this AccessPolicy authorizes.
        customized:
          type: boolean
          readOnly: true
          description: True if the AccessPolicy has been user-modified. False otherwise.
        queryset_scoping:
          type: object
          description: A callable for performing queryset scoping. See plugin documentation for valid callables. Set to blank to turn off queryset scoping.
      required:
      - statements