Update reportportal-api.yaml

reportportal · Jan 9, 2025 · 0b2e1d0 · 0b2e1d0
1 parent 6accf8b
commit 0b2e1d0
Showing 1 changed file with 85 additions and 0 deletions.
diff --git a/api/openapi/reportportal-api.yaml b/api/openapi/reportportal-api.yaml
@@ -730,6 +730,91 @@ paths:
           description: Filter users by account type.
       security:
         - BearerAuth: []
+  /users/searches:
+    post:
+      summary: Create search request for users
+      operationId: post-users-searches
+      tags:
+        - User
+      description: >-
+        Search users by criteria.
+
+
+        You can use the following attributes as a
+        `search_criteria[*].filter_key`:
+
+
+        - `uuid` - filter by user UUID.
+
+        - `external_id` - filter by user external identifier.
+
+        - `email` - filter by user email.
+
+        - `full_name` - filter by user full name.
+
+        - `account_type` - filter by account type.
+
+        - `instance_role` - filter by user role in the instance.
+
+        - `active` - filter by user activity.
+
+        - `created_at` - date when a user was created.
+
+        - `updated_at` - date when a user was updated.
+
+        - `org_id` - search by organization id.
+
+
+        ### Authority
+
+
+        - `ADMINISTRATOR`
+
+
+        ### Access level
+
+
+        #### ADMINISTRATOR
+
+
+        - Filter by all attributes.
+
+        - Use all operations.
+
+        - Get a full user profile.
+      parameters:
+        - schema:
+            type: string
+            enum:
+              - application/json
+              - text/csv
+            default: application/json
+          in: header
+          name: Accept
+          description: Indicate response format. Use `text/csv` to export users.
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                oneOf:
+                  - $ref: '#/components/schemas/InstanceUserPage'
+                  - $ref: '#/components/schemas/UserInfoPage'
+        '400':
+          $ref: '#/components/responses/Error'
+        '401':
+          $ref: '#/components/responses/Error'
+        '403':
+          $ref: '#/components/responses/Error'
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/SearchCriteriaRQ'
+        description: Create search request for user collection.
+      security:
+        - BearerAuth: []
   /users/me:
     get:
       summary: Get current user