openapi: 3.2.0 info: title: Red Hat Ansible Automation Platform Users API x-refined-note: - x-logo differs across the merged source definitions and was not carried - x-pulp-app-versions differs across the merged source definitions and was not carried - x-pulp-domain-enabled differs across the merged source definitions and was not carried version: '1.0' description: 'Operations tagged users across 4 of this provider''s published API definitions: red-hat-ansible-automation-platform-automation-controller-openapi.json, red-hat-ansible-automation-platform-automation-hub-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: http://automation-hub-backend-cwa.automation-hub-prod.svc.cluster.local:8000/ - url: /api/eda/v1 tags: - name: Users paths: /api/v2/users/: get: operationId: users_list parameters: - in: query name: order schema: type: string description: Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields. - in: query name: order_by schema: type: string description: Order results by field name. Prefix with '-' for descending order. Supports comma-separated values for multiple fields. - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - name: page_size required: false in: query description: Number of results to return per page. schema: type: integer - in: query name: role_level schema: type: string description: Filter by role level for RBAC - name: search required: false in: query description: A search term. schema: type: string - in: query name: type schema: type: string description: Filter by object type. Supports comma-separated values for multiple types. tags: - Users responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedUserList' description: '' x-ai-description: List users summary: Users list x-summary-source: derived post: operationId: users_create tags: - Users 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 summary: Users create x-summary-source: derived /api/v2/users/{id}/: get: operationId: users_retrieve parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Users responses: '200': content: application/json: schema: $ref: '#/components/schemas/User' description: '' x-ai-description: Retrieve a user summary: Users retrieve x-summary-source: derived put: operationId: users_update parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/UserRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/User' description: '' x-ai-description: Update a user summary: Users update x-summary-source: derived patch: operationId: users_partial_update parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedUserRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/User' description: '' x-ai-description: Update a user summary: Users partial update x-summary-source: derived delete: operationId: users_destroy parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Users responses: '204': description: No response body x-ai-description: Delete a user summary: Users destroy x-summary-source: derived /api/v2/users/{id}/access_list/: get: operationId: users_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: - Users responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedResourceAccessListElementList' description: '' x-ai-description: List users who can access the user summary: Users access list list x-summary-source: derived /api/v2/users/{id}/activity_stream/: get: operationId: users_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: - Users responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedActivityStreamList' description: '' x-ai-description: List activity stream for a user summary: Users activity stream list x-summary-source: derived /api/v2/users/{id}/admin_of_organizations/: get: operationId: users_admin_of_organizations_retrieve parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Users responses: '200': description: No response body x-ai-description: Retrieve single organization for an user summary: Users admin of organizations retrieve x-summary-source: derived /api/v2/users/{id}/credentials/: get: operationId: users_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: - Users responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedUserCredentialSerializerCreateList' description: '' x-ai-description: List credentials owned by a user summary: Users credentials list x-summary-source: derived post: operationId: users_credentials_create parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/UserCredentialSerializerCreateRequest' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/UserCredentialSerializerCreate' description: '' x-ai-description: Create a credentials owned by a user summary: Users credentials create x-summary-source: derived /api/v2/users/{id}/organizations/: get: operationId: users_organizations_retrieve parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Users responses: '200': description: No response body x-ai-description: Retrieve an organization of a user summary: Users organizations retrieve x-summary-source: derived /api/v2/users/{id}/projects/: get: operationId: users_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: - Users responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedProjectList' description: '' x-ai-description: List projects accessible to a user summary: Users projects list x-summary-source: derived /api/v2/users/{id}/roles/: get: operationId: users_roles_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: - Users responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedRoleSerializerWithParentAccessList' description: '' x-ai-description: List roles of a user summary: Users roles list x-summary-source: derived post: operationId: users_roles_create description: Derived version of SubListCreateAttachDetachAPIView that prohibits creation parameters: - in: path name: id schema: type: string pattern: ^[0-9]+$ required: true tags: - Users responses: '201': content: application/json: schema: $ref: '#/components/schemas/RoleSerializerWithParentAccess' description: '' x-ai-description: Add a role to a user summary: Users roles create x-summary-source: derived /api/v2/users/{id}/teams/: get: operationId: users_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: - Users responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedTeamList' description: '' x-ai-description: List teams of a user summary: Users teams list x-summary-source: derived /api/automation-hub/pulp/api/v3/users/: get: operationId: getApiAutomationHubPulpApiV3Users description: ViewSet for User. summary: List users parameters: - in: query name: email schema: type: string description: Filter results where email matches value - in: query name: email__contains schema: type: string description: Filter results where email contains value - in: query name: email__icontains schema: type: string description: Filter results where email contains value - in: query name: email__iexact schema: type: string description: Filter results where email matches value - in: query name: email__in schema: type: array items: type: string description: Filter results where email is in a comma-separated list of values explode: false style: form - in: query name: first_name schema: type: string description: Filter results where first_name matches value - in: query name: first_name__contains schema: type: string description: Filter results where first_name contains value - in: query name: first_name__icontains schema: type: string description: Filter results where first_name contains value - in: query name: first_name__iexact schema: type: string description: Filter results where first_name matches value - in: query name: first_name__in schema: type: array items: type: string description: Filter results where first_name is in a comma-separated list of values explode: false style: form - in: query name: is_active schema: type: boolean description: Filter results where is_active matches value - in: query name: is_staff schema: type: boolean description: Filter results where is_staff matches value - in: query name: last_name schema: type: string description: Filter results where last_name matches value - in: query name: last_name__contains schema: type: string description: Filter results where last_name contains value - in: query name: last_name__icontains schema: type: string description: Filter results where last_name contains value - in: query name: last_name__iexact schema: type: string description: Filter results where last_name matches value - in: query name: last_name__in schema: type: array items: type: string description: Filter results where last_name is in a comma-separated list of values explode: false style: form - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - in: query name: ordering schema: type: array items: type: string enum: - -date_joined - -email - -first_name - -id - -is_active - -is_staff - -is_superuser - -last_login - -last_name - -password - -pk - -username - date_joined - email - first_name - id - is_active - is_staff - is_superuser - last_login - last_name - password - pk - username description: 'Ordering * `id` - Id * `-id` - Id (descending) * `password` - Password * `-password` - Password (descending) * `last_login` - Last login * `-last_login` - Last login (descending) * `is_superuser` - Is superuser * `-is_superuser` - Is superuser (descending) * `username` - Username * `-username` - Username (descending) * `first_name` - First name * `-first_name` - First name (descending) * `last_name` - Last name * `-last_name` - Last name (descending) * `email` - Email * `-email` - Email (descending) * `is_staff` - Is staff * `-is_staff` - Is staff (descending) * `is_active` - Is active * `-is_active` - Is active (descending) * `date_joined` - Date joined * `-date_joined` - Date joined (descending) * `pk` - Pk * `-pk` - Pk (descending)' explode: false style: form - in: query name: pulp_href__in schema: type: array items: type: string description: Multiple values may be separated by commas. explode: false style: form - in: query name: pulp_id__in schema: type: array items: type: string format: uuid description: Multiple values may be separated by commas. explode: false style: form - in: query name: q schema: type: string - in: query name: username schema: type: string description: Filter results where username matches value - in: query name: username__contains schema: type: string description: Filter results where username contains value - in: query name: username__icontains schema: type: string description: Filter results where username contains value - in: query name: username__iexact schema: type: string description: Filter results where username matches value - in: query name: username__in schema: type: array items: type: string description: Filter results where username is in a comma-separated list of values explode: false style: form - in: query name: fields schema: type: array items: type: string description: A list of fields to include in the response. - in: query name: exclude_fields schema: type: array items: type: string description: A list of fields to exclude from the response. tags: - Users responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedUserResponseList' description: '' x-operation-id-source: normalized x-operation-id-original: users_list post: operationId: postApiAutomationHubPulpApiV3Users description: ViewSet for User. summary: Create an user tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/User_2' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/User_2' multipart/form-data: schema: $ref: '#/components/schemas/User_2' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/UserResponse' description: '' x-operation-id-source: normalized x-operation-id-original: users_create servers: - url: http://automation-hub-backend-cwa.automation-hub-prod.svc.cluster.local:8000/ /api/automation-hub/pulp/api/v3/users/{id}/: get: operationId: users_read description: ViewSet for User. summary: Inspect an user parameters: - in: path name: id schema: type: integer format: int64 description: A unique integer value identifying this user. required: true - in: query name: fields schema: type: array items: type: string description: A list of fields to include in the response. - in: query name: exclude_fields schema: type: array items: type: string description: A list of fields to exclude from the response. tags: - Users responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserResponse' description: '' put: operationId: putApiAutomationHubPulpApiV3UsersById description: ViewSet for User. summary: Update an user parameters: - in: path name: id schema: type: integer format: int64 description: A unique integer value identifying this user. required: true tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/User_2' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/User_2' multipart/form-data: schema: $ref: '#/components/schemas/User_2' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserResponse' description: '' x-operation-id-source: normalized x-operation-id-original: users_update patch: operationId: patchApiAutomationHubPulpApiV3UsersById description: ViewSet for User. summary: Update an user parameters: - in: path name: id schema: type: integer format: int64 description: A unique integer value identifying this user. required: true tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedUser' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedUser' multipart/form-data: schema: $ref: '#/components/schemas/PatchedUser' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserResponse' description: '' x-operation-id-source: normalized x-operation-id-original: users_partial_update delete: operationId: users_delete description: ViewSet for User. summary: Delete an user parameters: - in: path name: id schema: type: integer format: int64 description: A unique integer value identifying this user. required: true tags: - Users responses: '204': description: No response body servers: - url: http://automation-hub-backend-cwa.automation-hub-prod.svc.cluster.local:8000/ /users/: get: operationId: getUsers description: List users parameters: - in: query name: is_superuser schema: type: boolean description: Filter by superuser status. - in: query name: name schema: type: string description: Filter by Username. - 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. - in: query name: username schema: type: string tags: - Users security: - EDAJWTAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedUserListList' description: Return a list of users. summary: Users list x-summary-source: derived x-operation-id-source: normalized x-operation-id-original: users_list servers: - url: /api/eda/v1 /users/{id}/: get: operationId: getUsersById description: Retrieve a user by their id parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this user. required: true tags: - Users security: - EDAJWTAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserDetail' description: Return a user. summary: Users retrieve x-summary-source: derived x-operation-id-source: normalized x-operation-id-original: users_retrieve patch: operationId: patchUsersById description: Partial update of a user. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this user. required: true tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedUserUpdateIsSuperuser' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedUserUpdateIsSuperuser' multipart/form-data: schema: $ref: '#/components/schemas/PatchedUserUpdateIsSuperuser' security: - EDAJWTAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserDetail' description: Update successful. Return an updated user. '403': description: Update is prohibited summary: Users partial update x-summary-source: derived x-operation-id-source: normalized x-operation-id-original: users_partial_update servers: - url: /api/eda/v1 /users/me/: get: operationId: get_current_user description: Get current user. tags: - Users security: - EDAJWTAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/UserDetail' description: Return current user. summary: Get current user x-summary-source: derived servers: - url: /api/eda/v1 /users/me/awx-tokens/: get: operationId: users_me_awx_tokens_list description: List current user AWX tokens. parameters: - name: page required: false in: query description: A page number within the paginated result set. schema: type: integer - name: page_size required: false in: query description: Number of results to return per page. schema: type: integer - name: search required: false in: query description: A search term. schema: type: string tags: - Users security: - EDAJWTAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedAwxTokenList' description: Return a list of AWX tokens. summary: Users me awx tokens list x-summary-source: derived post: operationId: users_me_awx_tokens_create description: Create a AWX token for a current user. tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/AwxTokenCreate' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AwxTokenCreate' multipart/form-data: schema: $ref: '#/components/schemas/AwxTokenCreate' required: true security: - EDAJWTAuthentication: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/AwxToken' description: Return the created AWX token. summary: Users me awx tokens create x-summary-source: derived servers: - url: /api/eda/v1 /users/me/awx-tokens/{id}/: get: operationId: users_me_awx_tokens_retrieve description: Get current user AWX token by ID. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this token. required: true tags: - Users security: - EDAJWTAuthentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AwxToken' description: Return a AWX tokens. summary: Users me awx tokens retrieve x-summary-source: derived delete: operationId: users_me_awx_tokens_destroy description: Delete AWX token of a current user by ID. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this token. required: true tags: - Users security: - EDAJWTAuthentication: [] responses: '204': description: The AWX token has been deleted. summary: Users me awx tokens destroy x-summary-source: derived servers: - url: /api/eda/v1 /api/gateway/v1/users/: get: operationId: getApiGatewayV1Users description: API endpoint that allows users 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: 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: 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: - Users security: - OAuth2_Authentication: [] - SessionAuthentication: [] - Basic_Authentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedUserList' description: '' x-ai-description: List authenticated platform users with permissions assigned directly or via team membership summary: Users list x-summary-source: derived x-operation-id-source: normalized x-operation-id-original: users_list post: operationId: postApiGatewayV1Users description: API endpoint that allows users to be viewed or edited. tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/User_3' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/User_3' multipart/form-data: schema: $ref: '#/components/schemas/User_3' required: true security: - OAuth2_Authentication: [] - SessionAuthentication: [] - Basic_Authentication: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/User_3' description: '' x-ai-description: Create a authenticated platform user with permissions assigned directly or via team membership summary: Users create x-summary-source: derived x-operation-id-source: normalized x-operation-id-original: users_create /api/gateway/v1/users/{id}/: get: operationId: getApiGatewayV1UsersById description: API endpoint that allows users to be viewed or edited. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this user. required: true tags: - Users security: - OAuth2_Authentication: [] - SessionAuthentication: [] - Basic_Authentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/User_3' description: '' x-ai-description: Retrieve a authenticated platform user with permissions assigned directly or via team membership summary: Users retrieve x-summary-source: derived x-operation-id-source: normalized x-operation-id-original: users_retrieve put: operationId: putApiGatewayV1UsersById description: API endpoint that allows users to be viewed or edited. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this user. required: true tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/User_3' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/User_3' multipart/form-data: schema: $ref: '#/components/schemas/User_3' required: true security: - OAuth2_Authentication: [] - SessionAuthentication: [] - Basic_Authentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/User_3' description: '' x-ai-description: Update a authenticated platform user with permissions assigned directly or via team membership summary: Users update x-summary-source: derived x-operation-id-source: normalized x-operation-id-original: users_update patch: operationId: patchApiGatewayV1UsersById description: API endpoint that allows users to be viewed or edited. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this user. required: true tags: - Users requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedUser_2' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedUser_2' multipart/form-data: schema: $ref: '#/components/schemas/PatchedUser_2' security: - OAuth2_Authentication: [] - SessionAuthentication: [] - Basic_Authentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/User_3' description: '' x-ai-description: Update a authenticated platform user with permissions assigned directly or via team membership summary: Users partial update x-summary-source: derived x-operation-id-source: normalized x-operation-id-original: users_partial_update delete: operationId: deleteApiGatewayV1UsersById description: API endpoint that allows users to be viewed or edited. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this user. required: true tags: - Users security: - OAuth2_Authentication: [] - SessionAuthentication: [] - Basic_Authentication: [] responses: '204': description: No response body x-ai-description: Delete a authenticated platform user with permissions assigned directly or via team membership summary: Users destroy x-summary-source: derived x-operation-id-source: normalized x-operation-id-original: users_destroy /api/gateway/v1/users/{id}/authenticators/: get: operationId: users_authenticators_retrieve description: API endpoint that allows users to be viewed or edited. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this user. required: true tags: - Users security: - OAuth2_Authentication: [] - SessionAuthentication: [] - Basic_Authentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/User_3' description: '' x-ai-description: Retrieve a authenticated platform user with permissions assigned directly or via team membership summary: Users authenticators retrieve x-summary-source: derived /api/gateway/v1/users/{id}/authorized_tokens/: get: operationId: users_authorized_tokens_retrieve description: API endpoint that allows users to be viewed or edited. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this user. required: true tags: - Users security: - OAuth2_Authentication: [] - SessionAuthentication: [] - Basic_Authentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/User_3' description: '' x-ai-description: Retrieve single token for an user summary: Users authorized tokens retrieve x-summary-source: derived /api/gateway/v1/users/{id}/organizations/: get: operationId: users_organizations_list description: Update the corresponding resource in each service. 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: - Users security: - OAuth2_Authentication: [] - SessionAuthentication: [] - Basic_Authentication: [] deprecated: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedOrganizationList' description: '' x-ai-description: List all organizations for an user summary: Users organizations list x-summary-source: derived /api/gateway/v1/users/{id}/personal_tokens/: get: operationId: users_personal_tokens_retrieve description: API endpoint that allows users to be viewed or edited. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this user. required: true tags: - Users security: - OAuth2_Authentication: [] - SessionAuthentication: [] - Basic_Authentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/User_3' description: '' x-ai-description: Retrieve single token for an user summary: Users personal tokens retrieve x-summary-source: derived /api/gateway/v1/users/{id}/teams/: get: operationId: getApiGatewayV1UsersByIdTeams description: Update the corresponding resource in each service. 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: - Users security: - OAuth2_Authentication: [] - SessionAuthentication: [] - Basic_Authentication: [] deprecated: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedTeamList' description: '' x-ai-description: List all teams for an user summary: Users teams list x-summary-source: derived x-operation-id-source: normalized x-operation-id-original: users_teams_list /api/gateway/v1/users/{id}/tokens/: get: operationId: users_tokens_retrieve description: API endpoint that allows users to be viewed or edited. parameters: - in: path name: id schema: type: integer description: A unique integer value identifying this user. required: true tags: - Users security: - OAuth2_Authentication: [] - SessionAuthentication: [] - Basic_Authentication: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/User_3' description: '' x-ai-description: Retrieve a authenticated platform user with permissions assigned directly or via team membership summary: Users tokens retrieve x-summary-source: derived components: schemas: PaginatedRoleSerializerWithParentAccessList: 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/RoleSerializerWithParentAccess' 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' 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' 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' 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 PatchedUserRequest: 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. 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 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 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 RoleSerializerWithParentAccess: 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 UserCredentialSerializerCreate: 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: '' 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 UserCredentialSerializerCreateRequest: type: object properties: name: type: - string - 'null' minLength: 1 maxLength: 512 description: type: - string - 'null' default: '' 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. user: type: - integer - 'null' writeOnly: true description: Write-only field used to add user to owner role. If provided, do not give either team or organization. Only valid for creation. required: - credential_type - name 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 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 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' PaginatedUserCredentialSerializerCreateList: 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/UserCredentialSerializerCreate' 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' PaginatedUserResponseList: type: object properties: meta: type: object properties: count: type: integer example: 123 links: type: object properties: first: type: - string - 'null' previous: type: - string - 'null' next: type: - string - 'null' last: type: - string - 'null' data: type: array items: $ref: '#/components/schemas/UserResponse' PatchedUser: type: object properties: username: type: string minLength: 1 description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. pattern: ^[\w.@+-]+$ maxLength: 150 first_name: type: string maxLength: 150 last_name: type: string maxLength: 150 email: type: string format: email title: Email address maxLength: 254 groups: type: array items: type: integer format: int64 description: The groups this user belongs to. A user will get all permissions granted to each of their groups. password: type: string writeOnly: true maxLength: 128 is_superuser: type: boolean title: Superuser status description: Designates that this user has all permissions without explicitly assigning them. User_2: type: object properties: username: type: string minLength: 1 description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. pattern: ^[\w.@+-]+$ maxLength: 150 first_name: type: string maxLength: 150 last_name: type: string maxLength: 150 email: type: string format: email title: Email address maxLength: 254 groups: type: array items: type: integer format: int64 description: The groups this user belongs to. A user will get all permissions granted to each of their groups. password: type: string writeOnly: true maxLength: 128 is_superuser: type: boolean title: Superuser status description: Designates that this user has all permissions without explicitly assigning them. required: - username UserResponse: type: object properties: id: type: integer format: int64 readOnly: true username: type: string description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. pattern: ^[\w.@+-]+$ maxLength: 150 first_name: type: string maxLength: 150 last_name: type: string maxLength: 150 email: type: string format: email title: Email address maxLength: 254 groups: type: array items: type: integer format: int64 description: The groups this user belongs to. A user will get all permissions granted to each of their groups. date_joined: type: string format: date-time readOnly: true is_superuser: type: boolean title: Superuser status description: Designates that this user has all permissions without explicitly assigning them. auth_provider: type: string readOnly: true required: - username PatchedUserUpdateIsSuperuser: type: object properties: is_superuser: type: boolean title: Superuser status description: Designates that this user has all permissions without explicitly assigning them. UserList: type: object properties: id: type: integer description: The ID of the user username: type: string description: The user's log in name. first_name: type: string description: The user's first name. last_name: type: string description: The user's last name. is_superuser: type: boolean description: The user is a superuser. resource: type: object additionalProperties: true readOnly: true required: - first_name - id - is_superuser - last_name - resource - username PaginatedUserListList: 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/UserList' AwxTokenCreate: type: object properties: name: type: string description: type: string token: type: string required: - name - token PaginatedAwxTokenList: 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/AwxToken' UserDetail: type: object properties: id: type: integer readOnly: true username: type: string description: The user's log in name. email: type: string format: email title: Email address maxLength: 254 first_name: type: string maxLength: 150 last_name: type: string maxLength: 150 is_superuser: type: boolean title: Superuser status description: Designates that this user has all permissions without explicitly assigning them. resource: type: object additionalProperties: true readOnly: true created_at: type: string format: date-time modified_at: type: string format: date-time readOnly: true required: - created_at - id - modified_at - resource - username AwxToken: type: object properties: id: type: integer readOnly: true name: type: string description: type: string user_id: type: integer readOnly: true created_at: type: string format: date-time readOnly: true modified_at: type: string format: date-time readOnly: true required: - created_at - id - modified_at - name - user_id PatchedUser_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. Organization: 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_2: 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: 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' User_3: 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 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-automation-hub-openapi.json - red-hat-ansible-automation-platform-event-driven-ansible-openapi.json - red-hat-ansible-automation-platform-platform-gateway-openapi.json