Red Hat Ansible Automation Platform Role Team Access API

openapi: 3.2.0
info:
  title: Red Hat Ansible Automation Platform Role Team Access API
  version: '1.0'
  description: 'Operations tagged role_team_access across 3 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, red-hat-ansible-automation-platform-platform-gateway-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: /api/eda/v1
tags:
- name: role_team_access
paths:
  /api/v2/role_team_access/{model_name}/{id}/:
    get:
      operationId: role_team_access_list
      description: 'Use this endpoint to get a list of users who have access to a resource.

        This is a list-only view that provides a list of users, plus extra data.'
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^([0-9]+|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$
        required: true
      - in: path
        name: model_name
        schema:
          type: string
        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:
      - role_team_access
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedTeamAccessViewSet_Team_List'
          description: ''
      x-ai-description: List all role team access
      summary: Role team access list
      x-summary-source: derived
  /api/v2/role_team_access/{model_name}/{id}/{actor_id}/:
    get:
      operationId: role_team_access_list_2
      description: 'This gives drill-down information about the means of inheritance

        for all the permissions show in the higher-level view of the access list'
      parameters:
      - in: path
        name: actor_id
        schema:
          type: string
        required: true
      - in: path
        name: id
        schema:
          type: string
          pattern: ^([0-9]+|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$
        required: true
      - in: path
        name: model_name
        schema:
          type: string
        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:
      - role_team_access
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedTeamAccessAssignmentList'
          description: ''
      x-ai-description: List all role team access
      summary: Role team access list 2
      x-summary-source: derived
  /role_team_access/{model_name}/{id}/:
    get:
      operationId: getRoleTeamAccessByModelNameById
      description: 'Use this endpoint to get a list of users who have access to a resource.

        This is a list-only view that provides a list of users, plus extra data.'
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^([0-9]+|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$
        required: true
      - in: path
        name: model_name
        schema:
          type: string
        required: true
      - 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
      tags:
      - role_team_access
      security:
      - EDAJWTAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedTeamAccessViewSet_Team_List_2'
          description: ''
      summary: Role team access list
      x-summary-source: derived
      x-operation-id-source: normalized
      x-operation-id-original: role_team_access_list
    servers:
    - url: /api/eda/v1
  /role_team_access/{model_name}/{id}/{actor_pk}/:
    get:
      operationId: getRoleTeamAccessByModelNameByIdByActorPk
      description: 'This gives drill-down information about the means of inheritance

        for all the permissions show in the higher-level view of the access list'
      parameters:
      - in: path
        name: actor_pk
        schema:
          type: string
        required: true
      - in: path
        name: id
        schema:
          type: string
          pattern: ^([0-9]+|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$
        required: true
      - in: path
        name: model_name
        schema:
          type: string
        required: true
      - 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
      tags:
      - role_team_access
      security:
      - EDAJWTAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedTeamAccessAssignmentList_2'
          description: ''
      summary: Role team access list 2
      x-summary-source: derived
      x-operation-id-source: normalized
      x-operation-id-original: role_team_access_list_2
    servers:
    - url: /api/eda/v1
  /api/gateway/v1/role_team_access/{model_name}/{id}/:
    get:
      operationId: getApiGatewayV1RoleTeamAccessByModelNameById
      description: 'Use this endpoint to get a list of users who have access to a resource.

        This is a list-only view that provides a list of users, plus extra data.'
      parameters:
      - in: path
        name: id
        schema:
          type: string
          pattern: ^([0-9]+|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$
        required: true
      - in: path
        name: model_name
        schema:
          type: string
        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:
      - role_team_access
      security:
      - OAuth2_Authentication: []
      - SessionAuthentication: []
      - Basic_Authentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedTeamAccessViewSet_Team_List'
          description: ''
      x-ai-description: List all role team access
      summary: Role team access list
      x-summary-source: derived
      x-operation-id-source: normalized
      x-operation-id-original: role_team_access_list
  /api/gateway/v1/role_team_access/{model_name}/{id}/{actor_pk}/:
    get:
      operationId: getApiGatewayV1RoleTeamAccessByModelNameByIdByActorPk
      description: 'This gives drill-down information about the means of inheritance

        for all the permissions show in the higher-level view of the access list'
      parameters:
      - in: path
        name: actor_pk
        schema:
          type: string
        required: true
      - in: path
        name: id
        schema:
          type: string
          pattern: ^([0-9]+|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$
        required: true
      - in: path
        name: model_name
        schema:
          type: string
        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:
      - role_team_access
      security:
      - OAuth2_Authentication: []
      - SessionAuthentication: []
      - Basic_Authentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedTeamAccessAssignmentList'
          description: ''
      x-ai-description: List all role team access
      summary: Role team access list 2
      x-summary-source: derived
      x-operation-id-source: normalized
      x-operation-id-original: role_team_access_list_2
components:
  schemas:
    PaginatedTeamAccessViewSet_Team_List:
      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/TeamAccessViewSet_Team_'
    TeamAccessAssignment:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        url:
          type: string
          readOnly: true
        related:
          type: object
          additionalProperties:
            type: string
          readOnly: true
        summary_fields:
          type: object
          additionalProperties:
            type: object
            additionalProperties: {}
          readOnly: true
        created:
          type: string
          format: date-time
          readOnly: true
          description: The date/time this resource was created.
        created_by:
          type:
          - integer
          - 'null'
          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
          description: The role definition which defines permissions conveyed by this assignment.
        team:
          type:
          - integer
          - 'null'
        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
    TeamAccessViewSet_Team_:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        url:
          type: string
          readOnly: true
        related:
          type: object
          additionalProperties:
            type: string
          readOnly: true
        name:
          type: string
          maxLength: 512
        organization:
          type: integer
        object_role_assignments:
          type: string
          readOnly: true
      required:
      - name
      - organization
    PaginatedTeamAccessAssignmentList:
      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/TeamAccessAssignment'
    PaginatedTeamAccessViewSet_Team_List_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/TeamAccessViewSet_Team__2'
    TeamAccessAssignment_2:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        url:
          type: string
          readOnly: true
        related:
          type: object
          additionalProperties:
            type: string
          readOnly: true
        summary_fields:
          type: object
          additionalProperties:
            type: object
            additionalProperties: true
          readOnly: true
        created:
          type: string
          format: date-time
          readOnly: true
          description: The date/time this resource was created.
        created_by:
          type:
          - integer
          - 'null'
          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
          description: The role definition which defines permissions conveyed by this assignment.
        team:
          type:
          - integer
          - 'null'
        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:
      - content_type
      - created
      - created_by
      - id
      - related
      - role_definition
      - summary_fields
      - url
    TeamAccessViewSet_Team__2:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        url:
          type: string
          readOnly: true
        related:
          type: object
          additionalProperties:
            type: string
          readOnly: true
        name:
          type: string
          description: The name of this resource.
          maxLength: 512
        organization:
          type: integer
          description: The organization of this team.
        object_role_assignments:
          type: string
          readOnly: true
      required:
      - id
      - name
      - object_role_assignments
      - organization
      - related
      - url
    PaginatedTeamAccessAssignmentList_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/TeamAccessAssignment_2'
    TeamAccessViewSet_Team__3:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        url:
          type: string
          readOnly: true
        related:
          type: object
          additionalProperties:
            type: string
          readOnly: true
        name:
          type: string
          description: The name of this resource.
          maxLength: 512
        organization:
          type: integer
          description: The organization of this team.
        object_role_assignments:
          type: string
          readOnly: true
      required:
      - name
      - organization
  securitySchemes:
    EDAJWTAuthentication:
      type: apiKey
      name: X-DAB-JW-TOKEN
      in: header
    cookieAuth:
      type: apiKey
      in: cookie
      name: sessionid
    Basic_Authentication:
      type: http
      scheme: basic
    OAuth2_Authentication:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: /o/authorize/
          tokenUrl: /o/token/
          scopes:
            read: Read access to resources
            write: Write access to resources (includes read)
        password:
          tokenUrl: /o/token/
          scopes:
            read: Read access to resources
            write: Write access to resources (includes read)
    SessionAuthentication:
      type: apiKey
      in: cookie
      name: gateway_sessionid
x-refined-from:
- red-hat-ansible-automation-platform-automation-controller-openapi.json
- red-hat-ansible-automation-platform-event-driven-ansible-openapi.json
- red-hat-ansible-automation-platform-platform-gateway-openapi.json