diff --git a/idn/beta/paths/access-profile-entitlements.yaml b/idn/beta/paths/access-profile-entitlements.yaml
index 520fe07..3785ded 100644
--- a/idn/beta/paths/access-profile-entitlements.yaml
+++ b/idn/beta/paths/access-profile-entitlements.yaml
@@ -29,7 +29,8 @@ get:
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
- Filtering is supported for the following Entitlement fields and operators:
+ Filtering is supported for the following fields and operators:
+
**id**: *eq, in*
@@ -43,7 +44,10 @@ get:
**value**: *eq, sw*
- **created, modified**: *gt, lt, ge, le*
+ **created**: *gt, lt, ge, le*
+
+
+ **modified**: *gt, lt, ge, le*
**owner.id**: *eq, in*
diff --git a/idn/beta/paths/access-profiles.yaml b/idn/beta/paths/access-profiles.yaml
index 6a332b6..320a543 100644
--- a/idn/beta/paths/access-profiles.yaml
+++ b/idn/beta/paths/access-profiles.yaml
@@ -44,7 +44,10 @@ get:
**name**: *eq, sw*
- **created, modified**: *gt, lt, ge, le*
+ **created**: *gt, lt, ge, le*
+
+
+ **modified**: *gt, lt, ge, le*
**owner.id**: *eq, in*
@@ -54,9 +57,6 @@ get:
**source.id**: *eq, in*
-
-
- Composite operators supported: *and, or*
example: name eq "SailPoint Support"
required: false
- in: query
diff --git a/idn/beta/paths/accounts.yaml b/idn/beta/paths/accounts.yaml
index f582ce8..d1dc278 100644
--- a/idn/beta/paths/accounts.yaml
+++ b/idn/beta/paths/accounts.yaml
@@ -61,7 +61,7 @@ get:
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
- Sorting is supported for the following fields: **id**, **name**, **created**, **modified**
+ Sorting is supported for the following fields: **id, name, created, modified**
responses:
'200':
description: List of account objects
diff --git a/idn/beta/paths/ai-access-request-recommendations-ignored.yaml b/idn/beta/paths/ai-access-request-recommendations-ignored.yaml
index 17504c6..90d2227 100644
--- a/idn/beta/paths/ai-access-request-recommendations-ignored.yaml
+++ b/idn/beta/paths/ai-access-request-recommendations-ignored.yaml
@@ -47,7 +47,7 @@ get:
schema:
type: string
description: >-
- Filter recommendations using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
Filtering is supported for the following fields and operators:
@@ -60,6 +60,7 @@ get:
**identityId**: *eq, in*
+ example: identityId eq "2c9180846b0a0583016b299f210c1314"
- in: query
name: sorters
schema:
@@ -70,6 +71,7 @@ get:
Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp**
+ example: access.id
responses:
'200':
description: Returns list of ignored access request recommendations.
diff --git a/idn/beta/paths/ai-access-request-recommendations-requested.yaml b/idn/beta/paths/ai-access-request-recommendations-requested.yaml
index 12e7574..950813d 100644
--- a/idn/beta/paths/ai-access-request-recommendations-requested.yaml
+++ b/idn/beta/paths/ai-access-request-recommendations-requested.yaml
@@ -47,7 +47,7 @@ get:
schema:
type: string
description: >-
- Filter recommendations using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
Filtering is supported for the following fields and operators:
@@ -60,6 +60,7 @@ get:
**identityId**: *eq, in*
+ example: access.id eq "2c9180846b0a0583016b299f210c1314"
- in: query
name: sorters
schema:
diff --git a/idn/beta/paths/ai-access-request-recommendations-viewed.yaml b/idn/beta/paths/ai-access-request-recommendations-viewed.yaml
index 1397494..0956c6f 100644
--- a/idn/beta/paths/ai-access-request-recommendations-viewed.yaml
+++ b/idn/beta/paths/ai-access-request-recommendations-viewed.yaml
@@ -47,7 +47,7 @@ get:
schema:
type: string
description: >-
- Filter recommendations using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
Filtering is supported for the following fields and operators:
@@ -60,6 +60,7 @@ get:
**identityId**: *eq, in*
+ example: access.id eq "2c9180846b0a0583016b299f210c1314"
- in: query
name: sorters
schema:
diff --git a/idn/beta/paths/ai-access-request-recommendations.yaml b/idn/beta/paths/ai-access-request-recommendations.yaml
index 64a2805..43760bb 100644
--- a/idn/beta/paths/ai-access-request-recommendations.yaml
+++ b/idn/beta/paths/ai-access-request-recommendations.yaml
@@ -41,7 +41,7 @@ get:
schema:
type: string
description: >-
- Filter recommendations using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
Filtering is supported for the following fields and operators:
@@ -54,6 +54,7 @@ get:
**access.description**: *co*
+ example: access.name co "admin"
- in: query
name: sorters
schema:
diff --git a/idn/beta/paths/campaign-templates.yaml b/idn/beta/paths/campaign-templates.yaml
index 97ec711..998e845 100644
--- a/idn/beta/paths/campaign-templates.yaml
+++ b/idn/beta/paths/campaign-templates.yaml
@@ -36,7 +36,13 @@ get:
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
- Filtering is supported for the following fields: **name, id**
+ Filtering is supported for the following fields and operators:
+
+
+ **name**: *eq*
+
+
+ **id**: *eq*
example: name eq "manager template"
responses:
'200':
diff --git a/idn/beta/paths/campaigns.yaml b/idn/beta/paths/campaigns.yaml
index c3a08de..7873861 100644
--- a/idn/beta/paths/campaigns.yaml
+++ b/idn/beta/paths/campaigns.yaml
@@ -53,7 +53,7 @@ get:
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
- Sorting is supported for the following fields: **name**, **created**
+ Sorting is supported for the following fields: **name, created**
example: name
responses:
'200':
diff --git a/idn/beta/paths/certifications-entitlement-permissions.yaml b/idn/beta/paths/certifications-entitlement-permissions.yaml
index 994fca4..d071dde 100644
--- a/idn/beta/paths/certifications-entitlement-permissions.yaml
+++ b/idn/beta/paths/certifications-entitlement-permissions.yaml
@@ -17,7 +17,7 @@ get:
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
- Supported fields and primitive operators:
+ Filtering is supported for the following fields and operators:
**target**: *eq, sw*
@@ -26,29 +26,16 @@ get:
**rights**: *ca*
- Supported composite operators:
-
-
- *and, or*
-
-
All field values (second filter operands) are case-insensitive for this API.
- Only a single *and* or *or* composite filter operator may be used. It must also be used between
- a target filter and a rights filter, not between 2 filters for the same field.
-
- For example,
+ Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field.
- The following is valid:
-
- *?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22*
+ For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22`
- The following is invalid:
-
- *?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)*
+ The following is invalid: `?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)`
- in: path
name: id
schema:
diff --git a/idn/beta/paths/certifications-review-items.yaml b/idn/beta/paths/certifications-review-items.yaml
index 6a428ca..694eb68 100644
--- a/idn/beta/paths/certifications-review-items.yaml
+++ b/idn/beta/paths/certifications-review-items.yaml
@@ -31,7 +31,7 @@ get:
**id**: *eq, in*
- **completed***: *eq, ne*
+ **completed**: *eq, ne*
**targetSummary.id**: *eq, in*
@@ -53,6 +53,7 @@ get:
**reviewData.accessProfile.sourceName**: *eq, sw*
+ example: id eq "2c9180846b0a0583016b299f210c1314"
- in: query
name: sorters
schema:
@@ -63,6 +64,7 @@ get:
Sorting is supported for the following fields: **targetSummary.name, reviewData.entity.type, reviewData.entity.name, reviewData.entitlement.sourceName, reviewData.accessProfile.sourceName**
+ example: targetSummary.name
- in: query
name: activity-data
schema:
diff --git a/idn/beta/paths/certifications-reviewers.yaml b/idn/beta/paths/certifications-reviewers.yaml
index f13078c..a20f7e1 100644
--- a/idn/beta/paths/certifications-reviewers.yaml
+++ b/idn/beta/paths/certifications-reviewers.yaml
@@ -28,7 +28,7 @@ get:
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
- Filtering is supported for the following fields and operators (Filtering is done by reviewer's fields):
+ Filtering is supported for the following fields and operators:
**id**: *eq, in*
@@ -39,7 +39,6 @@ get:
**email**: *eq, sw*
example: name eq "Bob"
-
- in: query
name: sorters
schema:
diff --git a/idn/beta/paths/common-access.yaml b/idn/beta/paths/common-access.yaml
index 71e06d6..bdb6784 100644
--- a/idn/beta/paths/common-access.yaml
+++ b/idn/beta/paths/common-access.yaml
@@ -13,18 +13,29 @@ get:
- in: query
name: filters
description: >-
- Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407)
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
Filtering is supported for the following fields and operators:
- **status**: *eq* "CONFIRMED" or "DENIED"
- **reviewedByUser** *eq* true or false
- **access.id**: *eq* "id"
- **access.type**: *eq* "ROLE" or "ACCESS_PROFILE"
- **access.name**: *sw* "Administrator"
- **access.description**: *sw* "admin"
+ **status**: *eq*
+
+
+ **reviewedByUser** *eq*
+
+
+ **access.id**: *eq*
+
+
+ **access.type**: *eq*
+
+
+ **access.name**: *sw*
+
+
+ **access.description**: *sw*
+ example: access.type eq "ROLE"
required: false
style: form
explode: true
@@ -36,13 +47,14 @@ get:
type: string
format: comma-separated
description: >-
- Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407)
+ Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
- Sorting is supported for the following fields: **access.name,status**
+ Sorting is supported for the following fields: **access.name, status**
By default the common access items are sorted by name, ascending.
+ example: access.name
responses:
'200':
description: Succeeded. Returns a list of common access for a customer.
diff --git a/idn/beta/paths/connectors.yaml b/idn/beta/paths/connectors.yaml
index 94db718..ca5da95 100644
--- a/idn/beta/paths/connectors.yaml
+++ b/idn/beta/paths/connectors.yaml
@@ -15,6 +15,7 @@ get:
description: >-
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
Filtering is supported for the following fields and operators:
diff --git a/idn/beta/paths/ears-entitlement-children.yaml b/idn/beta/paths/ears-entitlement-children.yaml
index 0f3aba0..d169237 100644
--- a/idn/beta/paths/ears-entitlement-children.yaml
+++ b/idn/beta/paths/ears-entitlement-children.yaml
@@ -26,6 +26,7 @@ get:
description: >-
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id**
example: name,-modified
required: false
@@ -38,6 +39,7 @@ get:
description: >-
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
Filtering is supported for the following fields and operators:
@@ -61,7 +63,9 @@ get:
**requestable**: *eq*
+
**created**: *gt, lt, ge, le*
+
**modified**: *gt, lt, ge, le*
example: attribute eq "memberOf"
diff --git a/idn/beta/paths/ears-entitlement-parents.yaml b/idn/beta/paths/ears-entitlement-parents.yaml
index ce9aba9..ba75c1c 100644
--- a/idn/beta/paths/ears-entitlement-parents.yaml
+++ b/idn/beta/paths/ears-entitlement-parents.yaml
@@ -26,6 +26,7 @@ get:
description: >-
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id**
example: name,-modified
required: false
@@ -38,6 +39,7 @@ get:
description: >-
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
Filtering is supported for the following fields and operators:
@@ -61,8 +63,10 @@ get:
**requestable**: *eq*
+
**created**: *gt, lt, ge, le*
+
**modified**: *gt, lt, ge, le*
example: attribute eq "memberOf"
required: false
diff --git a/idn/beta/paths/entitlements.yaml b/idn/beta/paths/entitlements.yaml
index 7963851..631f66d 100644
--- a/idn/beta/paths/entitlements.yaml
+++ b/idn/beta/paths/entitlements.yaml
@@ -74,6 +74,7 @@ get:
description: >-
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id**
example: name,-modified
required: false
@@ -86,6 +87,7 @@ get:
description: >-
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
Filtering is supported for the following fields and operators:
@@ -109,8 +111,10 @@ get:
**requestable**: *eq*
+
**created**: *gt, lt, ge, le*
+
**modified**: *gt, lt, ge, le*
example: attribute eq "memberOf"
required: false
diff --git a/idn/beta/paths/form-definition-data-source.yaml b/idn/beta/paths/form-definition-data-source.yaml
index 7b8f803..3bc3137 100644
--- a/idn/beta/paths/form-definition-data-source.yaml
+++ b/idn/beta/paths/form-definition-data-source.yaml
@@ -32,14 +32,20 @@ post:
x-go-name: Limit
- name: filters
in: query
- description: |-
- Filters
-
+ description: >-
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
+
Filtering is supported for the following fields and operators:
- value: eq, gt, sw, in
- label: eq, gt, sw, in
- subLabel: eq, gt, sw, in
+
+
+ **value**: *eq, gt, sw, in*
+
+
+ **label**: *eq, gt, sw, in*
+
+
+ **subLabel**: *eq, gt, sw, in*
schema:
type: string
x-go-name: Filters
diff --git a/idn/beta/paths/form-definitions-export.yaml b/idn/beta/paths/form-definitions-export.yaml
index d7b7794..252b957 100644
--- a/idn/beta/paths/form-definitions-export.yaml
+++ b/idn/beta/paths/form-definitions-export.yaml
@@ -39,15 +39,23 @@ get:
x-go-name: Limit
- name: filters
in: query
- description: |-
- Filters
-
+ description: >-
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
+
Filtering is supported for the following fields and operators:
- name: eq, gt, sw, in
- description: eq, gt, sw, in
- created: eq, gt, sw, in
- modified: eq, gt, sw, in
+
+
+ **name**: *eq, gt, sw, in*
+
+
+ **description**: *eq, gt, sw, in*
+
+
+ **created**: *eq, gt, sw, in*
+
+
+ **modified**: *eq, gt, sw, in*
schema:
type: string
x-go-name: Filters
@@ -56,15 +64,11 @@ get:
x-go-name: Filters
- name: sorters
in: query
- description: |-
- Sorters
+ description: >-
+ Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
- Item will be sorted in the returned array if the sorters expression evaluates to true for that item. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/#sorting-results).
- Sorting is supported for the following fields:
- name
- description
- created
- modified
+
+ Sorting is supported for the following fields: **name, description, created, modified**
schema:
type: string
default: name
diff --git a/idn/beta/paths/form-definitions.yaml b/idn/beta/paths/form-definitions.yaml
index 1ed399f..51e0861 100644
--- a/idn/beta/paths/form-definitions.yaml
+++ b/idn/beta/paths/form-definitions.yaml
@@ -39,15 +39,23 @@ get:
x-go-name: Limit
- name: filters
in: query
- description: |-
- Filters
-
+ description: >-
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
+
Filtering is supported for the following fields and operators:
- name: eq, gt, sw, in
- description: eq, gt, sw, in
- created: eq, gt, sw, in
- modified: eq, gt, sw, in
+
+
+ **name**: *eq, gt, sw, in*
+
+
+ **description**: *eq, gt, sw, in*
+
+
+ **created**: *eq, gt, sw, in*
+
+
+ **modified**: *eq, gt, sw, in*
schema:
type: string
x-go-name: Filters
@@ -56,15 +64,11 @@ get:
x-go-name: Filters
- name: sorters
in: query
- description: |-
- Sorters
+ description: >-
+ Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
- Item will be sorted in the returned array if the sorters expression evaluates to true for that item. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/#sorting-results).
- Sorting is supported for the following fields:
- name
- description
- created
- modified
+
+ Sorting is supported for the following fields: **name, description, created, modified**
schema:
type: string
default: name
diff --git a/idn/beta/paths/form-instance-data-source.yaml b/idn/beta/paths/form-instance-data-source.yaml
index b4ae19c..b3c2ac8 100644
--- a/idn/beta/paths/form-instance-data-source.yaml
+++ b/idn/beta/paths/form-instance-data-source.yaml
@@ -44,14 +44,20 @@ get:
x-go-name: Limit
- name: filters
in: query
- description: |-
- Filters
-
+ description: >-
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
+
Filtering is supported for the following fields and operators:
- value: eq, ne, in
- label: eq, ne, in
- subLabel: eq, ne, in
+
+
+ **value**: *eq, ne, in*
+
+
+ **label**: *eq, ne, in*
+
+
+ **subLabel**: *eq, ne, in*
schema:
type: string
x-go-name: Filters
diff --git a/idn/beta/paths/iai-configurations.yaml b/idn/beta/paths/iai-configurations.yaml
index a34d030..fe26e82 100644
--- a/idn/beta/paths/iai-configurations.yaml
+++ b/idn/beta/paths/iai-configurations.yaml
@@ -12,7 +12,7 @@ get:
schema:
type: string
description: >-
- Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://app.getguru.com/card/crkL5RGi/WIP-V3-Standard-Collection-Parameters)
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
Filtering is supported for the following fields and operators:
diff --git a/idn/beta/paths/iai-data-role-entitlement-identities.yaml b/idn/beta/paths/iai-data-role-entitlement-identities.yaml
index d801502..2791fa8 100644
--- a/idn/beta/paths/iai-data-role-entitlement-identities.yaml
+++ b/idn/beta/paths/iai-data-role-entitlement-identities.yaml
@@ -35,17 +35,30 @@ get:
- $ref: '../../v3/parameters/count.yaml'
- in: query
name: sorters
- description: sort by name
+ description: >-
+ Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
+
+ Sorting is supported for the following fields: **name**
required: false
style: form
explode: true
+ example: name
schema:
type: string
- in: query
name: filters
- description: filter param by "starts with" for name
+ description: >-
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
+
+ Filtering is supported for the following fields and operators:
+
+
+ **name**: *sw*
required: false
style: form
+ example: name sw "Admin"
explode: true
schema:
type: string
diff --git a/idn/beta/paths/iai-data-role-entitlements.yaml b/idn/beta/paths/iai-data-role-entitlements.yaml
index 765bc78..22c30e4 100644
--- a/idn/beta/paths/iai-data-role-entitlements.yaml
+++ b/idn/beta/paths/iai-data-role-entitlements.yaml
@@ -18,7 +18,12 @@ get:
- $ref: '../../v3/parameters/count.yaml'
- in: query
name: sorters
- description: sort by name
+ description: >-
+ Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
+
+ Sorting is supported for the following fields: **name**
+ example: name
required: false
style: form
explode: true
@@ -26,7 +31,15 @@ get:
type: string
- in: query
name: filters
- description: filter param by "starts with" for name
+ description: >-
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
+
+ Filtering is supported for the following fields and operators:
+
+
+ **name**: *sw*
+ example: name sw "Jan"
required: false
style: form
explode: true
diff --git a/idn/beta/paths/iai-data-role-identities-entitlements.yaml b/idn/beta/paths/iai-data-role-identities-entitlements.yaml
index 18750d0..16a11b9 100644
--- a/idn/beta/paths/iai-data-role-identities-entitlements.yaml
+++ b/idn/beta/paths/iai-data-role-identities-entitlements.yaml
@@ -34,7 +34,11 @@ get:
type: integer
- in: query
name: sorters
- description: sort by name
+ description: >-
+ Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
+
+ Sorting is supported for the following fields: **name**
required: false
style: form
explode: true
@@ -42,7 +46,15 @@ get:
type: string
- in: query
name: filters
- description: filter param by "starts with" for name
+ description: >-
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
+
+ Filtering is supported for the following fields and operators:
+
+
+ **name**: *sw*
+ example: name sw "A"
required: false
style: form
explode: true
diff --git a/idn/beta/paths/iai-data-roles.yaml b/idn/beta/paths/iai-data-roles.yaml
index 281d3df..fa487cc 100644
--- a/idn/beta/paths/iai-data-roles.yaml
+++ b/idn/beta/paths/iai-data-roles.yaml
@@ -18,7 +18,7 @@ get:
Filtering is supported for the following fields and operators:
- **isAssignable**: *eq* "true" or "false"
+ **isAssignable**: *eq*
required: false
style: form
explode: true
diff --git a/idn/beta/paths/identities.yaml b/idn/beta/paths/identities.yaml
index 6c8e54a..9121515 100644
--- a/idn/beta/paths/identities.yaml
+++ b/idn/beta/paths/identities.yaml
@@ -12,9 +12,9 @@ get:
type: string
required: false
description: >-
- Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters)
-
-
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
+
Filtering is supported for the following fields and operators:
@@ -54,7 +54,7 @@ get:
format: comma-separated
required: false
description: >-
- Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/#sorting-results)
+ Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
Sorting is supported for the following fields: **name, alias, cloudStatus**
diff --git a/idn/beta/paths/identity-certifications-item-permissions.yaml b/idn/beta/paths/identity-certifications-item-permissions.yaml
index 6a94eee..a862075 100644
--- a/idn/beta/paths/identity-certifications-item-permissions.yaml
+++ b/idn/beta/paths/identity-certifications-item-permissions.yaml
@@ -19,7 +19,7 @@ get:
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
- Supported fields and primitive operators:
+ Filtering is supported for the following fields and operators:
**target**: *eq, sw*
@@ -28,29 +28,16 @@ get:
**rights**: *ca*
- Supported composite operators:
-
-
- *and, or*
-
-
All field values (second filter operands) are case-insensitive for this API.
- Only a single *and* or *or* composite filter operator may be used. It must also be used between
- a target filter and a rights filter, not between 2 filters for the same field.
-
- For example,
+ Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field.
- The following is valid:
-
- *?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22*
+ For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22`
- The following is invalid:
-
- *?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)*
+ The following is invalid: `?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)`
example: target eq "SYS.OBJAUTH2"
- in: path
name: certificationId
diff --git a/idn/beta/paths/identity-group-applications.yaml b/idn/beta/paths/identity-group-applications.yaml
index 8112fc3..c9843b0 100644
--- a/idn/beta/paths/identity-group-applications.yaml
+++ b/idn/beta/paths/identity-group-applications.yaml
@@ -21,9 +21,14 @@ get:
schema:
type: string
description: >-
- Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://app.getguru.com/card/crkL5RGi/WIP-V3-Standard-Collection-Parameters)
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
+
Filtering is supported for the following fields and operators:
+
+
**attributes**: *eq, sw*
+ example: attributes sw "r"
responses:
'200':
description: The applications for an identity group
diff --git a/idn/beta/paths/identity-group-distribution.yaml b/idn/beta/paths/identity-group-distribution.yaml
index d3d275b..9088ddd 100644
--- a/idn/beta/paths/identity-group-distribution.yaml
+++ b/idn/beta/paths/identity-group-distribution.yaml
@@ -21,9 +21,14 @@ get:
schema:
type: string
description: >-
- Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://app.getguru.com/card/crkL5RGi/WIP-V3-Standard-Collection-Parameters)
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
+
Filtering is supported for the following fields and operators:
+
+
**attributes**: *eq, sw*
+ example: attributes eq "attribute1"
responses:
'200':
description: A summary of identity group
diff --git a/idn/beta/paths/identity-group-entitlement-popularities.yaml b/idn/beta/paths/identity-group-entitlement-popularities.yaml
index b12786c..02edc37 100644
--- a/idn/beta/paths/identity-group-entitlement-popularities.yaml
+++ b/idn/beta/paths/identity-group-entitlement-popularities.yaml
@@ -21,9 +21,14 @@ get:
schema:
type: string
description: >-
- Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://app.getguru.com/card/crkL5RGi/WIP-V3-Standard-Collection-Parameters)
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
+
Filtering is supported for the following fields and operators:
+
+
**attributes**: *eq, sw*
+ example: attributes eq "attribute1"
responses:
'200':
description: The popular entitlements in an identity group
diff --git a/idn/beta/paths/identity-group-identities.yaml b/idn/beta/paths/identity-group-identities.yaml
index 1c83490..96c46a3 100644
--- a/idn/beta/paths/identity-group-identities.yaml
+++ b/idn/beta/paths/identity-group-identities.yaml
@@ -21,9 +21,14 @@ get:
schema:
type: string
description: >-
- Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://app.getguru.com/card/crkL5RGi/WIP-V3-Standard-Collection-Parameters)
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
+
Filtering is supported for the following fields and operators:
+
+
**attributes**: *eq, sw*
+ example: attributes sw "r"
responses:
'200':
description: The identities for an identity group
diff --git a/idn/beta/paths/identity-groups.yaml b/idn/beta/paths/identity-groups.yaml
index 2254e29..87dbd69 100644
--- a/idn/beta/paths/identity-groups.yaml
+++ b/idn/beta/paths/identity-groups.yaml
@@ -14,9 +14,14 @@ get:
schema:
type: string
description: >-
- Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://app.getguru.com/card/crkL5RGi/WIP-V3-Standard-Collection-Parameters)
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
+
Filtering is supported for the following fields and operators:
+
+
**attributes**: *eq, sw*
+ example: attributes eq "attribute1"
responses:
'200':
description: A list of identity groups for the customer.
diff --git a/idn/beta/paths/identity-profiles-export.yaml b/idn/beta/paths/identity-profiles-export.yaml
index e4084e1..c7bafaf 100644
--- a/idn/beta/paths/identity-profiles-export.yaml
+++ b/idn/beta/paths/identity-profiles-export.yaml
@@ -37,7 +37,7 @@ get:
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
- Sorting is supported for the following fields: **id**, **name**, **priority**
+ Sorting is supported for the following fields: **id, name, priority**
example: name,-priority
responses:
'200':
diff --git a/idn/beta/paths/identity-profiles.yaml b/idn/beta/paths/identity-profiles.yaml
index e56040a..ce3cdb0 100644
--- a/idn/beta/paths/identity-profiles.yaml
+++ b/idn/beta/paths/identity-profiles.yaml
@@ -39,7 +39,7 @@ get:
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
- Sorting is supported for the following fields: **id**, **name**, **priority**
+ Sorting is supported for the following fields: **id, name, priority**
example: name,-priority
responses:
'200':
diff --git a/idn/beta/paths/managed-clients.yaml b/idn/beta/paths/managed-clients.yaml
index 910ed17..b10d86c 100644
--- a/idn/beta/paths/managed-clients.yaml
+++ b/idn/beta/paths/managed-clients.yaml
@@ -14,11 +14,21 @@ get:
schema:
type: string
description: >-
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
+
Filtering is supported for the following fields and operators:
+
**id**: *eq*
+
+
**name**: *eq*
+
+
**clientId**: *eq*
+
+
**clusterId**: *eq*
example: name eq "client name"
responses:
diff --git a/idn/beta/paths/managed-clusters-full.yaml b/idn/beta/paths/managed-clusters-full.yaml
index d164ca3..854e0b6 100644
--- a/idn/beta/paths/managed-clusters-full.yaml
+++ b/idn/beta/paths/managed-clusters-full.yaml
@@ -13,11 +13,14 @@ get:
schema:
type: string
description: >-
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
+
Filtering is supported for the following fields and operators:
**operational**: *eq*
- example: operational eq operation
+ example: operational eq "operation"
responses:
"200":
description: Responds with a list of ManagedCluster.
diff --git a/idn/beta/paths/managed-clusters.yaml b/idn/beta/paths/managed-clusters.yaml
index 9c9edf8..04131d4 100644
--- a/idn/beta/paths/managed-clusters.yaml
+++ b/idn/beta/paths/managed-clusters.yaml
@@ -13,6 +13,9 @@ get:
schema:
type: string
description: >-
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
+
Filtering is supported for the following fields and operators:
diff --git a/idn/beta/paths/non-employee-approval-list.yaml b/idn/beta/paths/non-employee-approval-list.yaml
index 9a04c5e..537d644 100644
--- a/idn/beta/paths/non-employee-approval-list.yaml
+++ b/idn/beta/paths/non-employee-approval-list.yaml
@@ -21,28 +21,29 @@ get:
- $ref: "../../v3/parameters/offset.yaml"
- $ref: "../../v3/parameters/count.yaml"
- in: query
- example: "filters=approvalStatus eq 'PENDING'"
+ example: approvalStatus eq "PENDING"
name: filters
schema:
type: string
description: >-
- Filter results using the standard syntax described in [V3 API Standard
- Collection
- Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
+
Filtering is supported for the following fields and operators:
- **approvalStatus**: *eq* *Example:* approvalStatus eq "PENDING"
+
+
+ **approvalStatus**: *eq*
- in: query
- example: "sorters=-created"
+ example: created
name: sorters
schema:
type: string
format: comma-separated
description: >-
- Sort results using the standard syntax described in [V3 API Standard
- Collection
- Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
- Sorting is supported for the following fields: **created, modified**
+ Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
+ Sorting is supported for the following fields: **created, modified**
responses:
"200":
description: List of approval items.
diff --git a/idn/beta/paths/non-employee-records.yaml b/idn/beta/paths/non-employee-records.yaml
index 399721a..6e6bf13 100644
--- a/idn/beta/paths/non-employee-records.yaml
+++ b/idn/beta/paths/non-employee-records.yaml
@@ -57,12 +57,10 @@ get:
format: comma-separated
example: accountName,sourceId
description: >-
- Sort results using the standard syntax described in [V3 API Standard
- Collection
- Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
- Sorting is supported for the following fields: **id, accountName,
- sourceId, manager, firstName, lastName, email, phone, startDate,
- endDate, created, modified**
+ Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
+
+ Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified**
- in: query
name: filters
required: false
@@ -70,12 +68,13 @@ get:
type: string
example: sourceId eq "2c91808568c529c60168cca6f90c1313"
description: >-
- Filter results using the standard syntax described in [V3 API Standard
- Collection
- Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
+
Filtering is supported for the following fields and operators:
- **sourceId**: *eq* *Example:* sourceId eq
- "2c91808568c529c60168cca6f90c1313"
+
+
+ **sourceId**: *eq*
responses:
"200":
description: Non-Employee record objects
diff --git a/idn/beta/paths/non-employee-requests.yaml b/idn/beta/paths/non-employee-requests.yaml
index 5951930..bf407ff 100644
--- a/idn/beta/paths/non-employee-requests.yaml
+++ b/idn/beta/paths/non-employee-requests.yaml
@@ -86,12 +86,10 @@ get:
format: comma-separated
example: approvalStatus,firstName
description: >-
- Sort results using the standard syntax described in [V3 API Standard
- Collection
- Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
- Sorting is supported for the following fields: **created,
- approvalStatus, firstName, lastName, email, phone, accountName,
- startDate, endDate**
+ Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
+
+ Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate**
- in: query
name: filters
required: false
@@ -99,12 +97,13 @@ get:
type: string
example: sourceId eq "2c91808568c529c60168cca6f90c1313"
description: >-
- Filter results using the standard syntax described in [V3 API Standard
- Collection
- Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
+
Filtering is supported for the following fields and operators:
- **sourceId**: *eq* *Example:* sourceId eq
- "2c91808568c529c60168cca6f90c1313"
+
+
+ **sourceId**: *eq*
responses:
"200":
description: List of non-employee request objects.
diff --git a/idn/beta/paths/non-employee-sources.yaml b/idn/beta/paths/non-employee-sources.yaml
index a6e2c69..a3f2581 100644
--- a/idn/beta/paths/non-employee-sources.yaml
+++ b/idn/beta/paths/non-employee-sources.yaml
@@ -74,9 +74,9 @@ get:
format: comma-separated
example: name,created
description: >-
- Sort results using the standard syntax described in [V3 API Standard
- Collection
- Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+ Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
+
Sorting is supported for the following fields: **name, created**
responses:
"200":
diff --git a/idn/beta/paths/outlier-summaries.yaml b/idn/beta/paths/outlier-summaries.yaml
index ecbd25f..ecdcc98 100644
--- a/idn/beta/paths/outlier-summaries.yaml
+++ b/idn/beta/paths/outlier-summaries.yaml
@@ -26,9 +26,12 @@ get:
description: >-
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
- Filtering is supported for the following field and operators:
+
+ Filtering is supported for the following fields and operators:
+
**snapshotDate**: *ge, le*
+ example: snapshotDate ge "2022-02-07T20:13:29.356648026Z"
- in: query
name: sorters
schema:
@@ -37,7 +40,8 @@ get:
description: >-
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
- Sorting is supported for the following field: **snapshotDate**
+
+ Sorting is supported for the following fields: **snapshotDate**
example: snapshotDate
required: false
responses:
diff --git a/idn/beta/paths/outliers-contributing-feature-access-items.yaml b/idn/beta/paths/outliers-contributing-feature-access-items.yaml
index 56a6f6a..cc86f26 100644
--- a/idn/beta/paths/outliers-contributing-feature-access-items.yaml
+++ b/idn/beta/paths/outliers-contributing-feature-access-items.yaml
@@ -50,6 +50,7 @@ get:
description: >-
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
Sorting is supported for the following fields: **displayName**
responses:
'200':
diff --git a/idn/beta/paths/outliers-contributing-features.yaml b/idn/beta/paths/outliers-contributing-features.yaml
index a4a02d0..5c010d4 100644
--- a/idn/beta/paths/outliers-contributing-features.yaml
+++ b/idn/beta/paths/outliers-contributing-features.yaml
@@ -32,10 +32,11 @@ get:
schema:
type: string
format: comma-separated
- example: importance
+ example: importance
description: >-
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
Sorting is supported for the following fields: **importance**
responses:
'200':
diff --git a/idn/beta/paths/outliers.yaml b/idn/beta/paths/outliers.yaml
index cf7f21e..722f261 100644
--- a/idn/beta/paths/outliers.yaml
+++ b/idn/beta/paths/outliers.yaml
@@ -25,13 +25,13 @@ get:
name: filters
required: false
schema:
- type: string
- example: attributes.displayName sw "John" and certStatus eq "false"
+ type: string
description: >-
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
- Filtering is supported for the following Entitlement fields and operators:
+ Filtering is supported for the following fields and operators:
+
**attributes**: *eq, sw, co, in*
@@ -46,17 +46,19 @@ get:
**score**: *ge, le*
+ example: attributes.displayName sw "John" and certStatus eq "false"
- in: query
name: sorters
required: false
schema:
type: string
- format: comma-separated
- example: attributes.displayName,firstDetectionDate,-score
+ format: comma-separated
description: >-
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
Sorting is supported for the following fields: **firstDetectionDate, attributes, score**
+ example: attributes.displayName,firstDetectionDate,-score
responses:
'200':
description: Succeeded. Returns list of objects. Each object contains information about outliers
diff --git a/idn/beta/paths/role-access-profiles.yaml b/idn/beta/paths/role-access-profiles.yaml
index eeac6ff..f94d379 100644
--- a/idn/beta/paths/role-access-profiles.yaml
+++ b/idn/beta/paths/role-access-profiles.yaml
@@ -29,7 +29,8 @@ get:
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
- Filtering is supported for the following Access Profile fields and operators:
+ Filtering is supported for the following fields and operators:
+
**id**: *eq, in*
@@ -37,7 +38,10 @@ get:
**name**: *eq, sw*
- **created, modified**: *gt, lt, ge, le*
+ **created**: *gt, lt, ge, le*
+
+
+ **modified**: *gt, lt, ge, le*
**owner.id**: *eq, in*
diff --git a/idn/beta/paths/role-assigned-identities.yaml b/idn/beta/paths/role-assigned-identities.yaml
index 6c3cb8b..9166905 100644
--- a/idn/beta/paths/role-assigned-identities.yaml
+++ b/idn/beta/paths/role-assigned-identities.yaml
@@ -46,7 +46,7 @@ get:
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
- Sorting is supported for the following fields: **id**, **name**, **aliasName**, **email**
+ Sorting is supported for the following fields: **id, name, aliasName, email**
example: aliasName,name
responses:
'200':
diff --git a/idn/beta/paths/role-insights-current-entitlements.yaml b/idn/beta/paths/role-insights-current-entitlements.yaml
index 0bb3417..f09c178 100644
--- a/idn/beta/paths/role-insights-current-entitlements.yaml
+++ b/idn/beta/paths/role-insights-current-entitlements.yaml
@@ -15,7 +15,18 @@ get:
example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb
- in: query
name: filters
- description: Filter parameter(s) by "starts with" for the name and description.
+ description: >-
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
+
+ Filtering is supported for the following fields and operators:
+
+
+ **name**: *sw*
+
+
+ **description**: *sw*
+ example: name sw "r"
required: false
style: form
explode: true
diff --git a/idn/beta/paths/role-insights-entitlement-changes-download.yaml b/idn/beta/paths/role-insights-entitlement-changes-download.yaml
index a1fca7b..aea6778 100644
--- a/idn/beta/paths/role-insights-entitlement-changes-download.yaml
+++ b/idn/beta/paths/role-insights-entitlement-changes-download.yaml
@@ -15,15 +15,34 @@ get:
example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb
- in: query
name: sorters
- description: sort by identitiesWithAccess, default order descending
+ description: >-
+ Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
+
+ Sorting is supported for the following fields: **identitiesWithAccess**
+
+
+ The default sort is **identitiesWithAccess** in descending order.
required: false
+ example: identitiesWithAccess
style: form
explode: true
schema:
type: string
- in: query
name: filters
- description: Filter parameter(s) by "starts with" for the name and description.
+ description: >-
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
+
+ Filtering is supported for the following fields and operators:
+
+
+ **name**: *sw*
+
+
+ **description**: *sw*
+ example: name sw "r"
required: false
style: form
explode: true
diff --git a/idn/beta/paths/role-insights-entitlement-changes-identities.yaml b/idn/beta/paths/role-insights-entitlement-changes-identities.yaml
index 1eda5ef..1c1cf89 100644
--- a/idn/beta/paths/role-insights-entitlement-changes-identities.yaml
+++ b/idn/beta/paths/role-insights-entitlement-changes-identities.yaml
@@ -36,7 +36,12 @@ get:
- $ref: '../../v3/parameters/count.yaml'
- in: query
name: sorters
- description: sort by name
+ description: >-
+ Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
+
+ Sorting is supported for the following fields: **name**
+ example: name
required: false
style: form
explode: true
@@ -44,7 +49,15 @@ get:
type: string
- in: query
name: filters
- description: Filter parameter by "starts with" for the name.
+ description: >-
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
+
+ Filtering is supported for the following fields and operators:
+
+
+ **name**: *sw*
+ example: name sw "Jan"
required: false
style: form
explode: true
diff --git a/idn/beta/paths/role-insights-entitlement-changes.yaml b/idn/beta/paths/role-insights-entitlement-changes.yaml
index abdb5f8..270cd4c 100644
--- a/idn/beta/paths/role-insights-entitlement-changes.yaml
+++ b/idn/beta/paths/role-insights-entitlement-changes.yaml
@@ -15,7 +15,11 @@ get:
example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb
- in: query
name: sorters
- description: sort by identitiesWithAccess or name
+ description: >-
+ Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
+
+ Sorting is supported for the following fields: **identitiesWithAccess, name**
required: false
style: form
explode: true
@@ -23,9 +27,20 @@ get:
type: string
- in: query
name: filters
- description: Filter parameter(s) by "starts with" for the name and description.
+ description: >-
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
+
+ Filtering is supported for the following fields and operators:
+
+
+ **name**: *sw*
+
+
+ **description**: *sw*
required: false
style: form
+ example: name sw "Admin"
explode: true
schema:
type: string
diff --git a/idn/beta/paths/role-insights.yaml b/idn/beta/paths/role-insights.yaml
index 32aa8a9..be7e248 100644
--- a/idn/beta/paths/role-insights.yaml
+++ b/idn/beta/paths/role-insights.yaml
@@ -11,7 +11,12 @@ get:
- $ref: '../../v3/parameters/count.yaml'
- name: sorters
in: query
- description: sort by numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities (default- ascending)
+ description: >-
+ Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
+
+ Sorting is supported for the following fields: **numberOfUpdates, identitiesWithAccess, totalNumberOfIdentities**
+ example: numberOfUpdates
required: false
style: form
explode: true
@@ -19,10 +24,24 @@ get:
type: string
- name: filters
in: query
- description: Filter parameter(s) by "starts with" for the name, ownerName and description.
+ description: >-
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
+
+ Filtering is supported for the following fields and operators:
+
+
+ **name**: *sw*
+
+
+ **ownerName**: *sw*
+
+
+ **description**: *sw*
required: false
style: form
explode: true
+ example: name sw "John"
schema:
type: string
responses:
diff --git a/idn/beta/paths/role-mining-potential-role-entitlement-popularities.yaml b/idn/beta/paths/role-mining-potential-role-entitlement-popularities.yaml
index 75df9fc..735a5ae 100644
--- a/idn/beta/paths/role-mining-potential-role-entitlement-popularities.yaml
+++ b/idn/beta/paths/role-mining-potential-role-entitlement-popularities.yaml
@@ -30,7 +30,15 @@ get:
type: boolean
- in: query
name: sorters
- description: sort by popularity, default order descending
+ description: >-
+ Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
+
+ Sorting is supported for the following fields: **popularity**
+
+
+ The default sort is **popularity** in descending order.
+ example: popularity
required: false
style: form
explode: true
@@ -38,7 +46,18 @@ get:
type: string
- in: query
name: filters
- description: Filter parameter by "starts with" for the applicationName and entitlementRef.name.
+ description: >-
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
+
+ Filtering is supported for the following fields and operators:
+
+
+ **applicationName**: *sw*
+
+
+ **entitlementRef.name**: *sw*
+ example: applicationName sw "AD"
required: false
style: form
explode: true
diff --git a/idn/beta/paths/role-mining-potential-role-excluded-entitlements.yaml b/idn/beta/paths/role-mining-potential-role-excluded-entitlements.yaml
index fffdf86..9110fee 100644
--- a/idn/beta/paths/role-mining-potential-role-excluded-entitlements.yaml
+++ b/idn/beta/paths/role-mining-potential-role-excluded-entitlements.yaml
@@ -22,7 +22,12 @@ get:
example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb
- in: query
name: sorters
- description: sort by popularity, default order descending
+ description: >-
+ Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
+
+ Sorting is supported for the following fields: **popularity**
+ example: populariity
required: false
style: form
explode: true
@@ -30,7 +35,18 @@ get:
type: string
- in: query
name: filters
- description: Filter parameter by "starts with" for the applicationName and entitlementRef.name.
+ description: >-
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
+
+ Filtering is supported for the following fields and operators:
+
+
+ **applicationName**: *sw*
+
+
+ **entitlementRef.name**: *sw*
+ example: applicationName sw "AD"
required: false
style: form
explode: true
diff --git a/idn/beta/paths/role-mining-potential-role-identities.yaml b/idn/beta/paths/role-mining-potential-role-identities.yaml
index 0d77013..cfd0646 100644
--- a/idn/beta/paths/role-mining-potential-role-identities.yaml
+++ b/idn/beta/paths/role-mining-potential-role-identities.yaml
@@ -22,15 +22,27 @@ get:
example: 8c190e67-87aa-4ed9-a90b-d9d5344523fb
- in: query
name: sorters
- description: sort by name, default order ascending
+ description: >-
+ Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
+
+ Sorting is supported for the following fields: **name**
required: false
style: form
explode: true
+ example: name
schema:
type: string
- in: query
name: filters
- description: Filter parameter by "starts with" for the name.
+ description: >-
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
+
+ Filtering is supported for the following fields and operators:
+
+
+ **name**: *sw*
required: false
style: form
explode: true
diff --git a/idn/beta/paths/role-mining-potential-role-summaries.yaml b/idn/beta/paths/role-mining-potential-role-summaries.yaml
index dabfed7..53341aa 100644
--- a/idn/beta/paths/role-mining-potential-role-summaries.yaml
+++ b/idn/beta/paths/role-mining-potential-role-summaries.yaml
@@ -17,41 +17,57 @@ get:
type: string
format: comma-separated
description: >-
- Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/)
+ Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
+
Sorting is supported for the following fields: **createdDate**
- example: 'createdDate'
+ example: createdDate
- in: query
name: filters
description: >-
- Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/)
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
+
Filtering is supported for the following fields and operators:
+
**createdById**: *eq, sw, co*
+
**createdByName**: *eq, sw, co*
+
**description**: *sw, co*
+
**endDate**: *le, lt*
+
**freshness**: *eq, ge, gt, le, lt*
+
**name**: *eq, sw, co*
+
**quality**: *eq, ge, gt, le, lt*
+
**startDate**: *ge, gt*
+
**saved**: *eq*
+
**type**: *eq*
+
**scopingMethod**: *eq*
+
**sessionState**: *eq*
+
**identityAttribute**: *co*
-
example: '(createdByName co "int") and (createdById sw "2c9180907") and (type eq "COMMON") and ((name co "entt") or (saved eq true))'
required: false
style: form
diff --git a/idn/beta/paths/role-mining-session-potential-role-summaries.yaml b/idn/beta/paths/role-mining-session-potential-role-summaries.yaml
index 224fb36..4b299b9 100644
--- a/idn/beta/paths/role-mining-session-potential-role-summaries.yaml
+++ b/idn/beta/paths/role-mining-session-potential-role-summaries.yaml
@@ -22,35 +22,48 @@ get:
type: string
format: comma-separated
description: >-
- Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/)
+ Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
+
Sorting is supported for the following fields: **createdDate**
- example: 'createdDate'
+ example: createdDate
- in: query
name: filters
description: >-
- Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/)
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
+
Filtering is supported for the following fields and operators:
+
**createdById**: *eq, sw, co*
+
**createdByName**: *eq, sw, co*
+
**description**: *sw, co*
+
**endDate**: *le, lt*
+
**freshness**: *eq, ge, gt, le, lt*
+
**name**: *eq, sw, co*
+
**quality**: *eq, ge, gt, le, lt*
+
**startDate**: *ge, gt*
+
**saved**: *eq*
- **type**: *eq*
+ **type**: *eq*
example: '(createdByName co "int")and (createdById sw "2c9180907")and (type eq "COMMON")and ((name co "entt")or (saved eq true))'
required: false
style: form
diff --git a/idn/beta/paths/role-mining-sessions.yaml b/idn/beta/paths/role-mining-sessions.yaml
index 8bb341d..dd5abf0 100644
--- a/idn/beta/paths/role-mining-sessions.yaml
+++ b/idn/beta/paths/role-mining-sessions.yaml
@@ -44,10 +44,16 @@ get:
type: string
description: >-
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
+
Filtering is supported for the following fields and operators:
- **saved**: *eq* "true" or "false"
+
+
+ **saved**: *eq*
+
+
**name**: *eq, sw*
- example: 'saved eq "true" and name sw "RM Session"'
+ example: saved eq "true" and name sw "RM Session"
- in: query
name: sorters
schema:
@@ -55,8 +61,10 @@ get:
format: comma-separated
description: >-
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
+
Sorting is supported for the following fields: **createdBy, createdDate**
- example: 'createdBy,createdDate'
+ example: createdBy,createdDate
- $ref: '../../v3/parameters/offset.yaml'
- $ref: '../../v3/parameters/limit.yaml'
- $ref: '../../v3/parameters/count.yaml'
diff --git a/idn/beta/paths/roles.yaml b/idn/beta/paths/roles.yaml
index 80323d2..eafe0f3 100644
--- a/idn/beta/paths/roles.yaml
+++ b/idn/beta/paths/roles.yaml
@@ -42,16 +42,16 @@ get:
**name**: *eq, sw*
- **created, modified**: *gt, lt, ge, le*
+ **created**: *gt, lt, ge, le*
+
+
+ **modified**: *gt, lt, ge, le*
**owner.id**: *eq, in*
**requestable**: *eq*
-
-
- Composite operators supported: *and, or*
example: requestable eq false
required: false
- in: query
@@ -61,8 +61,9 @@ get:
format: comma-separated
description: >-
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
+
Sorting is supported for the following fields: **name, created, modified**
-
example: name,-modified
required: false
- in: query
diff --git a/idn/beta/paths/saas-management-applications.yaml b/idn/beta/paths/saas-management-applications.yaml
index 96b3125..53b0572 100644
--- a/idn/beta/paths/saas-management-applications.yaml
+++ b/idn/beta/paths/saas-management-applications.yaml
@@ -13,7 +13,7 @@ get:
schema:
type: string
description: >-
- Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407)
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
Filtering is supported for the following fields and operators:
@@ -29,6 +29,7 @@ get:
**integrationState**: *eq, in*
+ example: id eq ""
- $ref: '../../v3/parameters/limit.yaml'
- $ref: '../../v3/parameters/offset.yaml'
- $ref: '../../v3/parameters/count.yaml'
diff --git a/idn/beta/paths/sod-exceptions.yaml b/idn/beta/paths/sod-exceptions.yaml
index 825267b..584dfff 100644
--- a/idn/beta/paths/sod-exceptions.yaml
+++ b/idn/beta/paths/sod-exceptions.yaml
@@ -3,8 +3,6 @@ post:
tags:
- SOD Exception
summary: Create SOD exception
- # security:
- # - oauth2: [API]
description: >-
This API creates a SOD exception.
@@ -37,8 +35,6 @@ get:
tags:
- SOD Exception
summary: List SOD exceptions
- # security:
- # - oauth2: [API]
description: >-
This API returns a list of all SOD exceptions.
@@ -53,15 +49,19 @@ get:
schema:
type: string
description: >-
- Filter results using the standard syntax described in [V3 API Standard
- Collection
- Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
Filtering is supported for the following fields and operators:
- **id**: *eq, in* **sodPolicy.id**: *eq, in* **identity.id**: *eq, in*
+ **id**: *eq, in*
+
+
+ **sodPolicy.id**: *eq, in*
+
+
+ **identity.id**: *eq, in*
example: identity.id eq "bc693f07e7b645539626c25954c58554"
required: false
- in: query
@@ -70,15 +70,10 @@ get:
type: string
format: comma-separated
description: >-
- Sort results using the standard syntax described in [V3 API Standard
- Collection
- Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+ Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
- Sorting is supported for the following fields:
-
-
- **sodPolicy.id, identity.id, start, end**
+ Sorting is supported for the following fields: **sodPolicy.id, identity.id, start, end**
example: identity.id,-start
required: false
responses:
diff --git a/idn/beta/paths/sod-policies.yaml b/idn/beta/paths/sod-policies.yaml
index f4bb8f2..43f360a 100644
--- a/idn/beta/paths/sod-policies.yaml
+++ b/idn/beta/paths/sod-policies.yaml
@@ -3,8 +3,6 @@ post:
tags:
- SOD Policy
summary: Create SOD policy
- # security:
- # - oauth2: [ORG_ADMIN]
description: >-
This creates both General and Conflicting Access Based policy, with a limit
of 50 entitlements for each (left & right) criteria for Conflicting Access
@@ -234,8 +232,6 @@ get:
tags:
- SOD Policy
summary: List SOD policies
- # security:
- # - oauth2: [ORG_ADMIN]
description: >-
This gets list of all SOD policies.
@@ -249,15 +245,19 @@ get:
schema:
type: string
description: >-
- Filter results using the standard syntax described in [V3 API Standard
- Collection
- Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
Filtering is supported for the following fields and operators:
- **id**: *eq* **name**: *eq* **state**: *eq*
+ **id**: *eq*
+
+
+ **name**: *eq*
+
+
+ **state**: *eq*
example: id eq "bc693f07e7b645539626c25954c58554"
required: false
responses:
diff --git a/idn/beta/paths/sources.yaml b/idn/beta/paths/sources.yaml
index 04eb952..f0d4a97 100644
--- a/idn/beta/paths/sources.yaml
+++ b/idn/beta/paths/sources.yaml
@@ -8,6 +8,7 @@ get:
description: >-
This end-point lists all the sources in IdentityNow.
+
A token with ORG_ADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN, or ROLE_SUBADMIN authority is required to call this API.
parameters:
- $ref: '../../v3/parameters/limit.yaml'
@@ -17,25 +18,54 @@ get:
name: filters
schema:
type: string
- example: name eq "#Employees"
+ example: name eq "Employees"
description: >-
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
-
+
+
Filtering is supported for the following fields and operators:
- **id**: *eq, in*
- **name**: *co, eq, in, sw*
- **type**: *eq, in*
- **owner.id**: *eq, in*
- **features**: *ca, co*
- **created**: *eq*
- **modified**: *eq*
- **managementWorkgroup.id**: *eq*
- **description**: *eq*
- **authoritative**: *eq*
- **healthy**: *eq*
- **status**: *eq, in*
- **connectionType**: *eq*
- **connectorName**: *eq*
+
+
+ **id**: *eq, in*
+
+
+ **name**: *co, eq, in, sw*
+
+
+ **type**: *eq, in*
+
+
+ **owner.id**: *eq, in*
+
+
+ **features**: *ca, co*
+
+
+ **created**: *eq*
+
+
+ **modified**: *eq*
+
+
+ **managementWorkgroup.id**: *eq*
+
+
+ **description**: *eq*
+
+
+ **authoritative**: *eq*
+
+
+ **healthy**: *eq*
+
+
+ **status**: *eq, in*
+
+
+ **connectionType**: *eq*
+
+
+ **connectorName**: *eq*
- in: query
name: sorters
schema:
@@ -45,6 +75,7 @@ get:
description: >-
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
Sorting is supported for the following fields: **type, created, modified, name, owner.name, healthy, status**
- in: query
name: for-subadmin
diff --git a/idn/beta/paths/supportlogin/access-granter-support-login-list.yaml b/idn/beta/paths/supportlogin/access-granter-support-login-list.yaml
index e755596..7970af5 100644
--- a/idn/beta/paths/supportlogin/access-granter-support-login-list.yaml
+++ b/idn/beta/paths/supportlogin/access-granter-support-login-list.yaml
@@ -18,23 +18,24 @@ get:
type: string
format: comma-separated
description: >-
- Sort results using the standard syntax described in [V3 API Standard
- Collection
- Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
- Sorting is supported for the following fields: **accessGranterTenant,
- authUserName, role, expirationDate**
+ Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
+
+ Sorting is supported for the following fields: **accessGranterTenant, authUserName, role, expirationDate**
+ example: accessGranterTenant
- in: query
name: filters
schema:
type: string
description: >-
- Filter results using the standard syntax described in [V3 API Standard
- Collection
- Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
- Filtering is supported for the following fields and operators:
- **accessGranterTenant**: *eq, co, sw* *Example:* accessGranterTenant eq
- "acme-solar", accessGranterTenant co "solar"
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
+ Filtering is supported for the following fields and operators:
+
+
+ **accessGranterTenant**: *eq, co, sw*
+ example: accessGranterTenant co "solar"
responses:
"200":
description: list of access granter support login responses.
diff --git a/idn/beta/paths/supportlogin/auth-support-login-list.yaml b/idn/beta/paths/supportlogin/auth-support-login-list.yaml
index e0e00d4..1929a0c 100644
--- a/idn/beta/paths/supportlogin/auth-support-login-list.yaml
+++ b/idn/beta/paths/supportlogin/auth-support-login-list.yaml
@@ -16,22 +16,24 @@ parameters:
type: string
format: comma-separated
description: >-
- Sort results using the standard syntax described in [V3 API Standard
- Collection
- Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
- Sorting is supported for the following fields: **authTenant, authUserName,
- role, expirationDate**
+ Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
+
+ Sorting is supported for the following fields: **authTenant, authUserName, role, expirationDate**
+ example: authTenant
- in: query
name: filters
schema:
type: string
description: >-
- Filter results using the standard syntax described in [V3 API Standard
- Collection
- Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
+
Filtering is supported for the following fields and operators:
- **authTenant**: *eq, sw* *Example:* authTenant eq "sailpoint",
- accessGranterTenant sw "sail"
+
+
+ **authTenant**: *eq, sw*
+ example: authTenant eq "sailpoint"
responses:
"200":
description: list of auth support login responses.
diff --git a/idn/beta/paths/supportlogin/auth-support-login-transfers-list.yaml b/idn/beta/paths/supportlogin/auth-support-login-transfers-list.yaml
index 7a99f62..7be595f 100644
--- a/idn/beta/paths/supportlogin/auth-support-login-transfers-list.yaml
+++ b/idn/beta/paths/supportlogin/auth-support-login-transfers-list.yaml
@@ -17,20 +17,24 @@ get:
type: string
format: comma-separated
description: >-
- Sort results using the standard syntax described in [V3 API Standard
- Collection
- Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+ Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
+
Sorting is supported for the following fields: **tenant**
+ example: tenant
- in: query
name: filters
schema:
type: string
description: >-
- Filter results using the standard syntax described in [V3 API Standard
- Collection
- Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
+
Filtering is supported for the following fields and operators:
- **transferred**: *eq* *Example:* transferred eq false, transferred eq 0
+
+
+ **transferred**: *eq*
+ example: transferred eq false
responses:
"200":
description: list of auth support transfer status responses.
diff --git a/idn/beta/paths/supportlogin/auth-support-tenant-list.yaml b/idn/beta/paths/supportlogin/auth-support-tenant-list.yaml
index 9477d6c..24a664f 100644
--- a/idn/beta/paths/supportlogin/auth-support-tenant-list.yaml
+++ b/idn/beta/paths/supportlogin/auth-support-tenant-list.yaml
@@ -16,21 +16,24 @@ parameters:
type: string
format: comma-separated
description: >-
- Sort results using the standard syntax described in [V3 API Standard
- Collection
- Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+ Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
+
Sorting is supported for the following fields: **authTenant**
+ example: authTenant
- in: query
name: filters
schema:
type: string
description: >-
- Filter results using the standard syntax described in [V3 API Standard
- Collection
- Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
+
Filtering is supported for the following fields and operators:
- **authTenant**: *eq, sw* *Example:* authTenant eq "sailpoint", authTenant
- sw "sail"
+
+
+ **authTenant**: *eq, sw*
+ example: authTenant eq "sailpoint"
responses:
"200":
description: list of auth support tenant responses.
diff --git a/idn/beta/paths/task-definitions.yaml b/idn/beta/paths/task-definitions.yaml
index 09f2aed..3ea1a83 100644
--- a/idn/beta/paths/task-definitions.yaml
+++ b/idn/beta/paths/task-definitions.yaml
@@ -11,22 +11,6 @@ get:
- $ref: '../../v3/parameters/offset.yaml'
- $ref: '../../v3/parameters/limit.yaml'
- $ref: '../../v3/parameters/count.yaml'
- - name: sorters
- in: query
- description: sort criteria
- required: false
- style: form
- explode: true
- schema:
- type: string
- - name: filters
- in: query
- description: filter criteria
- required: false
- style: form
- explode: true
- schema:
- type: string
responses:
"200":
description: Response is a list of TaskDefinitionSumary results matching the criteria.
diff --git a/idn/beta/paths/task-status-list.yaml b/idn/beta/paths/task-status-list.yaml
index 7edbe7b..33f31c4 100644
--- a/idn/beta/paths/task-status-list.yaml
+++ b/idn/beta/paths/task-status-list.yaml
@@ -1,6 +1,3 @@
-#
-# Copyright (C) 2023 SailPoint Technologies, Inc. All rights reserved.
-#
get:
tags:
- Task Management
@@ -20,11 +17,20 @@ get:
description: >-
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
Filtering is supported for the following fields and operators:
- **id**: *eq, in*
- **sourceId**: *eq, in*
- **completionStatus**: *eq, in*
- **type**: *eq, in* "CLOUD_ACCOUNT_AGGREGATION", "CLOUD_GROUP_AGGREGATION", "CLOUD_PROCESS_UNCORRELATED_ACCOUNTS" or "CLOUD_REFRESH_ROLE"
+
+
+ **id**: *eq, in*
+
+
+ **sourceId**: *eq, in*
+
+
+ **completionStatus**: *eq, in*
+
+
+ **type**: *eq, in*
- in: query
name: sorters
schema:
@@ -35,6 +41,7 @@ get:
description: >-
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
Sorting is supported for the following fields: **created**
responses:
"200":
diff --git a/idn/beta/paths/task-status-pending.yaml b/idn/beta/paths/task-status-pending.yaml
index 3b4c627..ad8b6f5 100644
--- a/idn/beta/paths/task-status-pending.yaml
+++ b/idn/beta/paths/task-status-pending.yaml
@@ -1,6 +1,3 @@
-#
-# Copyright (C) 2019-2020 SailPoint Technologies, Inc. All rights reserved.
-#
get:
tags:
- Task Management
@@ -11,22 +8,6 @@ get:
- $ref: '../../v3/parameters/offset.yaml'
- $ref: '../../v3/parameters/limit.yaml'
- $ref: '../../v3/parameters/count.yaml'
- - name: sorters
- in: query
- description: sort criteria
- required: false
- style: form
- explode: true
- schema:
- type: string
- - name: filters
- in: query
- description: filter criteria
- required: false
- style: form
- explode: true
- schema:
- type: string
responses:
"200":
description: Responds with a list of TaskStatus for pending tasks.
@@ -54,22 +35,6 @@ head:
- $ref: '../../v3/parameters/offset.yaml'
- $ref: '../../v3/parameters/limit.yaml'
- $ref: '../../v3/parameters/count.yaml'
- - name: sorters
- in: query
- description: sort criteria
- required: false
- style: form
- explode: true
- schema:
- type: string
- - name: filters
- in: query
- description: filter criteria
- required: false
- style: form
- explode: true
- schema:
- type: string
responses:
"200":
description: Responds with headers for List of TaskStatus for pending tasks.
diff --git a/idn/beta/paths/transforms.yaml b/idn/beta/paths/transforms.yaml
index 29f0ca0..56867a1 100644
--- a/idn/beta/paths/transforms.yaml
+++ b/idn/beta/paths/transforms.yaml
@@ -26,11 +26,14 @@ get:
description: >-
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
Filtering is supported for the following fields and operators:
+
**internal**: *eq*
- **name**: *eq*, *sw*
+
+ **name**: *eq, sw*
required: false
style: form
explode: true
diff --git a/idn/beta/paths/trigger-invocations-pending-events.yaml b/idn/beta/paths/trigger-invocations-pending-events.yaml
index 5f9f6c2..f2a1e84 100644
--- a/idn/beta/paths/trigger-invocations-pending-events.yaml
+++ b/idn/beta/paths/trigger-invocations-pending-events.yaml
@@ -21,7 +21,7 @@ get:
**topic**: *eq*
- example: 'topic eq "Channel"'
+ example: topic eq "Channel"
- in: query
name: sorters
required: false
@@ -32,11 +32,8 @@ get:
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
- Sorting is supported for the following fields:
-
-
- **topic**
- example: 'topic'
+ Sorting is supported for the following fields: **topic**
+ example: topic
responses:
'200':
description: >-
diff --git a/idn/beta/paths/trigger-invocations-status.yaml b/idn/beta/paths/trigger-invocations-status.yaml
index a793bf9..bb9db87 100644
--- a/idn/beta/paths/trigger-invocations-status.yaml
+++ b/idn/beta/paths/trigger-invocations-status.yaml
@@ -26,6 +26,8 @@ get:
**triggerId**: *eq*
+
+
**subscriptionId**: *eq*
example: 'triggerId eq "idn:access-request-dynamic-approver"'
- in: query
@@ -38,13 +40,7 @@ get:
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
- Sorting is supported for the following fields:
-
-
- **triggerId**
- **subscriptionName**
- **created**
- **completed**
+ Sorting is supported for the following fields: **triggerId, subscriptionName, created, completed**
example: 'created'
responses:
'200':
diff --git a/idn/beta/paths/trigger-invocations.yaml b/idn/beta/paths/trigger-invocations.yaml
index f41b78f..793cbfe 100644
--- a/idn/beta/paths/trigger-invocations.yaml
+++ b/idn/beta/paths/trigger-invocations.yaml
@@ -24,7 +24,7 @@ get:
**triggerId**: *eq*
- example: 'triggerId eq "idn:access-request-dynamic-approver"'
+ example: triggerId eq "idn:access-request-dynamic-approver"
- in: query
name: sorters
required: false
@@ -35,11 +35,8 @@ get:
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
- Sorting is supported for the following fields:
-
-
- **triggerId**
- example: 'triggerId'
+ Sorting is supported for the following fields: **triggerId**
+ example: triggerId
responses:
'200':
description: >-
diff --git a/idn/beta/paths/trigger-subscriptions.yaml b/idn/beta/paths/trigger-subscriptions.yaml
index 36cb015..c168ce1 100644
--- a/idn/beta/paths/trigger-subscriptions.yaml
+++ b/idn/beta/paths/trigger-subscriptions.yaml
@@ -119,11 +119,7 @@ get:
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
- Sorting is supported for the following fields:
-
-
- **triggerId**
- **triggerName**
+ Sorting is supported for the following fields: **triggerId, triggerName**
example: triggerName
responses:
'200':
diff --git a/idn/beta/paths/triggers.yaml b/idn/beta/paths/triggers.yaml
index 21b71cb..d9c01aa 100644
--- a/idn/beta/paths/triggers.yaml
+++ b/idn/beta/paths/triggers.yaml
@@ -32,11 +32,7 @@ get:
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
- Sorting is supported for the following fields:
-
-
- **id**
- **name**
+ Sorting is supported for the following fields: **id, name**
example: name
responses:
'200':
diff --git a/idn/beta/paths/verified-from-addresses.yaml b/idn/beta/paths/verified-from-addresses.yaml
index 55002b2..0d130d0 100644
--- a/idn/beta/paths/verified-from-addresses.yaml
+++ b/idn/beta/paths/verified-from-addresses.yaml
@@ -21,6 +21,7 @@ get:
**email**: *eq*
+ example: email eq "john.doe@company.com"
- in: query
name: sorters
schema:
@@ -30,10 +31,8 @@ get:
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
- Sorting is supported for the following fields:
-
-
- **email**
+ Sorting is supported for the following fields: **email**
+ example: email
responses:
'200':
description: List of Email Status
diff --git a/idn/beta/paths/workflow-executions.yaml b/idn/beta/paths/workflow-executions.yaml
index d74a438..62862a8 100644
--- a/idn/beta/paths/workflow-executions.yaml
+++ b/idn/beta/paths/workflow-executions.yaml
@@ -41,20 +41,17 @@ get:
type: string
example: status eq "Failed"
description: >-
- Filter results using the standard syntax described in [V3 API Standard
- Collection
- Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
Filtering is supported for the following fields and operators:
- **start_time**: *eq, lt, lte, gt, gte*
+ **startTime**: *eq, lt, le, gt, ge*
**status**: *eq*
required: false
-
responses:
'200':
description: >-
diff --git a/idn/beta/paths/workgroups/connections.yaml b/idn/beta/paths/workgroups/connections.yaml
index 14e1cd5..f7c4448 100644
--- a/idn/beta/paths/workgroups/connections.yaml
+++ b/idn/beta/paths/workgroups/connections.yaml
@@ -22,8 +22,9 @@ get:
format: comma-separated
description: >-
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
- Sorting is supported for the following fields: **name, created, modified**
+
+ Sorting is supported for the following fields: **name, created, modified**
example: name,-modified
required: false
responses:
diff --git a/idn/beta/paths/workgroups/workgroup-members.yaml b/idn/beta/paths/workgroups/workgroup-members.yaml
index 99e18cf..1d1918e 100644
--- a/idn/beta/paths/workgroups/workgroup-members.yaml
+++ b/idn/beta/paths/workgroups/workgroup-members.yaml
@@ -22,8 +22,9 @@ get:
format: comma-separated
description: >-
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
+
Sorting is supported for the following fields: **name, created, modified**
-
example: name,-modified
required: false
responses:
diff --git a/idn/beta/paths/workgroups/workgroups.yaml b/idn/beta/paths/workgroups/workgroups.yaml
index b296472..5a453a8 100644
--- a/idn/beta/paths/workgroups/workgroups.yaml
+++ b/idn/beta/paths/workgroups/workgroups.yaml
@@ -16,7 +16,8 @@ get:
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
- Filtering is supported for the following Governance Group fields and operators:
+ Filtering is supported for the following fields and operators:
+
**id**: *eq, in*
@@ -31,8 +32,9 @@ get:
format: comma-separated
description: >-
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
+
Sorting is supported for the following fields: **name, created, modified**
-
example: name,-modified
required: false
responses:
diff --git a/idn/sailpoint-api.beta.yaml b/idn/sailpoint-api.beta.yaml
index 951c8cb..ddffd70 100644
--- a/idn/sailpoint-api.beta.yaml
+++ b/idn/sailpoint-api.beta.yaml
@@ -143,6 +143,11 @@ tags:
In Account Aggregation, administrators can view the account aggregations' statuses and details in the Account Activity Log.
Refer to [Loading Account Data](https://documentation.sailpoint.com/saas/help/accounts/loading_data.html) for more information about account aggregations.
+ - name: Account Usages
+ description: |
+ Use this API to implement account usage insight functionality.
+ With this functionality in place, administrators can gather information and insights about how their tenants' source accounts are being used.
+ This allows organizations to get the information they need to start optimizing and securing source account usage.
- name: Accounts
description: |
Use this API to implement and customize account functionality.
@@ -756,6 +761,11 @@ tags:
This second option is a good way to prevent SOD violations from triggering at all.
Refer to [Handling Policy Violations](https://documentation.sailpoint.com/saas/help/sod/policy-violations.html) for more information about SOD policy violations.
+ - name: Source Usages
+ description: |
+ Use this API to implement source usage insight functionality.
+ With this functionality in place, administrators can gather information and insights about how their tenants' sources are being used.
+ This allows organizations to get the information they need to start optimizing and securing source usage.
- name: Sources
description: |
Use this API to implement and customize source functionality.
@@ -882,20 +892,21 @@ tags:
When they complete the work item, they can select 'Mark Complete' to add it to their list of completed work items.
Refer to [Task Manager](https://documentation.sailpoint.com/saas/user-help/task_manager.html) for more information about work items, including the different types of work items users may need to complete.
+ - name: Work Reassignment
+ description: |
+ Use this API to implement work reassignment functionality.
+
+ Work Reassignment allows access request reviews, certifications, and manual provisioning tasks assigned to a user to be reassigned to a different user. This is primarily used for:
+
+ - Temporarily redirecting work for users who are out of office, such as on vacation or sick leave
+ - Permanently redirecting work for users who should not be assigned these tasks at all, such as senior executives or service identities
+
+ Users can define reassignments for themselves, managers can add them for their team members, and administrators can configure them on any user’s behalf. Work assigned during the specified reassignment timeframes will be automatically reassigned to the designated user as it is created.
+
+ Refer to [Work Reassignment](https://documentation.sailpoint.com/saas/help/users/work_reassignment.html) for more information about this topic.
- name: Workflows
description: |
Workflows allow administrators to create custom automation scripts directly within IdentityNow. These automation scripts respond to [event triggers](https://developer.sailpoint.com/idn/docs/event-triggers#how-to-get-started-with-event-triggers) and perform a series of actions to perform tasks that are either too cumbersome or not available in the IdentityNow UI. Workflows can be configured via a graphical user interface within IdentityNow, or by creating and uploading a JSON formatted script to the Workflow service. The Workflows API collection provides the necessary functionality to create, manage, and test your workflows via REST.
- - name: Source Usages
- description: |
- Use this API to implement source usage insight functionality.
- With this functionality in place, administrators can gather information and insights about how their tenants' sources are being used.
- This allows organizations to get the information they need to start optimizing and securing source usage.
- - name: Account Usages
- description: |
- Use this API to implement account usage insight functionality.
- With this functionality in place, administrators can gather information and insights about how their tenants' source accounts are being used.
- This allows organizations to get the information they need to start optimizing and securing source account usage.
-
security:
- UserContextAuth: [ ]
diff --git a/idn/v3/paths/.gitignore b/idn/v3/paths/.gitignore
deleted file mode 100644
index 787c488..0000000
--- a/idn/v3/paths/.gitignore
+++ /dev/null
@@ -1,24 +0,0 @@
-build
-.idea
-*.iml
-.gradle
-.DS_Store
-/debug.log
-velocity.log*
-sptcbu-org-data
-*~
-#*#
-.#*
-api-client-common/out
-
-node_modules
-*.d.ts
-
-/bin
-.classpath
-.project
-.vscode/
-.settings/
-/.settings
-api-client-common/bin/
-design-docs/api-publisher
\ No newline at end of file
diff --git a/idn/v3/paths/access-profile-entitlements.yaml b/idn/v3/paths/access-profile-entitlements.yaml
index 82a9e73..51665ac 100644
--- a/idn/v3/paths/access-profile-entitlements.yaml
+++ b/idn/v3/paths/access-profile-entitlements.yaml
@@ -29,7 +29,8 @@ get:
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
- Filtering is supported for the following Entitlement fields and operators:
+ Filtering is supported for the following fields and operators:
+
**id**: *eq, in*
@@ -43,7 +44,10 @@ get:
**value**: *eq, sw*
- **created, modified**: *gt, lt, ge, le*
+ **created**: *gt, lt, ge, le*
+
+
+ **modified**: *gt, lt, ge, le*
**owner.id**: *eq, in*
diff --git a/idn/v3/paths/access-profiles.yaml b/idn/v3/paths/access-profiles.yaml
index dece899..3de3fd6 100644
--- a/idn/v3/paths/access-profiles.yaml
+++ b/idn/v3/paths/access-profiles.yaml
@@ -44,7 +44,10 @@ get:
**name**: *eq, sw*
- **created, modified**: *gt, lt, ge, le*
+ **created**: *gt, lt, ge, le*
+
+
+ **modified**: *gt, lt, ge, le*
**owner.id**: *eq, in*
diff --git a/idn/v3/paths/access-request-status.yaml b/idn/v3/paths/access-request-status.yaml
index a604d36..b631ff5 100644
--- a/idn/v3/paths/access-request-status.yaml
+++ b/idn/v3/paths/access-request-status.yaml
@@ -107,13 +107,10 @@ get:
type: string
format: comma-separated
description: >-
- Sort results using the standard syntax described in [V3 API Standard
- Collection
- Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+ Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
- Sorting is supported for the following fields: **created, modified,
- accountActivityItemId**
+ Sorting is supported for the following fields: **created, modified, accountActivityItemId**
example: created
required: false
responses:
diff --git a/idn/v3/paths/account-activities.yaml b/idn/v3/paths/account-activities.yaml
index fab383d..16f0952 100644
--- a/idn/v3/paths/account-activities.yaml
+++ b/idn/v3/paths/account-activities.yaml
@@ -43,15 +43,13 @@ get:
schema:
type: string
description: >-
- Filter results using the standard syntax described in [V3 API Standard
- Collection
- Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results).
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
Filtering is supported for the following fields and operators:
- **type**: *eq, in* (See the `type` property in the response schema for possible values)
+ **type**: *eq, in*
**created**: *gt, lt, ge, le*
diff --git a/idn/v3/paths/account-activity-list.yaml b/idn/v3/paths/account-activity-list.yaml
index 2643b92..dcb3eec 100644
--- a/idn/v3/paths/account-activity-list.yaml
+++ b/idn/v3/paths/account-activity-list.yaml
@@ -43,15 +43,13 @@ get:
schema:
type: string
description: >-
- Filter results using the standard syntax described in [V3 API Standard
- Collection
- Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results).
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
Filtering is supported for the following fields and operators:
- **type**: *eq, in* (See the `type` property in the response schema for possible values)
+ **type**: *eq, in*
**created**: *gt, lt, ge, le*
@@ -66,12 +64,10 @@ get:
type: string
format: comma-separated
description: >-
- Sort results using the standard syntax described in [V3 API Standard
- Collection
- Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+ Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
- Sorting is supported for the following fields: **type, created,
- modified**
+
+ Sorting is supported for the following fields: **type, created, modified**
example: created
required: false
responses:
diff --git a/idn/v3/paths/accounts.yaml b/idn/v3/paths/accounts.yaml
index e426941..38c32f6 100644
--- a/idn/v3/paths/accounts.yaml
+++ b/idn/v3/paths/accounts.yaml
@@ -55,7 +55,7 @@ get:
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
- Sorting is supported for the following fields: **id**, **name**, **created**, **modified**
+ Sorting is supported for the following fields: **id, name, created, modified**
responses:
"200":
description: List of account objects
diff --git a/idn/v3/paths/campaign-templates.yaml b/idn/v3/paths/campaign-templates.yaml
index 31ce90d..3f26170 100644
--- a/idn/v3/paths/campaign-templates.yaml
+++ b/idn/v3/paths/campaign-templates.yaml
@@ -85,7 +85,13 @@ get:
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
- Filtering is supported for the following fields: **name, id**
+ Filtering is supported for the following fields and operators:
+
+
+ **name**: *eq*
+
+
+ **id**: *eq*
example: name eq "manager template"
responses:
'200':
diff --git a/idn/v3/paths/campaigns.yaml b/idn/v3/paths/campaigns.yaml
index 799d768..974c365 100644
--- a/idn/v3/paths/campaigns.yaml
+++ b/idn/v3/paths/campaigns.yaml
@@ -52,7 +52,7 @@ get:
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
- Sorting is supported for the following fields: **name**, **created**
+ Sorting is supported for the following fields: **name, created**
example: name
responses:
'200':
diff --git a/idn/v3/paths/certifications-reviewers.yaml b/idn/v3/paths/certifications-reviewers.yaml
index 3a24f8d..535445c 100644
--- a/idn/v3/paths/certifications-reviewers.yaml
+++ b/idn/v3/paths/certifications-reviewers.yaml
@@ -27,7 +27,7 @@ get:
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
- Filtering is supported for the following fields and operators (Filtering is done by reviewer's fields):
+ Filtering is supported for the following fields and operators:
**id**: *eq, in*
@@ -38,7 +38,6 @@ get:
**email**: *eq, sw*
example: name eq "Bob"
-
- in: query
name: sorters
schema:
diff --git a/idn/v3/paths/identity-certifications-access-review-items.yaml b/idn/v3/paths/identity-certifications-access-review-items.yaml
index 731d5d4..dd6c54d 100644
--- a/idn/v3/paths/identity-certifications-access-review-items.yaml
+++ b/idn/v3/paths/identity-certifications-access-review-items.yaml
@@ -33,7 +33,10 @@ get:
**id**: *eq, in*
- **type / access.type**: *eq*
+ **type**: *eq*
+
+
+ **access.type**: *eq*
**completed**: *eq, ne*
diff --git a/idn/v3/paths/identity-certifications-item-permissions.yaml b/idn/v3/paths/identity-certifications-item-permissions.yaml
index 1dc22c1..42c2049 100644
--- a/idn/v3/paths/identity-certifications-item-permissions.yaml
+++ b/idn/v3/paths/identity-certifications-item-permissions.yaml
@@ -18,7 +18,7 @@ get:
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
- Supported fields and primitive operators:
+ Filtering is supported for the following fields and operators:
**target**: *eq, sw*
@@ -27,29 +27,19 @@ get:
**rights**: *ca*
- Supported composite operators:
-
-
- *and, or*
+ Supported composite operators: *and, or*
All field values (second filter operands) are case-insensitive for this API.
- Only a single *and* or *or* composite filter operator may be used. It must also be used between
- a target filter and a rights filter, not between 2 filters for the same field.
-
- For example,
+ Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field.
- The following is valid:
-
- *?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22*
+ For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22`
- The following is invalid:
-
- *?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)*
+ The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1
example: target eq "SYS.OBJAUTH2"
- in: path
name: certificationId
diff --git a/idn/v3/paths/identity-certifications.yaml b/idn/v3/paths/identity-certifications.yaml
index 384be36..3883aef 100644
--- a/idn/v3/paths/identity-certifications.yaml
+++ b/idn/v3/paths/identity-certifications.yaml
@@ -28,14 +28,19 @@ get:
description: >-
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
Filtering is supported for the following fields and operators:
+
**id**: *eq, in*
+
**campaign.id**: *eq, in*
+
**phase**: *eq*
+
**completed**: *eq, ne*
- in: query
name: sorters
@@ -47,6 +52,7 @@ get:
description: >-
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
Sorting is supported for the following fields: **name, due, signed**
responses:
'200':
diff --git a/idn/v3/paths/identity-profiles-export.yaml b/idn/v3/paths/identity-profiles-export.yaml
index 02a3e2e..908f2ae 100644
--- a/idn/v3/paths/identity-profiles-export.yaml
+++ b/idn/v3/paths/identity-profiles-export.yaml
@@ -40,7 +40,7 @@ get:
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
- Sorting is supported for the following fields: **id**, **name**, **priority**
+ Sorting is supported for the following fields: **id, name, priority**
responses:
'200':
description: List of export objects with identity profiles.
diff --git a/idn/v3/paths/identity-profiles.yaml b/idn/v3/paths/identity-profiles.yaml
index 1481685..0735dad 100644
--- a/idn/v3/paths/identity-profiles.yaml
+++ b/idn/v3/paths/identity-profiles.yaml
@@ -42,7 +42,7 @@ get:
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
- Sorting is supported for the following fields: **id**, **name**, **priority**
+ Sorting is supported for the following fields: **id, name, priority**
responses:
'200':
description: List of identityProfiles.
diff --git a/idn/v3/paths/non-employee-approval-list.yaml b/idn/v3/paths/non-employee-approval-list.yaml
index 153c8a2..5ed224e 100644
--- a/idn/v3/paths/non-employee-approval-list.yaml
+++ b/idn/v3/paths/non-employee-approval-list.yaml
@@ -30,11 +30,13 @@ get:
schema:
type: string
description: >-
- Filter results using the standard syntax described in [V3 API Standard
- Collection
- Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407)
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
+
Filtering is supported for the following fields and operators:
- **approvalStatus**: *eq* *Example:* approvalStatus eq "PENDING"
+
+
+ **approvalStatus**: *eq*
example: approvalStatus eq "Pending"
required: false
- in: query
@@ -43,9 +45,9 @@ get:
type: string
format: comma-separated
description: >-
- Sort results using the standard syntax described in [V3 API Standard
- Collection
- Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407#toc-hId-2058949)
+ Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
+
Sorting is supported for the following fields: **created, modified**
required: false
example: created
diff --git a/idn/v3/paths/non-employee-records.yaml b/idn/v3/paths/non-employee-records.yaml
index 3cd0640..53581a9 100644
--- a/idn/v3/paths/non-employee-records.yaml
+++ b/idn/v3/paths/non-employee-records.yaml
@@ -57,12 +57,10 @@ get:
format: comma-separated
example: accountName,sourceId
description: >-
- Sort results using the standard syntax described in [V3 API Standard
- Collection
- Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407#toc-hId-2058949)
- Sorting is supported for the following fields: **id, accountName,
- sourceId, manager, firstName, lastName, email, phone, startDate,
- endDate, created, modified**
+ Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
+
+ Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified**
- in: query
name: filters
required: false
@@ -70,12 +68,13 @@ get:
type: string
example: sourceId eq "2c91808568c529c60168cca6f90c1313"
description: >-
- Filter results using the standard syntax described in [V3 API Standard
- Collection
- Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407)
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
+
Filtering is supported for the following fields and operators:
- **sourceId**: *eq* *Example:* sourceId eq
- "2c91808568c529c60168cca6f90c1313"
+
+
+ **sourceId**: *eq*
responses:
"200":
description: Non-Employee record objects
diff --git a/idn/v3/paths/non-employee-requests.yaml b/idn/v3/paths/non-employee-requests.yaml
index a5236d6..891a3e6 100644
--- a/idn/v3/paths/non-employee-requests.yaml
+++ b/idn/v3/paths/non-employee-requests.yaml
@@ -94,12 +94,10 @@ get:
format: comma-separated
example: created,approvalStatus
description: >-
- Sort results using the standard syntax described in [V3 API Standard
- Collection
- Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407#toc-hId-2058949)
- Sorting is supported for the following fields: **created,
- approvalStatus, firstName, lastName, email, phone, accountName,
- startDate, endDate**
+ Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
+
+ Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate**
- in: query
name: filters
required: false
@@ -107,12 +105,13 @@ get:
type: string
example: sourceId eq "2c91808568c529c60168cca6f90c1313"
description: >-
- Filter results using the standard syntax described in [V3 API Standard
- Collection
- Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407)
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
+
Filtering is supported for the following fields and operators:
- **sourceId**: *eq* *Example:* sourceId eq
- "2c91808568c529c60168cca6f90c1313"
+
+
+ **sourceId**: *eq*
responses:
"200":
description: List of non-employee request objects.
diff --git a/idn/v3/paths/non-employee-sources.yaml b/idn/v3/paths/non-employee-sources.yaml
index 53721bc..4537fc0 100644
--- a/idn/v3/paths/non-employee-sources.yaml
+++ b/idn/v3/paths/non-employee-sources.yaml
@@ -77,9 +77,9 @@ get:
format: comma-separated
example: "name,created"
description: >-
- Sort results using the standard syntax described in [V3 API Standard
- Collection
- Parameters](https://community.sailpoint.com/t5/IdentityNow-Wiki/V3-API-Standard-Collection-Parameters/ta-p/156407#toc-hId-2058949)
+ Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
+
+
Sorting is supported for the following fields: **name, created**
responses:
"200":
diff --git a/idn/v3/paths/role-assigned-identities.yaml b/idn/v3/paths/role-assigned-identities.yaml
index bc08c47..a15c253 100644
--- a/idn/v3/paths/role-assigned-identities.yaml
+++ b/idn/v3/paths/role-assigned-identities.yaml
@@ -46,7 +46,7 @@ get:
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
- Sorting is supported for the following fields: **id**, **name**, **aliasName**, **email**
+ Sorting is supported for the following fields: **id, name, aliasName, email**
example: aliasName,name
responses:
'200':
diff --git a/idn/v3/paths/roles.yaml b/idn/v3/paths/roles.yaml
index 80323d2..6224950 100644
--- a/idn/v3/paths/roles.yaml
+++ b/idn/v3/paths/roles.yaml
@@ -42,16 +42,16 @@ get:
**name**: *eq, sw*
- **created, modified**: *gt, lt, ge, le*
+ **created**: *gt, lt, ge, le*
+
+
+ **modified**: *gt, lt, ge, le*
**owner.id**: *eq, in*
**requestable**: *eq*
-
-
- Composite operators supported: *and, or*
example: requestable eq false
required: false
- in: query
@@ -61,8 +61,9 @@ get:
format: comma-separated
description: >-
Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)
- Sorting is supported for the following fields: **name, created, modified**
+
+ Sorting is supported for the following fields: **name, created, modified**
example: name,-modified
required: false
- in: query
diff --git a/idn/v3/paths/saved-searches.yaml b/idn/v3/paths/saved-searches.yaml
index 005369a..6c10470 100644
--- a/idn/v3/paths/saved-searches.yaml
+++ b/idn/v3/paths/saved-searches.yaml
@@ -40,20 +40,17 @@ get:
in: query
schema:
type: string
- description: |
- An expression used to constrain the result set using the filtering syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results).
+ description: >-
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
- Allowed filter properties: *owner.id*, *public*
- Allowed filter operator: *eq*
+ Filtering is supported for the following fields and operators:
- **Example filters**:
- ```owner.id eq "0de46054-fe90-434a-b84e-c6b3359d0c64"``` -- returns saved searches for the specified owner ID
+ **owner.id**: *eq*
- ```public eq true``` -- returns all public saved searches
- ```owner.id eq me or public eq true``` -- returns all of the current user's saved searches as well as all public saved searches belonging to other users in the current org
+ **publiic**: *eq*
example: public eq true
responses:
'200':
diff --git a/idn/v3/paths/scheduled-searches.yaml b/idn/v3/paths/scheduled-searches.yaml
index 9be4203..87f7f16 100644
--- a/idn/v3/paths/scheduled-searches.yaml
+++ b/idn/v3/paths/scheduled-searches.yaml
@@ -161,20 +161,17 @@ get:
in: query
schema:
type: string
- description: |
- An expression used to constrain the result set using the filtering syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results).
+ description: >-
+ Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
- Allowed filter properties: *owner.id*, *savedSearchId*
- Allowed filter operator: *eq*
+ Filtering is supported for the following fields and operators:
- **Example filters**:
- ```owner.id eq "0de46054-fe90-434a-b84e-c6b3359d0c64"``` -- returns scheduled searches for the specified owner ID
+ **owner.id**: *eq*
- ```savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"``` -- returns scheduled searches that reference the specified saved search
- ```owner.id eq me or savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"``` -- returns all of the current user's scheduled searches as well as all scheduled searches that reference the specified saved search
+ **savedSearchId**: *eq*
example: savedSearchId eq "6cc0945d-9eeb-4948-9033-72d066e1153e"
responses:
'200':
diff --git a/idn/v3/paths/sources.yaml b/idn/v3/paths/sources.yaml
index 296b3d8..9ae1f1a 100644
--- a/idn/v3/paths/sources.yaml
+++ b/idn/v3/paths/sources.yaml
@@ -17,25 +17,54 @@ get:
name: filters
schema:
type: string
- example: name eq "#Employees"
+ example: name eq "Employees"
description: >-
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
Filtering is supported for the following fields and operators:
- **id**: *eq, in*
- **name**: *co, eq, in, sw*
- **type**: *eq, in*
- **owner.id**: *eq, in*
- **features**: *ca, co*
- **created**: *eq*
- **modified**: *eq*
- **managementWorkgroup.id**: *eq*
- **description**: *eq*
- **authoritative**: *eq*
- **healthy**: *eq*
- **status**: *eq, in*
- **connectionType**: *eq*
- **connectorName**: *eq*
+
+
+ **id**: *eq, in*
+
+
+ **name**: *co, eq, in, sw*
+
+
+ **type**: *eq, in*
+
+
+ **owner.id**: *eq, in*
+
+
+ **features**: *ca, co*
+
+
+ **created**: *eq*
+
+
+ **modified**: *eq*
+
+
+ **managementWorkgroup.id**: *eq*
+
+
+ **description**: *eq*
+
+
+ **authoritative**: *eq*
+
+
+ **healthy**: *eq*
+
+
+ **status**: *eq, in*
+
+
+ **connectionType**: *eq*
+
+
+ **connectorName**: *eq*
- in: query
name: sorters
schema:
diff --git a/idn/v3/paths/transforms.yaml b/idn/v3/paths/transforms.yaml
index 29f0ca0..56867a1 100644
--- a/idn/v3/paths/transforms.yaml
+++ b/idn/v3/paths/transforms.yaml
@@ -26,11 +26,14 @@ get:
description: >-
Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)
+
Filtering is supported for the following fields and operators:
+
**internal**: *eq*
- **name**: *eq*, *sw*
+
+ **name**: *eq, sw*
required: false
style: form
explode: true