Automated commit by github action: 15141237971

static/api-specs/idn/beta/paths/suggested-entitlement-description-batches-stats.yaml

@@ -39,3 +39,6 @@ get:
       $ref: '../../v3/responses/500.yaml'
   security:
     - userAuth: [ idn:sed:read ]
+  x-sailpoint-userLevels:
+    - ORG_ADMIN
+    - SOURCE_ADMIN

static/api-specs/idn/beta/paths/suggested-entitlement-description-batches.yaml

@@ -2,18 +2,85 @@ get:
   tags:
     - Suggested Entitlement Description
   operationId: getSedBatches
-  summary: List sed batch request
+  summary: List Sed Batch Record
   description: >-
     List Sed Batches.
 
-    API responses with Sed Batch Status
+    API responses with Sed Batch Records
+  parameters:
+    - name: offset
+      in: query
+      description: |-
+        Offset
+
+        Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).
+        The offset value is record-based, not page-based, and the index starts at 0.
+      schema:
+        type: integer
+        format: int64
+        default: 0
+        x-go-name: Offset
+      example: 0
+      required: false
+      x-go-name: Offset
+    - name: limit
+      in: query
+      description: |-
+        Limit
+
+        Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).
+        If it is not specified, a default limit is used.
+      schema:
+        type: integer
+        format: int64
+        maxLength: 250
+        minLength: 0
+        default: 250
+        x-go-name: Limit
+      example: 250
+      required: false
+      x-go-name: Limit
+    - name: count
+      in: query
+      description: >-
+        If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. 
+
+        The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).
+
+        Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used.
+      schema:
+        type: boolean
+        default: false
+      example: true
+      required: false
+    - name: count-only
+      in: query
+      description: >-
+        If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored.
+
+        This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array.
+
+      schema:
+        type: boolean
+        default: false
+      example: true
+      required: false
+    - name: status
+      in: query
+      description: Batch Status
+      schema:
+        type: string
+      example: completed, failed, submitted, materialized, failed
+      required: false
   responses:
     '200':
-      description: Status of batch
+      description: List of Sed Batch Records
       content:
         application/json:
           schema:
-            $ref: '../schemas/SedBatchStatus.yaml'
+            items:
+              $ref: '../schemas/Sed.yaml'
+            type: array
     '400':
       $ref: '../../v3/responses/400.yaml'
     '401':
@@ -28,6 +95,9 @@ get:
       $ref: '../../v3/responses/500.yaml'
   security:
     - userAuth: [ idn:sed:read ]
+  x-sailpoint-userLevels:
+    - ORG_ADMIN
+    - SOURCE_ADMIN
 
 post:
   tags:
@@ -69,3 +139,6 @@ post:
       $ref: '../../v3/responses/500.yaml'
   security:
     - userAuth: [ idn:sed:write ]
+  x-sailpoint-userLevels:
+    - ORG_ADMIN
+    - SOURCE_ADMIN

static/api-specs/idn/beta/schemas/SearchCriteria.yaml

@@ -0,0 +1,106 @@
+description: Represents the search criteria for querying entitlements.
+type: object
+properties:
+  indices:
+    type: array
+    items:
+      type: string
+    description: A list of indices to search within. Must contain exactly one item, typically "entitlements".
+    example: ["entitlements"]
+  filters:
+    type: object
+    additionalProperties:
+      type: object
+      properties:
+        type:
+          type: string
+          description: The type of filter, e.g., "TERMS" or "RANGE".
+          example: "TERMS"
+        terms:
+          type: array
+          items:
+            type: string
+          description: Terms to filter by (for "TERMS" type).
+          example: ["active", "inactive"]
+        range:
+          type: object
+          properties:
+            lower:
+              type: object
+              properties:
+                value:
+                  type: string
+                  description: The lower bound value.
+                  example: "10"
+                inclusive:
+                  type: boolean
+                  default: false
+                  description: Whether the lower bound is inclusive.
+                  example: true
+            upper:
+              type: object
+              properties:
+                value:
+                  type: string
+                  description: The upper bound value.
+                  example: "20"
+                inclusive:
+                  type: boolean
+                  default: false
+                  description: Whether the upper bound is inclusive.
+                  example: false
+    description: A map of filters applied to the search. Keys are filter names, and values are filter definitions.
+    example:
+      status:
+        type: "TERMS"
+        terms: ["active", "inactive"]
+  query:
+    type: object
+    properties:
+      query:
+        type: string
+        description: A structured query for advanced search.
+        example: "status:active"
+  queryType:
+    type: string
+    description: Specifies the type of query. Must be "TEXT" if `textQuery` is used.
+    example: "TEXT"
+  textQuery:
+    type: object
+    properties:
+      terms:
+        type: array
+        items:
+          type: string
+        description: Terms to search for.
+        example: ["admin", "user"]
+      fields:
+        type: array
+        items:
+          type: string
+        description: Fields to search within.
+        example: ["role", "name"]
+      matchAny:
+        type: boolean
+        default: false
+        description: Whether to match any of the terms.
+        example: true
+  includeNested:
+    type: boolean
+    default: false
+    description: Whether to include nested objects in the search results.
+    example: true
+  sort:
+    type: array
+    items:
+      type: string
+    description: Specifies the sorting order for the results.
+    example: ["name:asc", "createdAt:desc"]
+  searchAfter:
+    type: array
+    items:
+      type: string
+    description: Used for pagination to fetch results after a specific point.
+    example: ["12345", "67890"]
+required:
+  - indices

static/api-specs/idn/beta/schemas/SedBatchRecord.yaml

@@ -0,0 +1,49 @@
+description: Sed Batch Record
+type: object
+properties:
+  tenantId:
+    type: string
+    format: uuid
+    description: The tenant ID associated with the batch.
+    example: 123e4567-e89b-12d3-a456-426614174000
+  batchId:
+    type: string
+    format: uuid
+    description: The unique ID of the batch.
+    example: 016629d1-1d25-463f-97f3-c6686846650
+  name:
+    type: string
+    nullable: true
+    description: The name of the batch.
+    example: Example Batch Name
+  processedState:
+    type: string
+    nullable: true
+    description: The current state of the batch (e.g., submitted, materialized, completed).
+    example: submitted | materialized | completed | failed
+  requestedBy:
+    type: string
+    format: uuid
+    description: The ID of the user who requested the batch.
+    example: 987e6543-e21b-45d3-b123-123456789abc
+  materializedCount:
+    type: integer
+    format: int32
+    description: The number of items materialized in the batch.
+    example: 50
+  processedCount:
+    type: integer
+    format: int32
+    description: The number of items processed in the batch.
+    example: 45
+  createdAt:
+    type: string
+    format: date-time
+    description: The timestamp when the batch was created.
+    example: 2023-10-01T12:00:00Z
+  updatedAt:
+    type: string
+    format: date-time
+    nullable: true
+    description: The timestamp when the batch was last updated.
+    example: 2023-10-02T15:30:00Z

static/api-specs/idn/beta/schemas/SedBatchRequest.yaml

@@ -5,6 +5,7 @@ properties:
   entitlements:
     description: list of entitlement ids
     type: array
+    nullable: true
     minItems: 1
     items:
       type: string
@@ -12,7 +13,13 @@ properties:
   seds:
     description: list of sed ids
     type: array
+    nullable: true
     minItems: 1
     items:
       type: string
       example: 016629d1-1d25-463f-97f3-c6686846650
+  searchCriteria:
+    additionalProperties:
+      $ref: SearchCriteria.yaml
+    nullable: true
+    description: Search criteria for the batch request.

static/api-specs/idn/beta/schemas/SedBatchStatus.yaml

@@ -1,7 +0,0 @@
-description: Sed Batch Status
-type: object
-properties:
-  status:
-    description: status of batch
-    type: string
-    example: OK

static/api-specs/idn/v2024/paths/suggested-entitlement-description-batches.yaml

@@ -2,17 +2,85 @@ get:
   tags:
     - Suggested Entitlement Description
   operationId: getSedBatches
-  summary: List sed batch request
+  summary: List Sed Batch Record
-  description: 'List Sed Batches.
+  description: >-
+    List Sed Batches.
  
-    API responses with Sed Batch Status'
+    API responses with Sed Batch Records
+  parameters:
+    - name: offset
+      in: query
+      description: |-
+        Offset
+
+        Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).
+        The offset value is record-based, not page-based, and the index starts at 0.
+      schema:
+        type: integer
+        format: int64
+        default: 0
+        x-go-name: Offset
+      example: 0
+      required: false
+      x-go-name: Offset
+    - name: limit
+      in: query
+      description: |-
+        Limit
+
+        Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).
+        If it is not specified, a default limit is used.
+      schema:
+        type: integer
+        format: int64
+        maxLength: 250
+        minLength: 0
+        default: 250
+        x-go-name: Limit
+      example: 250
+      required: false
+      x-go-name: Limit
+    - name: count
+      in: query
+      description: >-
+        If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. 
+
+        The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).
+
+        Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used.
+      schema:
+        type: boolean
+        default: false
+      example: true
+      required: false
+    - name: count-only
+      in: query
+      description: >-
+        If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored.
+
+        This parameter differs from the `count` parameter in that this one skips executing the actual query and always return an empty array.
+
+      schema:
+        type: boolean
+        default: false
+      example: true
+      required: false
+    - name: status
+      in: query
+      description: Batch Status
+      schema:
+        type: string
+      example: completed, failed, submitted, materialized, failed
+      required: false
   responses:
     '200':
-      description: Status of batch
+      description: List of Sed Batch Records
       content:
         application/json:
           schema:
-            $ref: ../schemas/SedBatchStatus.yaml
+            items:
+              $ref: ../schemas/SedBatchRecord.yaml
+            type: array
     '400':
       $ref: ../responses/400.yaml
     '401':

static/api-specs/idn/v2024/schemas/SearchCriteria.yaml

@@ -0,0 +1,106 @@
+description: Represents the search criteria for querying entitlements.
+type: object
+properties:
+  indices:
+    type: array
+    items:
+      type: string
+    description: A list of indices to search within. Must contain exactly one item, typically "entitlements".
+    example: ["entitlements"]
+  filters:
+    type: object
+    additionalProperties:
+      type: object
+      properties:
+        type:
+          type: string
+          description: The type of filter, e.g., "TERMS" or "RANGE".
+          example: "TERMS"
+        terms:
+          type: array
+          items:
+            type: string
+          description: Terms to filter by (for "TERMS" type).
+          example: ["active", "inactive"]
+        range:
+          type: object
+          properties:
+            lower:
+              type: object
+              properties:
+                value:
+                  type: string
+                  description: The lower bound value.
+                  example: "10"
+                inclusive:
+                  type: boolean
+                  default: false
+                  description: Whether the lower bound is inclusive.
+                  example: true
+            upper:
+              type: object
+              properties:
+                value:
+                  type: string
+                  description: The upper bound value.
+                  example: "20"
+                inclusive:
+                  type: boolean
+                  default: false
+                  description: Whether the upper bound is inclusive.
+                  example: false
+    description: A map of filters applied to the search. Keys are filter names, and values are filter definitions.
+    example:
+      status:
+        type: "TERMS"
+        terms: ["active", "inactive"]
+  query:
+    type: object
+    properties:
+      query:
+        type: string
+        description: A structured query for advanced search.
+        example: "status:active"
+  queryType:
+    type: string
+    description: Specifies the type of query. Must be "TEXT" if `textQuery` is used.
+    example: "TEXT"
+  textQuery:
+    type: object
+    properties:
+      terms:
+        type: array
+        items:
+          type: string
+        description: Terms to search for.
+        example: ["admin", "user"]
+      fields:
+        type: array
+        items:
+          type: string
+        description: Fields to search within.
+        example: ["role", "name"]
+      matchAny:
+        type: boolean
+        default: false
+        description: Whether to match any of the terms.
+        example: true
+  includeNested:
+    type: boolean
+    default: false
+    description: Whether to include nested objects in the search results.
+    example: true
+  sort:
+    type: array
+    items:
+      type: string
+    description: Specifies the sorting order for the results.
+    example: ["name:asc", "createdAt:desc"]
+  searchAfter:
+    type: array
+    items:
+      type: string
+    description: Used for pagination to fetch results after a specific point.
+    example: ["12345", "67890"]
+required:
+  - indices

static/api-specs/idn/v2024/schemas/SedBatchRecord.yaml

@@ -0,0 +1,49 @@
+description: Sed Batch Record
+type: object
+properties:
+  tenantId:
+    type: string
+    format: uuid
+    description: The tenant ID associated with the batch.
+    example: 123e4567-e89b-12d3-a456-426614174000
+  batchId:
+    type: string
+    format: uuid
+    description: The unique ID of the batch.
+    example: 016629d1-1d25-463f-97f3-c6686846650
+  name:
+    type: string
+    nullable: true
+    description: The name of the batch.
+    example: Example Batch Name
+  processedState:
+    type: string
+    nullable: true
+    description: The current state of the batch (e.g., submitted, materialized, completed).
+    example: submitted | materialized | completed | failed
+  requestedBy:
+    type: string
+    format: uuid
+    description: The ID of the user who requested the batch.
+    example: 987e6543-e21b-45d3-b123-123456789abc
+  materializedCount:
+    type: integer
+    format: int32
+    description: The number of items materialized in the batch.
+    example: 50
+  processedCount:
+    type: integer
+    format: int32
+    description: The number of items processed in the batch.
+    example: 45
+  createdAt:
+    type: string
+    format: date-time
+    description: The timestamp when the batch was created.
+    example: 2023-10-01T12:00:00Z
+  updatedAt:
+    type: string
+    format: date-time
+    nullable: true
+    description: The timestamp when the batch was last updated.
+    example: 2023-10-02T15:30:00Z

static/api-specs/idn/v2024/schemas/SedBatchRequest.yaml

@@ -5,6 +5,7 @@ properties:
   entitlements:
     description: list of entitlement ids
     type: array
+    nullable: true
     minItems: 1
     items:
       type: string
@@ -12,7 +13,13 @@ properties:
   seds:
     description: list of sed ids
     type: array
+    nullable: true
     minItems: 1
     items:
       type: string
       example: 016629d1-1d25-463f-97f3-c6686846650
+  searchCriteria:
+    additionalProperties:
+      $ref: SearchCriteria.yaml
+    nullable: true
+    description: Search criteria for the batch request.

static/api-specs/idn/v2024/schemas/SedBatchStatus.yaml

@@ -1,7 +0,0 @@
-description: Sed Batch Status
-type: object
-properties:
-  status:
-    description: status of batch
-    type: string
-    example: OK

static/api-specs/idn/v2025/paths/suggested-entitlement-description-batches.yaml

@@ -2,17 +2,85 @@ get:
   tags:
     - Suggested Entitlement Description
   operationId: getSedBatches
-  summary: List sed batch request
+  summary: List Sed Batch Record
-  description: 'List Sed Batches.
+  description: >-
+    List Sed Batches.
 
-    API responses with Sed Batch Status'
+    API responses with Sed Batch Records
+  parameters:
+    - name: offset
+      in: query
+      description: |-
+        Offset
+
+        Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).
+        The offset value is record-based, not page-based, and the index starts at 0.
+      schema:
+        type: integer
+        format: int64
+        default: 0
+        x-go-name: Offset
+      example: 0
+      required: false
+      x-go-name: Offset
+    - name: limit
+      in: query
+      description: |-
+        Limit
+
+        Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).
+        If it is not specified, a default limit is used.
+      schema:
+        type: integer
+        format: int64
+        maxLength: 250
+        minLength: 0
+        default: 250
+        x-go-name: Limit
+      example: 250
+      required: false
+      x-go-name: Limit
+    - name: count
+      in: query
+      description: >-
+        If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. 
+
+        The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results).
+
+        Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used.
+      schema:
+        type: boolean
+        default: false
+      example: true
+      required: false
+    - name: count-only
+      in: query
+      description: >-
+        If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored.
+
+        This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array.
+
+      schema:
+        type: boolean
+        default: false
+      example: true
+      required: false
+    - name: status
+      in: query
+      description: Batch Status
+      schema:
+        type: string
+      example: completed, failed, submitted, materialized, failed
+      required: false
   responses:
     '200':
-      description: Status of batch
+      description: List of Sed Batch Records
       content:
         application/json:
           schema:
-            $ref: ../schemas/SedBatchStatus.yaml
+            items:
+              $ref: ../schemas/SedBatchRecord.yaml
+            type: array
     '400':
       $ref: ../responses/400.yaml
     '401':

static/api-specs/idn/v2025/schemas/SearchCriteria.yaml

@@ -0,0 +1,106 @@
+description: Represents the search criteria for querying entitlements.
+type: object
+properties:
+  indices:
+    type: array
+    items:
+      type: string
+    description: A list of indices to search within. Must contain exactly one item, typically "entitlements".
+    example: ["entitlements"]
+  filters:
+    type: object
+    additionalProperties:
+      type: object
+      properties:
+        type:
+          type: string
+          description: The type of filter, e.g., "TERMS" or "RANGE".
+          example: "TERMS"
+        terms:
+          type: array
+          items:
+            type: string
+          description: Terms to filter by (for "TERMS" type).
+          example: ["active", "inactive"]
+        range:
+          type: object
+          properties:
+            lower:
+              type: object
+              properties:
+                value:
+                  type: string
+                  description: The lower bound value.
+                  example: "10"
+                inclusive:
+                  type: boolean
+                  default: false
+                  description: Whether the lower bound is inclusive.
+                  example: true
+            upper:
+              type: object
+              properties:
+                value:
+                  type: string
+                  description: The upper bound value.
+                  example: "20"
+                inclusive:
+                  type: boolean
+                  default: false
+                  description: Whether the upper bound is inclusive.
+                  example: false
+    description: A map of filters applied to the search. Keys are filter names, and values are filter definitions.
+    example:
+      status:
+        type: "TERMS"
+        terms: ["active", "inactive"]
+  query:
+    type: object
+    properties:
+      query:
+        type: string
+        description: A structured query for advanced search.
+        example: "status:active"
+  queryType:
+    type: string
+    description: Specifies the type of query. Must be "TEXT" if `textQuery` is used.
+    example: "TEXT"
+  textQuery:
+    type: object
+    properties:
+      terms:
+        type: array
+        items:
+          type: string
+        description: Terms to search for.
+        example: ["admin", "user"]
+      fields:
+        type: array
+        items:
+          type: string
+        description: Fields to search within.
+        example: ["role", "name"]
+      matchAny:
+        type: boolean
+        default: false
+        description: Whether to match any of the terms.
+        example: true
+  includeNested:
+    type: boolean
+    default: false
+    description: Whether to include nested objects in the search results.
+    example: true
+  sort:
+    type: array
+    items:
+      type: string
+    description: Specifies the sorting order for the results.
+    example: ["name:asc", "createdAt:desc"]
+  searchAfter:
+    type: array
+    items:
+      type: string
+    description: Used for pagination to fetch results after a specific point.
+    example: ["12345", "67890"]
+required:
+  - indices

static/api-specs/idn/v2025/schemas/SedBatchRecord.yaml

@@ -0,0 +1,49 @@
+description: Sed Batch Record
+type: object
+properties:
+  tenantId:
+    type: string
+    format: uuid
+    description: The tenant ID associated with the batch.
+    example: 123e4567-e89b-12d3-a456-426614174000
+  batchId:
+    type: string
+    format: uuid
+    description: The unique ID of the batch.
+    example: 016629d1-1d25-463f-97f3-c6686846650
+  name:
+    type: string
+    nullable: true
+    description: The name of the batch.
+    example: Example Batch Name
+  processedState:
+    type: string
+    nullable: true
+    description: The current state of the batch (e.g., submitted, materialized, completed).
+    example: submitted | materialized | completed | failed
+  requestedBy:
+    type: string
+    format: uuid
+    description: The ID of the user who requested the batch.
+    example: 987e6543-e21b-45d3-b123-123456789abc
+  materializedCount:
+    type: integer
+    format: int32
+    description: The number of items materialized in the batch.
+    example: 50
+  processedCount:
+    type: integer
+    format: int32
+    description: The number of items processed in the batch.
+    example: 45
+  createdAt:
+    type: string
+    format: date-time
+    description: The timestamp when the batch was created.
+    example: 2023-10-01T12:00:00Z
+  updatedAt:
+    type: string
+    format: date-time
+    nullable: true
+    description: The timestamp when the batch was last updated.
+    example: 2023-10-02T15:30:00Z

static/api-specs/idn/v2025/schemas/SedBatchRequest.yaml

@@ -5,6 +5,7 @@ properties:
   entitlements:
     description: list of entitlement ids
     type: array
+    nullable: true
     minItems: 1
     items:
       type: string
@@ -12,7 +13,13 @@ properties:
   seds:
     description: list of sed ids
     type: array
+    nullable: true
     minItems: 1
     items:
       type: string
       example: 016629d1-1d25-463f-97f3-c6686846650
+  searchCriteria:
+    additionalProperties:
+      $ref: SearchCriteria.yaml
+    nullable: true
+    description: Search criteria for the batch request.

static/api-specs/idn/v2025/schemas/SedBatchStatus.yaml

@@ -1,7 +0,0 @@
-description: Sed Batch Status
-type: object
-properties:
-  status:
-    description: status of batch
-    type: string
-    example: OK