openapi: 3.2.0 info: title: Red Hat Ansible Automation Platform Organizations API version: '1.0' description: 'Operations tagged organizations 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: Organizations paths: /api/v2/organizations/: get: operationId: organizations_retrieve tags: - Organizations responses: '200': description: No response body x-ai-description: Retrieve an organization summary: Organizations retrieve x-summary-source: derived post: operationId: organizations_create tags: - Organizations responses: '201': description: No response body x-ai-description: Create an organization summary: Organizations create x-summary-source: derived /api/v2/organizations/{id}/: get: operationId: organizations_retrieve_2 parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Organizations responses: '200': content: application/json: schema: $ref: '#/components/schemas/Organization' description: '' x-ai-description: Retrieve an organization summary: Organizations retrieve 2 x-summary-source: derived put: operationId: organizations_update parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Organizations requestBody: content: application/json: schema: $ref: '#/components/schemas/OrganizationRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/Organization' description: '' x-ai-description: Update an organization summary: Organizations update x-summary-source: derived patch: operationId: organizations_partial_update parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Organizations requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedOrganizationRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Organization' description: '' x-ai-description: Update an organization summary: Organizations partial update x-summary-source: derived delete: operationId: organizations_destroy parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Organizations responses: '204': description: No response body x-ai-description: Delete an organization summary: Organizations destroy x-summary-source: derived /api/v2/organizations/{id}/access_list/: get: operationId: organizations_access_list_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: - Organizations responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedResourceAccessListElementList' description: '' x-ai-description: List users who can access the organization summary: Organizations access list list x-summary-source: derived /api/v2/organizations/{id}/activity_stream/: get: operationId: organizations_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: - Organizations responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedActivityStreamList' description: '' x-ai-description: List activity stream for an organization summary: Organizations activity stream list x-summary-source: derived /api/v2/organizations/{id}/admins/: get: operationId: organizations_admins_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: - Organizations responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedUserList' description: '' x-ai-description: List all admins for an organization summary: Organizations admins list x-summary-source: derived post: operationId: organizations_admins_create parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Organizations requestBody: content: application/json: schema: $ref: '#/components/schemas/UserRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/User' description: '' x-ai-description: Create new admin for an organization summary: Organizations admins create x-summary-source: derived /api/v2/organizations/{id}/credentials/: get: operationId: organizations_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: - Organizations responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedOrganizationCredentialSerializerCreateList' description: '' x-ai-description: List credentials of an organization summary: Organizations credentials list x-summary-source: derived post: operationId: organizations_credentials_create parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Organizations requestBody: content: application/json: schema: $ref: '#/components/schemas/OrganizationCredentialSerializerCreateRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/OrganizationCredentialSerializerCreate' description: '' x-ai-description: Create a credential of an organization summary: Organizations credentials create x-summary-source: derived /api/v2/organizations/{id}/execution_environments/: get: operationId: organizations_execution_environments_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: - Organizations responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedExecutionEnvironmentList' description: '' x-ai-description: List execution environments of an organization summary: Organizations execution environments list x-summary-source: derived post: operationId: organizations_execution_environments_create parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Organizations requestBody: content: application/json: schema: $ref: '#/components/schemas/ExecutionEnvironmentRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/ExecutionEnvironment' description: '' x-ai-description: Associate an execution environment with an organization by default. summary: Organizations execution environments create x-summary-source: derived /api/v2/organizations/{id}/galaxy_credentials/: get: operationId: organizations_galaxy_credentials_list description: Derived version of SubListCreateAttachDetachAPIView that prohibits creation 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: - Organizations responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedCredentialList' description: '' x-ai-description: List all credentials for an organization summary: Organizations galaxy credentials list x-summary-source: derived post: operationId: organizations_galaxy_credentials_create description: Derived version of SubListCreateAttachDetachAPIView that prohibits creation parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Organizations 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: Associate a Galaxy credential with an organization for syncing content. summary: Organizations galaxy credentials create x-summary-source: derived /api/v2/organizations/{id}/instance_groups/: get: operationId: organizations_instance_groups_list description: 'This mixin overloads attach/detach so that it calls Organization.save(), to ensure instance group updates are persisted' 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: - Organizations responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedInstanceGroupList' description: '' x-ai-description: List instance groups of an organization summary: Organizations instance groups list x-summary-source: derived post: operationId: organizations_instance_groups_create description: 'This mixin overloads attach/detach so that it calls Organization.save(), to ensure instance group updates are persisted' parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Organizations requestBody: content: application/json: schema: $ref: '#/components/schemas/InstanceGroupRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/InstanceGroup' description: '' x-ai-description: Associate an instance group with an organization. summary: Organizations instance groups create x-summary-source: derived /api/v2/organizations/{id}/inventories/: get: operationId: organizations_inventories_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: - Organizations responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedInventoryList' description: '' x-ai-description: List inventories of an organization summary: Organizations inventories list x-summary-source: derived /api/v2/organizations/{id}/job_templates/: get: operationId: organizations_job_templates_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: - Organizations responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedJobTemplateList' description: '' x-ai-description: List job templates of an organization summary: Organizations job templates list x-summary-source: derived post: operationId: organizations_job_templates_create parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Organizations requestBody: content: application/json: schema: $ref: '#/components/schemas/JobTemplateRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/JobTemplate' description: '' x-ai-description: Create a job template of an organization summary: Organizations job templates create x-summary-source: derived /api/v2/organizations/{id}/notification_templates/: get: operationId: organizations_notification_templates_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: - Organizations responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedNotificationTemplateList' description: '' x-ai-description: List notification templates of an organization summary: Organizations notification templates list x-summary-source: derived post: operationId: organizations_notification_templates_create parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Organizations requestBody: content: application/json: schema: $ref: '#/components/schemas/NotificationTemplateRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/NotificationTemplate' description: '' x-ai-description: Create a notification template of an organization summary: Organizations notification templates create x-summary-source: derived /api/v2/organizations/{id}/notification_templates_approvals/: get: operationId: organizations_notification_templates_approvals_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: - Organizations responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedNotificationTemplateList' description: '' x-ai-description: List all approvals for an organization summary: Organizations notification templates approvals list x-summary-source: derived post: operationId: organizations_notification_templates_approvals_create parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Organizations requestBody: content: application/json: schema: $ref: '#/components/schemas/NotificationTemplateRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/NotificationTemplate' description: '' x-ai-description: Create new approval for an organization summary: Organizations notification templates approvals create x-summary-source: derived /api/v2/organizations/{id}/notification_templates_error/: get: operationId: organizations_notification_templates_error_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: - Organizations responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedNotificationTemplateList' description: '' x-ai-description: List all error for an organization summary: Organizations notification templates error list x-summary-source: derived post: operationId: organizations_notification_templates_error_create parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Organizations requestBody: content: application/json: schema: $ref: '#/components/schemas/NotificationTemplateRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/NotificationTemplate' description: '' x-ai-description: Create new error for an organization summary: Organizations notification templates error create x-summary-source: derived /api/v2/organizations/{id}/notification_templates_started/: get: operationId: organizations_notification_templates_started_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: - Organizations responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedNotificationTemplateList' description: '' x-ai-description: List all started for an organization summary: Organizations notification templates started list x-summary-source: derived post: operationId: organizations_notification_templates_started_create parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Organizations requestBody: content: application/json: schema: $ref: '#/components/schemas/NotificationTemplateRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/NotificationTemplate' description: '' x-ai-description: Create new started for an organization summary: Organizations notification templates started create x-summary-source: derived /api/v2/organizations/{id}/notification_templates_success/: get: operationId: organizations_notification_templates_success_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: - Organizations responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedNotificationTemplateList' description: '' x-ai-description: List all success for an organization summary: Organizations notification templates success list x-summary-source: derived post: operationId: organizations_notification_templates_success_create parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Organizations requestBody: content: application/json: schema: $ref: '#/components/schemas/NotificationTemplateRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/NotificationTemplate' description: '' x-ai-description: Create new success for an organization summary: Organizations notification templates success create x-summary-source: derived /api/v2/organizations/{id}/object_roles/: get: operationId: organizations_object_roles_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: - Organizations responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedRoleList' description: '' x-ai-description: List roles of an organization summary: Organizations object roles list x-summary-source: derived /api/v2/organizations/{id}/projects/: get: operationId: organizations_projects_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: - Organizations responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedProjectList' description: '' x-ai-description: List projects of an organization summary: Organizations projects list x-summary-source: derived post: operationId: organizations_projects_create parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Organizations requestBody: content: application/json: schema: $ref: '#/components/schemas/ProjectRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/Project' description: '' x-ai-description: Create a project of an organization summary: Organizations projects create x-summary-source: derived /api/v2/organizations/{id}/teams/: get: operationId: organizations_teams_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: - Organizations responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedTeamList' description: '' x-ai-description: List teams of an organization summary: Organizations teams list x-summary-source: derived post: operationId: organizations_teams_create parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Organizations requestBody: content: application/json: schema: $ref: '#/components/schemas/TeamRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/Team' description: '' x-ai-description: Create a team of an organization summary: Organizations teams create x-summary-source: derived /api/v2/organizations/{id}/users/: get: operationId: organizations_users_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: - Organizations responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedUserList' description: '' x-ai-description: List users of an organization summary: Organizations users list x-summary-source: derived post: operationId: organizations_users_create parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Organizations requestBody: content: application/json: schema: $ref: '#/components/schemas/UserRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/User' description: '' x-ai-description: Create a user of an organization summary: Organizations users create x-summary-source: derived /api/v2/organizations/{id}/workflow_job_templates/: get: operationId: organizations_workflow_job_templates_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: - Organizations responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedWorkflowJobTemplateList' description: '' x-ai-description: List workflow job templates of an organization summary: Organizations workflow job templates list x-summary-source: derived post: operationId: organizations_workflow_job_templates_create parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Organizations requestBody: content: application/json: schema: $ref: '#/components/schemas/WorkflowJobTemplateRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/WorkflowJobTemplate' description: '' x-ai-description: Create a workflow job template of an organization summary: Organizations workflow job templates create x-summary-source: derived /organizations/: get: operationId: organizations_list description: List all organizations. parameters: - in: query name: description schema: type: string description: Filter by organization description. - in: query name: name schema: type: string description: Filter by organization name. - 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: resource__ansible_id schema: type: string description: Filter by resource ansible ID. tags: - Organizations security: - EDAJWTAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedOrganizationList' description: Return a list of organizations. summary: Organizations list x-summary-source: derived servers: - url: /api/eda/v1 /organizations/{id}/teams/: get: operationId: getOrganizationsByIdTeams description: List all teams of the organization parameters: - in: query name: description schema: type: string description: Filter by team description. - in: path name: id schema: type: integer description: A unique integer value identifying this organization. required: true - in: query name: name schema: type: string description: Filter by team name. - 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: resource__ansible_id schema: type: string description: Filter by resource ansible ID. tags: - Organizations security: - EDAJWTAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedTeamList_2' description: '' summary: Organizations teams list x-summary-source: derived x-operation-id-source: normalized x-operation-id-original: organizations_teams_list servers: - url: /api/eda/v1 /organizations/{id}/: get: operationId: getOrganizationsById parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this organization. required: true tags: - Organizations security: - EDAJWTAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Organization_2' description: '' summary: Organizations retrieve x-summary-source: derived x-operation-id-source: normalized x-operation-id-original: organizations_retrieve servers: - url: /api/eda/v1 /api/gateway/v1/organizations/: get: operationId: getApiGatewayV1Organizations description: API endpoint that allows organizations to be viewed or edited. parameters: - in: query name: created schema: type: string description: Filter by created (exact match) - in: query name: created__gt schema: type: string description: Filter by created (gt) - in: query name: created__gte schema: type: string description: Filter by created (gte) - in: query name: created__lt schema: type: string description: Filter by created (lt) - in: query name: created__lte schema: type: string description: Filter by created (lte) - in: query name: created_by schema: type: string description: Filter by created_by (exact match) - in: query name: description schema: type: string description: Filter by description (exact match) - in: query name: description__icontains schema: type: string description: Filter by description (case-insensitive partial match) - in: query name: id schema: type: string description: Filter by id (exact match) - in: query name: id__gt schema: type: string description: Filter by id (gt) - in: query name: id__gte schema: type: string description: Filter by id (gte) - in: query name: id__lt schema: type: string description: Filter by id (lt) - in: query name: id__lte schema: type: string description: Filter by id (lte) - in: query name: managed schema: type: string description: Filter by managed (exact match) - in: query name: modified schema: type: string description: Filter by modified (exact match) - in: query name: modified__gt schema: type: string description: Filter by modified (gt) - in: query name: modified__gte schema: type: string description: Filter by modified (gte) - in: query name: modified__lt schema: type: string description: Filter by modified (lt) - in: query name: modified__lte schema: type: string description: Filter by modified (lte) - in: query name: modified_by schema: type: string description: Filter by modified_by (exact match) - in: query name: name schema: type: string description: Filter by name (exact match) - in: query name: name__icontains schema: type: string description: Filter by name (case-insensitive partial match) - 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: resource schema: type: string description: Filter by resource (exact match) - 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: - Organizations security: - OAuth2_Authentication: [] - SessionAuthentication: [] - Basic_Authentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedOrganizationList_2' description: '' x-ai-description: List logical collection of users, teams, and resources for organizing access control summary: Organizations list x-summary-source: derived x-operation-id-source: normalized x-operation-id-original: organizations_list post: operationId: postApiGatewayV1Organizations description: API endpoint that allows organizations to be viewed or edited. tags: - Organizations requestBody: content: application/json: schema: $ref: '#/components/schemas/Organization_3' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Organization_3' multipart/form-data: schema: $ref: '#/components/schemas/Organization_3' required: true security: - OAuth2_Authentication: [] - SessionAuthentication: [] - Basic_Authentication: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Organization_3' description: '' x-ai-description: Create a logical collection of users, teams, and resource for organizing access control summary: Organizations create x-summary-source: derived x-operation-id-source: normalized x-operation-id-original: organizations_create /api/gateway/v1/organizations/{id}/: get: operationId: getApiGatewayV1OrganizationsById description: API endpoint that allows organizations to be viewed or edited. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this organization. required: true tags: - Organizations security: - OAuth2_Authentication: [] - SessionAuthentication: [] - Basic_Authentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Organization_3' description: '' x-ai-description: Retrieve a logical collection of users, teams, and resource for organizing access control summary: Organizations retrieve x-summary-source: derived x-operation-id-source: normalized x-operation-id-original: organizations_retrieve put: operationId: putApiGatewayV1OrganizationsById description: API endpoint that allows organizations to be viewed or edited. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this organization. required: true tags: - Organizations requestBody: content: application/json: schema: $ref: '#/components/schemas/Organization_3' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Organization_3' multipart/form-data: schema: $ref: '#/components/schemas/Organization_3' required: true security: - OAuth2_Authentication: [] - SessionAuthentication: [] - Basic_Authentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Organization_3' description: '' x-ai-description: Update a logical collection of users, teams, and resource for organizing access control summary: Organizations update x-summary-source: derived x-operation-id-source: normalized x-operation-id-original: organizations_update patch: operationId: patchApiGatewayV1OrganizationsById description: API endpoint that allows organizations to be viewed or edited. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this organization. required: true tags: - Organizations requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedOrganization' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedOrganization' multipart/form-data: schema: $ref: '#/components/schemas/PatchedOrganization' security: - OAuth2_Authentication: [] - SessionAuthentication: [] - Basic_Authentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Organization_3' description: '' x-ai-description: Update a logical collection of users, teams, and resource for organizing access control summary: Organizations partial update x-summary-source: derived x-operation-id-source: normalized x-operation-id-original: organizations_partial_update delete: operationId: deleteApiGatewayV1OrganizationsById description: API endpoint that allows organizations to be viewed or edited. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this organization. required: true tags: - Organizations security: - OAuth2_Authentication: [] - SessionAuthentication: [] - Basic_Authentication: [] responses: '204': description: No response body x-ai-description: Delete a logical collection of users, teams, and resource for organizing access control summary: Organizations destroy x-summary-source: derived x-operation-id-source: normalized x-operation-id-original: organizations_destroy /api/gateway/v1/organizations/{id}/admins/: get: operationId: getApiGatewayV1OrganizationsByIdAdmins description: 'Manage User objects in the ''admins'' relationship of this particular Organization. Starting from the detail URL: GET /:id/admins/ to show users currently in the relationship POST a list of instances to /:id/admins/associate/ to add those users to the relationship POST a list of instances to /:id/admins/disassociate/ to remove those users from the relationshp' parameters: - in: query name: created schema: type: string description: Filter by created (exact match) - in: query name: created__gt schema: type: string description: Filter by created (gt) - in: query name: created__gte schema: type: string description: Filter by created (gte) - in: query name: created__lt schema: type: string description: Filter by created (lt) - in: query name: created__lte schema: type: string description: Filter by created (lte) - in: query name: created_by schema: type: string description: Filter by created_by (exact match) - in: query name: date_joined schema: type: string description: Filter by date_joined (exact match) - in: query name: date_joined__gt schema: type: string description: Filter by date_joined (gt) - in: query name: date_joined__gte schema: type: string description: Filter by date_joined (gte) - in: query name: date_joined__lt schema: type: string description: Filter by date_joined (lt) - in: query name: date_joined__lte schema: type: string description: Filter by date_joined (lte) - in: query name: email schema: type: string description: Filter by email (exact match) - in: query name: email__icontains schema: type: string description: Filter by email (case-insensitive partial match) - in: query name: first_name schema: type: string description: Filter by first_name (exact match) - in: query name: first_name__icontains schema: type: string description: Filter by first_name (case-insensitive partial match) - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true - in: query name: id schema: type: string description: Filter by id (exact match) - in: query name: id__gt schema: type: string description: Filter by id (gt) - in: query name: id__gte schema: type: string description: Filter by id (gte) - in: query name: id__lt schema: type: string description: Filter by id (lt) - in: query name: id__lte schema: type: string description: Filter by id (lte) - in: query name: is_active schema: type: string description: Filter by is_active (exact match) - in: query name: is_staff schema: type: string description: Filter by is_staff (exact match) - in: query name: is_superuser schema: type: string description: Filter by is_superuser (exact match) - in: query name: last_login schema: type: string description: Filter by last_login (exact match) - in: query name: last_login__gt schema: type: string description: Filter by last_login (gt) - in: query name: last_login__gte schema: type: string description: Filter by last_login (gte) - in: query name: last_login__lt schema: type: string description: Filter by last_login (lt) - in: query name: last_login__lte schema: type: string description: Filter by last_login (lte) - in: query name: last_login_from schema: type: string description: Filter by last_login_from (exact match) - in: query name: last_name schema: type: string description: Filter by last_name (exact match) - in: query name: last_name__icontains schema: type: string description: Filter by last_name (case-insensitive partial match) - in: query name: managed schema: type: string description: Filter by managed (exact match) - in: query name: modified schema: type: string description: Filter by modified (exact match) - in: query name: modified__gt schema: type: string description: Filter by modified (gt) - in: query name: modified__gte schema: type: string description: Filter by modified (gte) - in: query name: modified__lt schema: type: string description: Filter by modified (lt) - in: query name: modified__lte schema: type: string description: Filter by modified (lte) - in: query name: modified_by schema: type: string description: Filter by modified_by (exact match) - 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: password schema: type: string description: Filter by password (exact match) - in: query name: password__icontains schema: type: string description: Filter by password (case-insensitive partial match) - in: query name: resource schema: type: string description: Filter by resource (exact match) - 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. - in: query name: username schema: type: string description: Filter by username (exact match) - in: query name: username__icontains schema: type: string description: Filter by username (case-insensitive partial match) tags: - Organizations security: - OAuth2_Authentication: [] - SessionAuthentication: [] - Basic_Authentication: [] deprecated: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedUserList' description: '' x-ai-description: List all admins for an organization summary: Organizations admins list x-summary-source: derived x-operation-id-source: normalized x-operation-id-original: organizations_admins_list /api/gateway/v1/organizations/{id}/admins/associate/: post: operationId: organizations_admins_associate_create description: 'Manage User objects in the ''admins'' relationship of this particular Organization. Starting from the detail URL: GET /:id/admins/ to show users currently in the relationship POST a list of instances to /:id/admins/associate/ to add those users to the relationship POST a list of instances to /:id/admins/disassociate/ to remove those users from the relationshp' parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Organizations requestBody: content: application/json: schema: $ref: '#/components/schemas/UserAssociate' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UserAssociate' multipart/form-data: schema: $ref: '#/components/schemas/UserAssociate' required: true security: - OAuth2_Authentication: [] - SessionAuthentication: [] - Basic_Authentication: [] deprecated: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserAssociate' description: '' x-ai-description: Associate admins with an organization summary: Organizations admins associate create x-summary-source: derived /api/gateway/v1/organizations/{id}/admins/disassociate/: post: operationId: organizations_admins_disassociate_create description: 'Manage User objects in the ''admins'' relationship of this particular Organization. Starting from the detail URL: GET /:id/admins/ to show users currently in the relationship POST a list of instances to /:id/admins/associate/ to add those users to the relationship POST a list of instances to /:id/admins/disassociate/ to remove those users from the relationshp' parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Organizations requestBody: content: application/json: schema: $ref: '#/components/schemas/UserDisassociate' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UserDisassociate' multipart/form-data: schema: $ref: '#/components/schemas/UserDisassociate' required: true security: - OAuth2_Authentication: [] - SessionAuthentication: [] - Basic_Authentication: [] deprecated: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserDisassociate' description: '' x-ai-description: Disassociate admins from an organization summary: Organizations admins disassociate create x-summary-source: derived /api/gateway/v1/organizations/{id}/teams/: get: operationId: getApiGatewayV1OrganizationsByIdTeams description: 'Manage Team objects in the ''teams'' relationship of this particular Organization. Starting from the detail URL: GET /:id/teams/ to show teams currently in the relationship' parameters: - in: query name: created schema: type: string description: Filter by created (exact match) - in: query name: created__gt schema: type: string description: Filter by created (gt) - in: query name: created__gte schema: type: string description: Filter by created (gte) - in: query name: created__lt schema: type: string description: Filter by created (lt) - in: query name: created__lte schema: type: string description: Filter by created (lte) - in: query name: created_by schema: type: string description: Filter by created_by (exact match) - in: query name: description schema: type: string description: Filter by description (exact match) - in: query name: description__icontains schema: type: string description: Filter by description (case-insensitive partial match) - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true - in: query name: id schema: type: string description: Filter by id (exact match) - in: query name: id__gt schema: type: string description: Filter by id (gt) - in: query name: id__gte schema: type: string description: Filter by id (gte) - in: query name: id__lt schema: type: string description: Filter by id (lt) - in: query name: id__lte schema: type: string description: Filter by id (lte) - in: query name: modified schema: type: string description: Filter by modified (exact match) - in: query name: modified__gt schema: type: string description: Filter by modified (gt) - in: query name: modified__gte schema: type: string description: Filter by modified (gte) - in: query name: modified__lt schema: type: string description: Filter by modified (lt) - in: query name: modified__lte schema: type: string description: Filter by modified (lte) - in: query name: modified_by schema: type: string description: Filter by modified_by (exact match) - in: query name: name schema: type: string description: Filter by name (exact match) - in: query name: name__icontains schema: type: string description: Filter by name (case-insensitive partial match) - 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. - in: query name: organization schema: type: string description: Filter by organization (exact match) - 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: resource schema: type: string description: Filter by resource (exact match) - 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: - Organizations security: - OAuth2_Authentication: [] - SessionAuthentication: [] - Basic_Authentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedTeamList' description: '' x-ai-description: List organization subdivisions that group users for bulk permission assignment and role-based access control summary: Organizations teams list x-summary-source: derived x-operation-id-source: normalized x-operation-id-original: organizations_teams_list /api/gateway/v1/organizations/{id}/users/: get: operationId: getApiGatewayV1OrganizationsByIdUsers description: 'Manage User objects in the ''users'' relationship of this particular Organization. Starting from the detail URL: GET /:id/users/ to show users currently in the relationship POST a list of instances to /:id/users/associate/ to add those users to the relationship POST a list of instances to /:id/users/disassociate/ to remove those users from the relationshp' parameters: - in: query name: created schema: type: string description: Filter by created (exact match) - in: query name: created__gt schema: type: string description: Filter by created (gt) - in: query name: created__gte schema: type: string description: Filter by created (gte) - in: query name: created__lt schema: type: string description: Filter by created (lt) - in: query name: created__lte schema: type: string description: Filter by created (lte) - in: query name: created_by schema: type: string description: Filter by created_by (exact match) - in: query name: date_joined schema: type: string description: Filter by date_joined (exact match) - in: query name: date_joined__gt schema: type: string description: Filter by date_joined (gt) - in: query name: date_joined__gte schema: type: string description: Filter by date_joined (gte) - in: query name: date_joined__lt schema: type: string description: Filter by date_joined (lt) - in: query name: date_joined__lte schema: type: string description: Filter by date_joined (lte) - in: query name: email schema: type: string description: Filter by email (exact match) - in: query name: email__icontains schema: type: string description: Filter by email (case-insensitive partial match) - in: query name: first_name schema: type: string description: Filter by first_name (exact match) - in: query name: first_name__icontains schema: type: string description: Filter by first_name (case-insensitive partial match) - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true - in: query name: id schema: type: string description: Filter by id (exact match) - in: query name: id__gt schema: type: string description: Filter by id (gt) - in: query name: id__gte schema: type: string description: Filter by id (gte) - in: query name: id__lt schema: type: string description: Filter by id (lt) - in: query name: id__lte schema: type: string description: Filter by id (lte) - in: query name: is_active schema: type: string description: Filter by is_active (exact match) - in: query name: is_staff schema: type: string description: Filter by is_staff (exact match) - in: query name: is_superuser schema: type: string description: Filter by is_superuser (exact match) - in: query name: last_login schema: type: string description: Filter by last_login (exact match) - in: query name: last_login__gt schema: type: string description: Filter by last_login (gt) - in: query name: last_login__gte schema: type: string description: Filter by last_login (gte) - in: query name: last_login__lt schema: type: string description: Filter by last_login (lt) - in: query name: last_login__lte schema: type: string description: Filter by last_login (lte) - in: query name: last_login_from schema: type: string description: Filter by last_login_from (exact match) - in: query name: last_name schema: type: string description: Filter by last_name (exact match) - in: query name: last_name__icontains schema: type: string description: Filter by last_name (case-insensitive partial match) - in: query name: managed schema: type: string description: Filter by managed (exact match) - in: query name: modified schema: type: string description: Filter by modified (exact match) - in: query name: modified__gt schema: type: string description: Filter by modified (gt) - in: query name: modified__gte schema: type: string description: Filter by modified (gte) - in: query name: modified__lt schema: type: string description: Filter by modified (lt) - in: query name: modified__lte schema: type: string description: Filter by modified (lte) - in: query name: modified_by schema: type: string description: Filter by modified_by (exact match) - 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: password schema: type: string description: Filter by password (exact match) - in: query name: password__icontains schema: type: string description: Filter by password (case-insensitive partial match) - in: query name: resource schema: type: string description: Filter by resource (exact match) - 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. - in: query name: username schema: type: string description: Filter by username (exact match) - in: query name: username__icontains schema: type: string description: Filter by username (case-insensitive partial match) tags: - Organizations security: - OAuth2_Authentication: [] - SessionAuthentication: [] - Basic_Authentication: [] deprecated: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedUserList' description: '' x-ai-description: List all users for an organization summary: Organizations users list x-summary-source: derived x-operation-id-source: normalized x-operation-id-original: organizations_users_list /api/gateway/v1/organizations/{id}/users/associate/: post: operationId: organizations_users_associate_create description: 'Manage User objects in the ''users'' relationship of this particular Organization. Starting from the detail URL: GET /:id/users/ to show users currently in the relationship POST a list of instances to /:id/users/associate/ to add those users to the relationship POST a list of instances to /:id/users/disassociate/ to remove those users from the relationshp' parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Organizations requestBody: content: application/json: schema: $ref: '#/components/schemas/UserAssociate' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UserAssociate' multipart/form-data: schema: $ref: '#/components/schemas/UserAssociate' required: true security: - OAuth2_Authentication: [] - SessionAuthentication: [] - Basic_Authentication: [] deprecated: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserAssociate' description: '' x-ai-description: Associate users with an organization summary: Organizations users associate create x-summary-source: derived /api/gateway/v1/organizations/{id}/users/disassociate/: post: operationId: organizations_users_disassociate_create description: 'Manage User objects in the ''users'' relationship of this particular Organization. Starting from the detail URL: GET /:id/users/ to show users currently in the relationship POST a list of instances to /:id/users/associate/ to add those users to the relationship POST a list of instances to /:id/users/disassociate/ to remove those users from the relationshp' parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Organizations requestBody: content: application/json: schema: $ref: '#/components/schemas/UserDisassociate' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/UserDisassociate' multipart/form-data: schema: $ref: '#/components/schemas/UserDisassociate' required: true security: - OAuth2_Authentication: [] - SessionAuthentication: [] - Basic_Authentication: [] deprecated: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserDisassociate' description: '' x-ai-description: Disassociate users from an organization summary: Organizations users disassociate create x-summary-source: derived components: schemas: InstanceGroup: type: object properties: id: type: integer readOnly: true type: type: string readOnly: true url: type: string readOnly: true related: type: string readOnly: true name: type: - string - 'null' maxLength: 250 created: type: string readOnly: true modified: type: string readOnly: true capacity: type: string readOnly: true consumed_capacity: type: string readOnly: true percent_capacity_remaining: type: string readOnly: true jobs_running: type: string readOnly: true max_concurrent_jobs: type: integer minimum: 0 default: 0 description: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. max_forks: type: integer minimum: 0 default: 0 description: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. jobs_total: type: integer readOnly: true description: Count of all jobs that target this instance group instances: type: string readOnly: true is_container_group: type: boolean description: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. credential: type: - integer - 'null' policy_instance_percentage: type: integer maximum: 100 minimum: 0 default: 0 description: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. policy_instance_minimum: type: integer minimum: 0 default: 0 description: Static minimum number of Instances that will be automatically assign to this group when new instances come online. policy_instance_list: type: array items: type: string description: List of exact-match Instances that will be assigned to this group pod_spec_override: type: - string - 'null' default: '' summary_fields: type: string readOnly: true required: - name PaginatedUserList: 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/User' 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' OrganizationCredentialSerializerCreate: 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' description: Inherit permissions from organization roles. If provided on creation, do not give either user or team. 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 PaginatedInventoryList: 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/Inventory' ExecutionEnvironment: 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' description: The organization used to determine access to this execution environment. image: type: - string - 'null' title: Image location description: The full image location, including the container registry, image name, and version tag. maxLength: 1024 managed: type: boolean readOnly: true credential: type: - integer - 'null' pull: enum: - always - missing - never - '' - null type: - string - 'null' x-spec-enum-id: 63475462f6c34286 default: '' description: 'Pull image before running? * `always` - Always pull container before running. * `missing` - Only pull the image if not present before running. * `never` - Never pull container before running.' required: - image - name PaginatedProjectList: 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/Project' NotificationTemplateRequest: type: object properties: name: type: - string - 'null' minLength: 1 maxLength: 512 description: type: - string - 'null' default: '' organization: type: - integer - 'null' notification_type: enum: - awssns - email - grafana - irc - mattermost - pagerduty - rocketchat - slack - twilio - webhook - null type: - string - 'null' description: '* `awssns` - AWS SNS * `email` - Email * `grafana` - Grafana * `irc` - IRC * `mattermost` - Mattermost * `pagerduty` - Pagerduty * `rocketchat` - Rocket.Chat * `slack` - Slack * `twilio` - Twilio * `webhook` - Webhook' x-spec-enum-id: 867d131dea32a033 notification_configuration: default: {} messages: default: started: null success: null error: null workflow_approval: null description: Optional custom messages for notification template. required: - name - notification_type - organization NotificationTemplate: 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' notification_type: enum: - awssns - email - grafana - irc - mattermost - pagerduty - rocketchat - slack - twilio - webhook - null type: - string - 'null' description: '* `awssns` - AWS SNS * `email` - Email * `grafana` - Grafana * `irc` - IRC * `mattermost` - Mattermost * `pagerduty` - Pagerduty * `rocketchat` - Rocket.Chat * `slack` - Slack * `twilio` - Twilio * `webhook` - Webhook' x-spec-enum-id: 867d131dea32a033 notification_configuration: default: {} messages: default: started: null success: null error: null workflow_approval: null description: Optional custom messages for notification template. required: - name - notification_type - organization TeamRequest: type: object properties: name: type: - string - 'null' minLength: 1 maxLength: 512 description: type: - string - 'null' default: '' organization: type: integer required: - name - organization ExecutionEnvironmentRequest: type: object properties: name: type: - string - 'null' minLength: 1 maxLength: 512 description: type: - string - 'null' default: '' organization: type: - integer - 'null' description: The organization used to determine access to this execution environment. image: type: - string - 'null' minLength: 1 title: Image location description: The full image location, including the container registry, image name, and version tag. maxLength: 1024 credential: type: - integer - 'null' pull: enum: - always - missing - never - '' - null type: - string - 'null' x-spec-enum-id: 63475462f6c34286 default: '' description: 'Pull image before running? * `always` - Always pull container before running. * `missing` - Only pull the image if not present before running. * `never` - Never pull container before running.' required: - image - name ProjectRequest: type: object properties: name: type: - string - 'null' minLength: 1 maxLength: 512 description: type: - string - 'null' default: '' local_path: type: - string - 'null' description: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. maxLength: 1024 scm_type: enum: - '' - git - svn - insights - archive - null type: - string - 'null' x-spec-enum-id: 18ccf5bfb5c453d7 default: '' description: 'Specifies the source control system used to store the project. * `` - Manual * `git` - Git * `svn` - Subversion * `insights` - Red Hat Insights * `archive` - Remote Archive' scm_url: type: - string - 'null' default: '' description: The location where the project is stored. maxLength: 1024 scm_branch: type: - string - 'null' default: '' description: Specific branch, tag or commit to checkout. maxLength: 256 scm_refspec: type: - string - 'null' default: '' description: For git projects, an additional refspec to fetch. maxLength: 1024 scm_clean: type: - boolean - 'null' default: false description: Discard any local changes before syncing the project. scm_track_submodules: type: - boolean - 'null' default: false description: Track submodules latest commits on defined branch. scm_delete_on_update: type: - boolean - 'null' default: false description: Delete the project before syncing. credential: type: - integer - 'null' timeout: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 default: 0 description: The amount of time (in seconds) to run before the task is canceled. organization: type: - integer - 'null' description: The organization used to determine access to this template. scm_update_on_launch: type: - boolean - 'null' default: false description: Update the project when a job is launched that uses the project. scm_update_cache_timeout: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 default: 0 description: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. allow_override: type: - boolean - 'null' default: false description: Allow changing the SCM branch or revision in a job template that uses this project. default_environment: type: - integer - 'null' description: The default execution environment for jobs run using this project. signature_validation_credential: type: - integer - 'null' description: An optional credential used for validating files in the project against unexpected changes. required: - name PaginatedResourceAccessListElementList: 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/ResourceAccessListElement' ResourceAccessListElement: 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 username: type: - string - 'null' description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. pattern: ^[\w.@+-]+$ maxLength: 150 first_name: type: - string - 'null' maxLength: 150 last_name: type: - string - 'null' maxLength: 150 email: type: - string - 'null' title: Email address maxLength: 254 is_superuser: type: - boolean - 'null' default: false title: Superuser status description: Designates that this user has all permissions without explicitly assigning them. is_system_auditor: type: boolean default: false password: type: string default: '' description: Field used to change the password. last_login: type: - string - 'null' format: date-time readOnly: true required: - username UserRequest: type: object properties: username: type: - string - 'null' minLength: 1 description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. pattern: ^[\w.@+-]+$ maxLength: 150 first_name: type: - string - 'null' maxLength: 150 last_name: type: - string - 'null' maxLength: 150 email: type: - string - 'null' title: Email address maxLength: 254 is_superuser: type: - boolean - 'null' default: false title: Superuser status description: Designates that this user has all permissions without explicitly assigning them. is_system_auditor: type: boolean default: false password: type: string default: '' description: Field used to change the password. required: - username JobTemplate: type: object description: Provide recent jobs and survey details in summary_fields 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: '' job_type: enum: - run - check - null type: - string - 'null' description: '* `run` - Run * `check` - Check' x-spec-enum-id: 726608a431c1f104 default: run inventory: type: - integer - 'null' project: type: - integer - 'null' playbook: type: - string - 'null' default: '' maxLength: 1024 scm_branch: type: - string - 'null' default: '' description: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. maxLength: 1024 forks: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 default: 0 limit: type: - string - 'null' default: '' verbosity: enum: - 0 - 1 - 2 - 3 - 4 - 5 type: integer description: '* `0` - 0 (Normal) * `1` - 1 (Verbose) * `2` - 2 (More Verbose) * `3` - 3 (Debug) * `4` - 4 (Connection Debug) * `5` - 5 (WinRM Debug)' x-spec-enum-id: 8cfb81af905b865a default: 0 minimum: 0 maximum: 9223372036854775807 extra_vars: type: - string - 'null' default: '' job_tags: type: - string - 'null' default: '' force_handlers: type: - boolean - 'null' default: false skip_tags: type: - string - 'null' default: '' start_at_task: type: - string - 'null' default: '' maxLength: 1024 timeout: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 default: 0 description: The amount of time (in seconds) to run before the task is canceled. use_fact_cache: type: - boolean - 'null' default: false description: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. organization: type: - integer - 'null' readOnly: true description: The organization used to determine access to this template. last_job_run: type: - string - 'null' format: date-time readOnly: true last_job_failed: type: boolean readOnly: true next_job_run: type: - string - 'null' format: date-time readOnly: true status: enum: - new - pending - waiting - running - successful - failed - error - canceled - never updated type: string description: '* `new` - New * `pending` - Pending * `waiting` - Waiting * `running` - Running * `successful` - Successful * `failed` - Failed * `error` - Error * `canceled` - Canceled * `never updated` - Never Updated' x-spec-enum-id: 91b42427ee973322 readOnly: true execution_environment: type: - integer - 'null' description: The container image to be used for execution. host_config_key: type: - string - 'null' default: '' maxLength: 1024 ask_scm_branch_on_launch: type: - boolean - 'null' default: false ask_diff_mode_on_launch: type: - boolean - 'null' default: false ask_variables_on_launch: type: - boolean - 'null' default: false ask_limit_on_launch: type: - boolean - 'null' default: false ask_tags_on_launch: type: - boolean - 'null' default: false ask_skip_tags_on_launch: type: - boolean - 'null' default: false ask_job_type_on_launch: type: - boolean - 'null' default: false ask_verbosity_on_launch: type: - boolean - 'null' default: false ask_inventory_on_launch: type: - boolean - 'null' default: false ask_credential_on_launch: type: - boolean - 'null' default: false ask_execution_environment_on_launch: type: - boolean - 'null' default: false ask_labels_on_launch: type: - boolean - 'null' default: false ask_forks_on_launch: type: - boolean - 'null' default: false ask_job_slice_count_on_launch: type: - boolean - 'null' default: false ask_timeout_on_launch: type: - boolean - 'null' default: false ask_instance_groups_on_launch: type: - boolean - 'null' default: false survey_enabled: type: - boolean - 'null' default: false become_enabled: type: - boolean - 'null' default: false diff_mode: type: - boolean - 'null' default: false description: If enabled, textual changes made to any templated files on the host are shown in the standard output allow_simultaneous: type: - boolean - 'null' default: false custom_virtualenv: type: - string - 'null' readOnly: true description: Local absolute file path containing a custom Python virtualenv to use job_slice_count: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 default: 1 description: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. webhook_service: enum: - github - gitlab - bitbucket_dc - '' - null type: - string - 'null' x-spec-enum-id: eee3a42406ba2781 description: 'Service that webhook requests will be accepted from * `github` - GitHub * `gitlab` - GitLab * `bitbucket_dc` - BitBucket DataCenter' webhook_credential: type: - integer - 'null' description: Personal Access Token for posting back the status to the service API prevent_instance_group_fallback: type: - boolean - 'null' default: false description: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. opa_query_path: type: - string - 'null' description: The query path for the OPA policy to evaluate prior to job execution. The query path should be formatted as package/rule. maxLength: 128 required: - name JobTemplateRequest: type: object description: Provide recent jobs and survey details in summary_fields properties: name: type: - string - 'null' minLength: 1 maxLength: 512 description: type: - string - 'null' default: '' job_type: enum: - run - check - null type: - string - 'null' description: '* `run` - Run * `check` - Check' x-spec-enum-id: 726608a431c1f104 default: run inventory: type: - integer - 'null' project: type: - integer - 'null' playbook: type: - string - 'null' default: '' maxLength: 1024 scm_branch: type: - string - 'null' default: '' description: Branch to use in job run. Project default used if blank. Only allowed if project allow_override field is set to true. maxLength: 1024 forks: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 default: 0 limit: type: - string - 'null' default: '' verbosity: enum: - 0 - 1 - 2 - 3 - 4 - 5 type: integer description: '* `0` - 0 (Normal) * `1` - 1 (Verbose) * `2` - 2 (More Verbose) * `3` - 3 (Debug) * `4` - 4 (Connection Debug) * `5` - 5 (WinRM Debug)' x-spec-enum-id: 8cfb81af905b865a default: 0 minimum: 0 maximum: 9223372036854775807 extra_vars: type: - string - 'null' default: '' job_tags: type: - string - 'null' default: '' force_handlers: type: - boolean - 'null' default: false skip_tags: type: - string - 'null' default: '' start_at_task: type: - string - 'null' default: '' maxLength: 1024 timeout: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 default: 0 description: The amount of time (in seconds) to run before the task is canceled. use_fact_cache: type: - boolean - 'null' default: false description: If enabled, the service will act as an Ansible Fact Cache Plugin; persisting facts at the end of a playbook run to the database and caching facts for use by Ansible. execution_environment: type: - integer - 'null' description: The container image to be used for execution. host_config_key: type: - string - 'null' default: '' maxLength: 1024 ask_scm_branch_on_launch: type: - boolean - 'null' default: false ask_diff_mode_on_launch: type: - boolean - 'null' default: false ask_variables_on_launch: type: - boolean - 'null' default: false ask_limit_on_launch: type: - boolean - 'null' default: false ask_tags_on_launch: type: - boolean - 'null' default: false ask_skip_tags_on_launch: type: - boolean - 'null' default: false ask_job_type_on_launch: type: - boolean - 'null' default: false ask_verbosity_on_launch: type: - boolean - 'null' default: false ask_inventory_on_launch: type: - boolean - 'null' default: false ask_credential_on_launch: type: - boolean - 'null' default: false ask_execution_environment_on_launch: type: - boolean - 'null' default: false ask_labels_on_launch: type: - boolean - 'null' default: false ask_forks_on_launch: type: - boolean - 'null' default: false ask_job_slice_count_on_launch: type: - boolean - 'null' default: false ask_timeout_on_launch: type: - boolean - 'null' default: false ask_instance_groups_on_launch: type: - boolean - 'null' default: false survey_enabled: type: - boolean - 'null' default: false become_enabled: type: - boolean - 'null' default: false diff_mode: type: - boolean - 'null' default: false description: If enabled, textual changes made to any templated files on the host are shown in the standard output allow_simultaneous: type: - boolean - 'null' default: false job_slice_count: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 default: 1 description: The number of jobs to slice into at runtime. Will cause the Job Template to launch a workflow if value is greater than 1. webhook_service: enum: - github - gitlab - bitbucket_dc - '' - null type: - string - 'null' x-spec-enum-id: eee3a42406ba2781 description: 'Service that webhook requests will be accepted from * `github` - GitHub * `gitlab` - GitLab * `bitbucket_dc` - BitBucket DataCenter' webhook_credential: type: - integer - 'null' description: Personal Access Token for posting back the status to the service API prevent_instance_group_fallback: type: - boolean - 'null' default: false description: If enabled, the job template will prevent adding any inventory or organization instance groups to the list of preferred instances groups to run on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. opa_query_path: type: - string - 'null' description: The query path for the OPA policy to evaluate prior to job execution. The query path should be formatted as package/rule. maxLength: 128 required: - name PaginatedTeamList: 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/Team' PaginatedInstanceGroupList: 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/InstanceGroup' 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 Project: 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: '' local_path: type: - string - 'null' description: Local path (relative to PROJECTS_ROOT) containing playbooks and related files for this project. maxLength: 1024 scm_type: enum: - '' - git - svn - insights - archive - null type: - string - 'null' x-spec-enum-id: 18ccf5bfb5c453d7 default: '' description: 'Specifies the source control system used to store the project. * `` - Manual * `git` - Git * `svn` - Subversion * `insights` - Red Hat Insights * `archive` - Remote Archive' scm_url: type: - string - 'null' default: '' description: The location where the project is stored. maxLength: 1024 scm_branch: type: - string - 'null' default: '' description: Specific branch, tag or commit to checkout. maxLength: 256 scm_refspec: type: - string - 'null' default: '' description: For git projects, an additional refspec to fetch. maxLength: 1024 scm_clean: type: - boolean - 'null' default: false description: Discard any local changes before syncing the project. scm_track_submodules: type: - boolean - 'null' default: false description: Track submodules latest commits on defined branch. scm_delete_on_update: type: - boolean - 'null' default: false description: Delete the project before syncing. credential: type: - integer - 'null' timeout: type: integer maximum: 9223372036854775807 minimum: -9223372036854775808 format: int64 default: 0 description: The amount of time (in seconds) to run before the task is canceled. scm_revision: type: string readOnly: true description: The last revision fetched by a project update last_job_run: type: - string - 'null' format: date-time readOnly: true last_job_failed: type: boolean readOnly: true next_job_run: type: - string - 'null' format: date-time readOnly: true status: enum: - new - pending - waiting - running - successful - failed - error - canceled - never updated - ok - missing type: string description: '* `new` - New * `pending` - Pending * `waiting` - Waiting * `running` - Running * `successful` - Successful * `failed` - Failed * `error` - Error * `canceled` - Canceled * `never updated` - Never Updated * `ok` - OK * `missing` - Missing' x-spec-enum-id: 6d29d630b4939828 readOnly: true organization: type: - integer - 'null' description: The organization used to determine access to this template. scm_update_on_launch: type: - boolean - 'null' default: false description: Update the project when a job is launched that uses the project. scm_update_cache_timeout: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 default: 0 description: The number of seconds after the last project update ran that a new project update will be launched as a job dependency. allow_override: type: - boolean - 'null' default: false description: Allow changing the SCM branch or revision in a job template that uses this project. custom_virtualenv: type: - string - 'null' readOnly: true description: Local absolute file path containing a custom Python virtualenv to use default_environment: type: - integer - 'null' description: The default execution environment for jobs run using this project. signature_validation_credential: type: - integer - 'null' description: An optional credential used for validating files in the project against unexpected changes. last_update_failed: type: boolean readOnly: true last_updated: type: string format: date-time readOnly: true required: - name OrganizationRequest: type: object properties: name: type: - string - 'null' minLength: 1 maxLength: 512 description: type: - string - 'null' default: '' max_hosts: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 default: 0 description: Maximum number of hosts allowed to be managed by this organization. default_environment: type: - integer - 'null' description: The default execution environment for jobs run by this organization. opa_query_path: type: - string - 'null' description: The query path for the OPA policy to evaluate prior to job execution. The query path should be formatted as package/rule. maxLength: 128 required: - 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 Organization: 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: '' max_hosts: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 default: 0 description: Maximum number of hosts allowed to be managed by this organization. custom_virtualenv: type: - string - 'null' readOnly: true description: Local absolute file path containing a custom Python virtualenv to use default_environment: type: - integer - 'null' description: The default execution environment for jobs run by this organization. opa_query_path: type: - string - 'null' description: The query path for the OPA policy to evaluate prior to job execution. The query path should be formatted as package/rule. maxLength: 128 required: - name Team: 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 required: - name - organization PaginatedJobTemplateList: 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/JobTemplate' PaginatedNotificationTemplateList: 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/NotificationTemplate' User: 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 username: type: - string - 'null' description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. pattern: ^[\w.@+-]+$ maxLength: 150 first_name: type: - string - 'null' maxLength: 150 last_name: type: - string - 'null' maxLength: 150 email: type: - string - 'null' title: Email address maxLength: 254 is_superuser: type: - boolean - 'null' default: false title: Superuser status description: Designates that this user has all permissions without explicitly assigning them. is_system_auditor: type: boolean default: false password: type: string default: '' description: Field used to change the password. last_login: type: - string - 'null' format: date-time readOnly: true required: - username PaginatedWorkflowJobTemplateList: 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/WorkflowJobTemplate' PaginatedOrganizationCredentialSerializerCreateList: 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/OrganizationCredentialSerializerCreate' Role: 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 name: type: string readOnly: true description: type: string readOnly: true InstanceGroupRequest: type: object properties: name: type: - string - 'null' minLength: 1 maxLength: 250 max_concurrent_jobs: type: integer minimum: 0 default: 0 description: Maximum number of concurrent jobs to run on a group. When set to zero, no maximum is enforced. max_forks: type: integer minimum: 0 default: 0 description: Maximum number of forks to execute concurrently on a group. When set to zero, no maximum is enforced. is_container_group: type: boolean description: Indicates whether instances in this group are containerized.Containerized groups have a designated Openshift or Kubernetes cluster. credential: type: - integer - 'null' policy_instance_percentage: type: integer maximum: 100 minimum: 0 default: 0 description: Minimum percentage of all instances that will be automatically assigned to this group when new instances come online. policy_instance_minimum: type: integer minimum: 0 default: 0 description: Static minimum number of Instances that will be automatically assign to this group when new instances come online. policy_instance_list: type: array items: type: string minLength: 1 description: List of exact-match Instances that will be assigned to this group pod_spec_override: type: - string - 'null' default: '' required: - name PatchedOrganizationRequest: type: object properties: name: type: - string - 'null' minLength: 1 maxLength: 512 description: type: - string - 'null' default: '' max_hosts: type: integer maximum: 9223372036854775807 minimum: 0 format: int64 default: 0 description: Maximum number of hosts allowed to be managed by this organization. default_environment: type: - integer - 'null' description: The default execution environment for jobs run by this organization. opa_query_path: type: - string - 'null' description: The query path for the OPA policy to evaluate prior to job execution. The query path should be formatted as package/rule. maxLength: 128 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' PaginatedRoleList: 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/Role' WorkflowJobTemplateRequest: type: object description: Provide recent jobs and survey details in summary_fields properties: name: type: - string - 'null' minLength: 1 maxLength: 512 description: type: - string - 'null' default: '' extra_vars: type: - string - 'null' default: '' organization: type: - integer - 'null' description: The organization used to determine access to this template. survey_enabled: type: - boolean - 'null' default: false allow_simultaneous: type: - boolean - 'null' default: false ask_variables_on_launch: type: - boolean - 'null' default: false inventory: type: - integer - 'null' description: Inventory applied as a prompt, assuming job template prompts for inventory limit: type: - string - 'null' scm_branch: type: - string - 'null' ask_inventory_on_launch: type: - boolean - 'null' default: false ask_scm_branch_on_launch: type: - boolean - 'null' default: false ask_limit_on_launch: type: - boolean - 'null' default: false webhook_service: enum: - github - gitlab - bitbucket_dc - '' - null type: - string - 'null' x-spec-enum-id: eee3a42406ba2781 description: 'Service that webhook requests will be accepted from * `github` - GitHub * `gitlab` - GitLab * `bitbucket_dc` - BitBucket DataCenter' webhook_credential: type: - integer - 'null' description: Personal Access Token for posting back the status to the service API ask_labels_on_launch: type: - boolean - 'null' default: false ask_skip_tags_on_launch: type: - boolean - 'null' default: false ask_tags_on_launch: type: - boolean - 'null' default: false skip_tags: type: - string - 'null' job_tags: type: - string - 'null' required: - name WorkflowJobTemplate: type: object description: Provide recent jobs and survey details in summary_fields 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: '' last_job_run: type: - string - 'null' format: date-time readOnly: true last_job_failed: type: boolean readOnly: true next_job_run: type: - string - 'null' format: date-time readOnly: true status: enum: - new - pending - waiting - running - successful - failed - error - canceled - never updated - ok - missing - none - updating type: string description: '* `new` - New * `pending` - Pending * `waiting` - Waiting * `running` - Running * `successful` - Successful * `failed` - Failed * `error` - Error * `canceled` - Canceled * `never updated` - Never Updated * `ok` - OK * `missing` - Missing * `none` - No External Source * `updating` - Updating' x-spec-enum-id: b387d72f4f16647d readOnly: true extra_vars: type: - string - 'null' default: '' organization: type: - integer - 'null' description: The organization used to determine access to this template. survey_enabled: type: - boolean - 'null' default: false allow_simultaneous: type: - boolean - 'null' default: false ask_variables_on_launch: type: - boolean - 'null' default: false inventory: type: - integer - 'null' description: Inventory applied as a prompt, assuming job template prompts for inventory limit: type: - string - 'null' scm_branch: type: - string - 'null' ask_inventory_on_launch: type: - boolean - 'null' default: false ask_scm_branch_on_launch: type: - boolean - 'null' default: false ask_limit_on_launch: type: - boolean - 'null' default: false webhook_service: enum: - github - gitlab - bitbucket_dc - '' - null type: - string - 'null' x-spec-enum-id: eee3a42406ba2781 description: 'Service that webhook requests will be accepted from * `github` - GitHub * `gitlab` - GitLab * `bitbucket_dc` - BitBucket DataCenter' webhook_credential: type: - integer - 'null' description: Personal Access Token for posting back the status to the service API ask_labels_on_launch: type: - boolean - 'null' default: false ask_skip_tags_on_launch: type: - boolean - 'null' default: false ask_tags_on_launch: type: - boolean - 'null' default: false skip_tags: type: - string - 'null' job_tags: type: - string - 'null' required: - name Inventory: 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' description: Organization containing this inventory. kind: enum: - '' - smart - constructed - null type: - string - 'null' x-spec-enum-id: 2ff9e8df76c2ad0e default: '' description: 'Kind of inventory being represented. * `` - Hosts have a direct link to this inventory. * `smart` - Hosts for inventory generated using the host_filter property. * `constructed` - Parse list of source inventories with the constructed inventory plugin.' host_filter: type: - string - 'null' description: Filter that will be applied to the hosts of this inventory. variables: type: - string - 'null' default: '' description: Inventory variables in JSON or YAML format. has_active_failures: type: boolean readOnly: true description: This field is deprecated and will be removed in a future release. Flag indicating whether any hosts in this inventory have failed. total_hosts: type: integer minimum: 0 readOnly: true description: This field is deprecated and will be removed in a future release. Total number of hosts in this inventory. hosts_with_active_failures: type: integer minimum: 0 readOnly: true description: This field is deprecated and will be removed in a future release. Number of hosts in this inventory with active failures. total_groups: type: integer minimum: 0 readOnly: true description: This field is deprecated and will be removed in a future release. Total number of groups in this inventory. has_inventory_sources: type: boolean readOnly: true description: This field is deprecated and will be removed in a future release. Flag indicating whether this inventory has any external inventory sources. total_inventory_sources: type: integer minimum: 0 readOnly: true description: Total number of external inventory sources configured within this inventory. inventory_sources_with_failures: type: integer minimum: 0 readOnly: true description: Number of external inventory sources in this inventory with failures. pending_deletion: type: boolean readOnly: true description: Flag indicating the inventory is being deleted. prevent_instance_group_fallback: type: - boolean - 'null' default: false description: If enabled, the inventory will prevent adding any organization instance groups to the list of preferred instances groups to run associated job templates on.If this setting is enabled and you provided an empty list, the global instance groups will be applied. opa_query_path: type: - string - 'null' description: The query path for the OPA policy to evaluate prior to job execution. The query path should be formatted as package/rule. maxLength: 128 required: - name - organization OrganizationCredentialSerializerCreateRequest: type: object properties: name: type: - string - 'null' minLength: 1 maxLength: 512 description: type: - string - 'null' default: '' organization: type: - integer - 'null' description: Inherit permissions from organization roles. If provided on creation, do not give either user or team. 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 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 PaginatedExecutionEnvironmentList: 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/ExecutionEnvironment' Organization_2: type: object properties: id: type: integer readOnly: true name: type: string description: The name of this resource. maxLength: 512 description: type: string description: The organization description. resource: 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. modified: type: string format: date-time readOnly: true description: The date/time this resource was created. modified_by: type: - integer - 'null' readOnly: true description: The user who last modified this resource. required: - created - created_by - id - modified - modified_by - name - resource Team_2: type: object properties: id: type: integer readOnly: true name: type: string description: The name of this resource. maxLength: 512 description: type: string description: The team description. organization_id: type: integer description: The organization of this team. readOnly: true resource: 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. modified: type: string format: date-time readOnly: true description: The date/time this resource was created. modified_by: type: - integer - 'null' readOnly: true description: The user who last modified this resource. required: - created - created_by - id - modified - modified_by - name - organization_id - resource PaginatedOrganizationList: 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/Organization_2' PaginatedTeamList_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/Team_2' UserDisassociate: type: object description: Serializer used for removing objects that are currently associated via a many-to-many relationship properties: instances: type: array items: type: integer description: A list of users to remove from this relationship. required: - instances Organization_3: 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. modified: type: string format: date-time readOnly: true description: The date/time this resource was created. modified_by: type: - integer - 'null' readOnly: true description: The user who last modified this resource. name: type: string description: The name of this resource. maxLength: 512 description: type: string description: The organization description. managed: type: boolean readOnly: true description: Indicates if this organization is managed by the system. It cannot be modified once created. required: - name Team_3: type: object description: 'Class to be used by apps to check permissions to related objects This is a core part of integrating permission checks with REST APIs. Full enablement of checks is accomplished by this plus the permission class.' 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. modified: type: string format: date-time readOnly: true description: The date/time this resource was created. modified_by: type: - integer - 'null' readOnly: true description: The user who last modified this resource. name: type: string description: The name of this resource. maxLength: 512 organization: type: integer description: The organization of this team. description: type: string description: The team description. required: - name - organization PaginatedOrganizationList_2: 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/Organization_3' User_2: type: object description: Disallows editing of system user and enforces superuser requirement. 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. modified: type: string format: date-time readOnly: true description: The date/time this resource was created. modified_by: type: - integer - 'null' readOnly: true description: The user who last modified this resource. username: type: string description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. pattern: ^[\w.@+-]+$ maxLength: 150 email: type: string format: email title: Email address maxLength: 254 first_name: type: string maxLength: 150 last_name: type: string maxLength: 150 last_login: type: - string - 'null' format: date-time readOnly: true last_login_from: type: string readOnly: true description: Read-only field indicating the last authenticator used for successful login. Value is null if user has never logged in. This field is automatically updated on successful authentication. Cannot be set via API. password: type: string maxLength: 128 is_superuser: type: boolean title: Superuser status description: Designates that this user has all permissions without explicitly assigning them. is_platform_auditor: type: boolean readOnly: true authenticators: type: - array - 'null' items: type: integer writeOnly: true description: 'DEPRECATED: This field is deprecated and will be removed in a future version. Please use ''associated_authenticators'' instead.' deprecated: true authenticator_uid: type: string writeOnly: true description: 'DEPRECATED: This field is deprecated and will be removed in a future version. Please use ''associated_authenticators'' instead.' deprecated: true associated_authenticators: type: object additionalProperties: type: object properties: uid: type: string email: type: string writeOnly: true managed: type: boolean readOnly: true description: Indicates if this user is managed by the system. It cannot be modified once created. required: - username UserAssociate: type: object description: Serializer used for adding objects to a many-to-many relationship properties: instances: type: array items: type: integer description: A list of users to add to this relationship. required: - instances PatchedOrganization: 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. modified: type: string format: date-time readOnly: true description: The date/time this resource was created. modified_by: type: - integer - 'null' readOnly: true description: The user who last modified this resource. name: type: string description: The name of this resource. maxLength: 512 description: type: string description: The organization description. managed: type: boolean readOnly: true description: Indicates if this organization is managed by the system. It cannot be modified once created. 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