Red Hat Ansible Automation Platform Role User Assignments API

openapi: 3.2.0
info:
  title: Red Hat Ansible Automation Platform Role User Assignments…
  version: '1.0'
  description: 'Operations tagged role_user_assignments 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_user_assignments
paths:
  /api/v2/role_user_assignments/:
    get:
      operationId: role_user_assignments_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:
      - role_user_assignments
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedRoleUserAssignmentList'
          description: ''
      x-ai-description: List RBAC role grants assigning permissions to users for specific resources
      summary: Role user assignments list
      x-summary-source: derived
    post:
      operationId: role_user_assignments_create
      description: Give a user permission to a resource, an organization, or globally (when allowed). Must specify 'role_definition' and exactly one of 'user' or 'user_ansible_id'. Can specify at most one of 'object_id' or 'object_ansible_id' (omit both for global roles). The content_type of 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:
      - role_user_assignments
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/RoleUserAssignment'
              - description: 'Must provide exactly one of: user (integer ID) or user_ansible_id (UUID). Mutual exclusivity enforced by server validation.'
                properties:
                  user:
                    type:
                    - integer
                    - 'null'
                    description: ID of the user to assign the role to. Mutually exclusive with user_ansible_id.
                  user_ansible_id:
                    type:
                    - string
                    - 'null'
                    format: uuid
                    description: Ansible ID of the user to assign the role to. Mutually exclusive with user.
              - description: 'Can provide at most one of: object_id or object_ansible_id. Omit both for global role assignments. Mutual exclusivity enforced by server validation.'
                properties:
                  object_id:
                    oneOf:
                    - type: integer
                    - type: string
                      format: uuid
                    description: ID of the resource object. Mutually exclusive with object_ansible_id.
                  object_ansible_id:
                    type:
                    - string
                    - 'null'
                    format: uuid
                    description: Ansible ID of the resource object. Mutually exclusive with object_id.
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleUserAssignment'
          description: ''
      x-ai-description: Create a RBAC role grants assigning permissions to user for specific resources
      summary: Role user assignments create
      x-summary-source: derived
  /api/v2/role_user_assignments/{id}/:
    get:
      operationId: role_user_assignments_retrieve
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this role user assignment.
        required: true
      tags:
      - role_user_assignments
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleUserAssignment'
          description: ''
      x-ai-description: Retrieve a RBAC role grants assigning permissions to user for specific resources
      summary: Role user assignments retrieve
      x-summary-source: derived
    delete:
      operationId: role_user_assignments_destroy
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this role user assignment.
        required: true
      tags:
      - role_user_assignments
      responses:
        '204':
          description: No response body
      x-ai-description: Delete a RBAC role grants assigning permissions to user for specific resources
      summary: Role user assignments destroy
      x-summary-source: derived
  /role_user_assignments/:
    get:
      operationId: getRoleUserAssignments
      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
      tags:
      - role_user_assignments
      security:
      - EDAJWTAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedRoleUserAssignmentList_2'
          description: ''
      summary: Role user assignments list
      x-summary-source: derived
      x-operation-id-source: normalized
      x-operation-id-original: role_user_assignments_list
    post:
      operationId: postRoleUserAssignments
      description: Create a RoleUserAssignment.
      tags:
      - role_user_assignments
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RoleUserAssignmentCreate'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/RoleUserAssignmentCreate'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/RoleUserAssignmentCreate'
        required: true
      security:
      - EDAJWTAuthentication: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleUserAssignment_2'
          description: Return a created RoleUserAssignment.
      summary: Role user assignments create
      x-summary-source: derived
      x-operation-id-source: normalized
      x-operation-id-original: role_user_assignments_create
    servers:
    - url: /api/eda/v1
  /role_user_assignments/{id}/:
    get:
      operationId: getRoleUserAssignmentsById
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this role user assignment.
        required: true
      tags:
      - role_user_assignments
      security:
      - EDAJWTAuthentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleUserAssignment_2'
          description: ''
      summary: Role user assignments retrieve
      x-summary-source: derived
      x-operation-id-source: normalized
      x-operation-id-original: role_user_assignments_retrieve
    delete:
      operationId: deleteRoleUserAssignmentsById
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this role user assignment.
        required: true
      tags:
      - role_user_assignments
      security:
      - EDAJWTAuthentication: []
      responses:
        '204':
          description: No response body
      summary: Role user assignments destroy
      x-summary-source: derived
      x-operation-id-source: normalized
      x-operation-id-original: role_user_assignments_destroy
    servers:
    - url: /api/eda/v1
  /api/gateway/v1/role_user_assignments/:
    get:
      operationId: getApiGatewayV1RoleUserAssignments
      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:
      - role_user_assignments
      security:
      - OAuth2_Authentication: []
      - SessionAuthentication: []
      - Basic_Authentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedRoleUserAssignmentList'
          description: ''
      x-ai-description: List RBAC role grants assigning permissions to users for specific resources
      summary: Role user assignments list
      x-summary-source: derived
      x-operation-id-source: normalized
      x-operation-id-original: role_user_assignments_list
    post:
      operationId: postApiGatewayV1RoleUserAssignments
      description: Give a user permission to a resource, an organization, or globally (when allowed). Must specify 'role_definition' and exactly one of 'user' or 'user_ansible_id'. Can specify at most one of 'object_id' or 'object_ansible_id' (omit both for global roles). The content_type of 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:
      - role_user_assignments
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/RoleUserAssignment'
              - description: 'Must provide exactly one of: user (integer ID) or user_ansible_id (UUID). Mutual exclusivity enforced by server validation.'
                properties:
                  user:
                    type:
                    - integer
                    - 'null'
                    description: ID of the user to assign the role to. Mutually exclusive with user_ansible_id.
                  user_ansible_id:
                    type:
                    - string
                    - 'null'
                    format: uuid
                    description: Ansible ID of the user to assign the role to. Mutually exclusive with user.
              - description: 'Can provide at most one of: object_id or object_ansible_id. Omit both for global role assignments. Mutual exclusivity enforced by server validation.'
                properties:
                  object_id:
                    oneOf:
                    - type: integer
                    - type: string
                      format: uuid
                    description: ID of the resource object. Mutually exclusive with object_ansible_id.
                  object_ansible_id:
                    type:
                    - string
                    - 'null'
                    format: uuid
                    description: Ansible ID of the resource object. Mutually exclusive with object_id.
      security:
      - OAuth2_Authentication: []
      - SessionAuthentication: []
      - Basic_Authentication: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleUserAssignment'
          description: ''
      x-ai-description: Create a RBAC role grants assigning permissions to user for specific resources
      summary: Role user assignments create
      x-summary-source: derived
      x-operation-id-source: normalized
      x-operation-id-original: role_user_assignments_create
  /api/gateway/v1/role_user_assignments/{id}/:
    get:
      operationId: getApiGatewayV1RoleUserAssignmentsById
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this role user assignment.
        required: true
      tags:
      - role_user_assignments
      security:
      - OAuth2_Authentication: []
      - SessionAuthentication: []
      - Basic_Authentication: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoleUserAssignment'
          description: ''
      x-ai-description: Retrieve a RBAC role grants assigning permissions to user for specific resources
      summary: Role user assignments retrieve
      x-summary-source: derived
      x-operation-id-source: normalized
      x-operation-id-original: role_user_assignments_retrieve
    delete:
      operationId: deleteApiGatewayV1RoleUserAssignmentsById
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this role user assignment.
        required: true
      tags:
      - role_user_assignments
      security:
      - OAuth2_Authentication: []
      - SessionAuthentication: []
      - Basic_Authentication: []
      responses:
        '204':
          description: No response body
      x-ai-description: Delete a RBAC role grants assigning permissions to user for specific resources
      summary: Role user assignments destroy
      x-summary-source: derived
      x-operation-id-source: normalized
      x-operation-id-original: role_user_assignments_destroy
components:
  schemas:
    PaginatedRoleUserAssignmentList:
      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/RoleUserAssignment'
    RoleUserAssignment:
      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.
        user:
          type:
          - integer
          - 'null'
        user_ansible_id:
          type:
          - string
          - 'null'
          format: uuid
          description: The resource ID of the user who will receive permissions from this assignment. An alternative to user field.
      required:
      - role_definition
    PaginatedRoleUserAssignmentList_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/RoleUserAssignment_2'
    RoleUserAssignmentCreate:
      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
          description: The role definition which defines permissions conveyed by this assignment.
        user:
          type:
          - integer
          - 'null'
        user_ansible_id:
          type:
          - string
          - 'null'
          format: uuid
          description: The resource ID of the user who will receive permissions from this assignment. An alternative to user field.
      required:
      - role_definition
    RoleUserAssignment_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.
        user:
          type:
          - integer
          - 'null'
        user_ansible_id:
          type:
          - string
          - 'null'
          format: uuid
          description: The resource ID of the user who will receive permissions from this assignment. An alternative to user field.
      required:
      - content_type
      - created
      - created_by
      - id
      - related
      - role_definition
      - summary_fields
      - url
  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