Red Hat Ansible Automation Platform Api: _Ui V2 Role_Team_Assignments API

openapi: 3.2.0
info:
  title: 'Automation Hub Api: _Ui V2 Role_Team_Assignments 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: 'Api: _Ui V2 Role_Team_Assignments'
paths:
  /api/automation-hub/_ui/v2/role_team_assignments/:
    get:
      operationId: api_automation_hub__ui_v2_role_team_assignments_list
      description: 'Use this endpoint to give a team permission to a resource or an organization.

        The needed data is the team, the role definition, and the object id.

        The object must be of the type specified in the role definition.

        The type given in the role definition and the provided object_id are used

        to look up the resource.


        After creation, the assignment cannot be edited, but can be deleted to

        remove those permissions.'
      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
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      - 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:
      - 'Api: _Ui V2 Role_Team_Assignments'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedRoleTeamAssignmentResponseList'
          description: ''
      summary: Api automation hub ui v2 role team assignments list
      x-summary-source: derived
    post:
      operationId: api_automation_hub__ui_v2_role_team_assignments_create
      description: 'Use this endpoint to give a team permission to a resource or an organization.

        The needed data is the team, the role definition, and the object id.

        The object must be of the type specified in the role definition.

        The type given in the role definition and the provided object_id are used

        to look up the resource.


        After creation, the assignment cannot be edited, but can be deleted to

        remove those permissions.'
      tags:
      - 'Api: _Ui V2 Role_Team_Assignments'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleTeamAssignment'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/RoleTeamAssignment'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/RoleTeamAssignment'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleTeamAssignmentResponse'
          description: ''
      summary: Api automation hub ui v2 role team assignments create
      x-summary-source: derived
  /api/automation-hub/_ui/v2/role_team_assignments/{id}/:
    get:
      operationId: api_automation_hub__ui_v2_role_team_assignments_read
      description: 'Use this endpoint to give a team permission to a resource or an organization.

        The needed data is the team, the role definition, and the object id.

        The object must be of the type specified in the role definition.

        The type given in the role definition and the provided object_id are used

        to look up the resource.


        After creation, the assignment cannot be edited, but can be deleted to

        remove those permissions.'
      parameters:
      - in: path
        name: id
        schema:
          type: string
        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:
      - 'Api: _Ui V2 Role_Team_Assignments'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleTeamAssignmentResponse'
          description: ''
      summary: Api automation hub ui v2 role team assignments read
      x-summary-source: derived
    delete:
      operationId: api_automation_hub__ui_v2_role_team_assignments_delete
      description: 'Use this endpoint to give a team permission to a resource or an organization.

        The needed data is the team, the role definition, and the object id.

        The object must be of the type specified in the role definition.

        The type given in the role definition and the provided object_id are used

        to look up the resource.


        After creation, the assignment cannot be edited, but can be deleted to

        remove those permissions.'
      parameters:
      - in: path
        name: id
        schema:
          type: string
        required: true
      tags:
      - 'Api: _Ui V2 Role_Team_Assignments'
      responses:
        '204':
          description: No response body
      summary: Api automation hub ui v2 role team assignments delete
      x-summary-source: derived
components:
  schemas:
    PaginatedRoleTeamAssignmentResponseList:
      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/RoleTeamAssignmentResponse'
    RoleTeamAssignmentResponse:
      type: object
      properties:
        id:
          type: integer
          format: int64
          readOnly: true
        url:
          type: string
          readOnly: true
        related:
          type: object
          additionalProperties:
            type: string
          readOnly: true
        summary_fields:
          type: object
          additionalProperties:
            type: object
          readOnly: true
        created:
          type: string
          format: date-time
          readOnly: true
          description: The date/time this resource was created.
        created_by:
          type:
          - integer
          - 'null'
          format: int64
          readOnly: true
          description: The user who created this resource.
        content_type:
          type: string
          description: String to use for references to this type from other models in the API.
          readOnly: true
        object_id:
          type:
          - string
          - 'null'
          description: The primary key of the object this assignment applies to; null value indicates system-wide assignment.
        object_ansible_id:
          type:
          - string
          - 'null'
          format: uuid
          description: The resource id of the object this role applies to. An alternative to the object_id field.
        role_definition:
          type: integer
          format: int64
          description: The role definition which defines permissions conveyed by this assignment.
        team:
          type: integer
          format: int64
        team_ansible_id:
          type:
          - string
          - 'null'
          format: uuid
          description: The resource ID of the team who will receive permissions from this assignment. An alternative to team field.
      required:
      - role_definition
    RoleTeamAssignment:
      type: object
      properties:
        object_id:
          type:
          - string
          - 'null'
          description: The primary key of the object this assignment applies to; null value indicates system-wide assignment.
        object_ansible_id:
          type:
          - string
          - 'null'
          format: uuid
          description: The resource id of the object this role applies to. An alternative to the object_id field.
        role_definition:
          type: integer
          format: int64
          description: The role definition which defines permissions conveyed by this assignment.
        team:
          type: integer
          format: int64
        team_ansible_id:
          type:
          - string
          - 'null'
          format: uuid
          description: The resource ID of the team who will receive permissions from this assignment. An alternative to team field.
      required:
      - role_definition