Automated commit by github action: 13182714818

This commit is contained in:
GitHub Action Bot
2025-02-06 15:55:42 +00:00
parent ca0588afaf
commit 46b40e4e28
6 changed files with 5 additions and 423 deletions

View File

@@ -215,7 +215,7 @@ tags:
An authentication profile represents an identity profile's authentication configuration. An authentication profile represents an identity profile's authentication configuration.
When the identity profile is created, its authentication profile is also created. When the identity profile is created, its authentication profile is also created.
An authentication profile includes information like its authentication profile type (`BLOCK`, `MFA`, `NON_PTA`, PTA`) and settings controlling whether or not it blocks access from off network or untrusted geographies. An authentication profile includes information like its authentication profile type (`BLOCK`, `MFA`, `NON_PTA`, PTA`) and settings controlling whether or not it blocks access from off network or untrusted geographies.
- name: Certification Campaigns - name: Certification Campaigns
description: | description: |
Use this API to implement certification campaign functionality. Use this API to implement certification campaign functionality.
@@ -494,11 +494,11 @@ tags:
- name: Managed Clients - name: Managed Clients
description: | description: |
Use this API to implement managed client functionality. Use this API to implement managed client functionality.
With this functionality in place, administrators can modify and delete existing managed clients, create new ones, and view and make changes to their log configurations. With this functionality in place, administrators can modify and delete existing managed clients, create new ones, and view and make changes to their log configurations.
- name: Managed Clusters - name: Managed Clusters
description: | description: |
Use this API to implement managed cluster functionality. Use this API to implement managed cluster functionality.
With this functionality in place, administrators can modify and delete existing managed clients, get their statuses, and create new ones. With this functionality in place, administrators can modify and delete existing managed clients, get their statuses, and create new ones.
- name: MFA Configuration - name: MFA Configuration
description: Configure and test multifactor authentication (MFA) methods description: Configure and test multifactor authentication (MFA) methods
- name: MFA Controller - name: MFA Controller
@@ -550,7 +550,7 @@ tags:
- name: Org Config - name: Org Config
description: | description: |
Use this API to implement organization configuration functionality. Use this API to implement organization configuration functionality.
Administrators can use this functionality to manage organization settings, such as time zones. Administrators can use this functionality to manage organization settings, such as time zones.
- name: Password Configuration - name: Password Configuration
description: | description: |
Use this API to implement organization password configuration functionality. Use this API to implement organization password configuration functionality.
@@ -941,7 +941,7 @@ tags:
description: | description: |
Use this API to implement Suggested Entitlement Description (SED) functionality. Use this API to implement Suggested Entitlement Description (SED) functionality.
SED functionality leverages the power of LLM to generate suggested entitlement descriptions. SED functionality leverages the power of LLM to generate suggested entitlement descriptions.
Refer to [GenAI Entitlement Descriptions](https://documentation.sailpoint.com/saas/help/access/entitlements.html#genai-entitlement-descriptions) to learn more about SED in Identity Security Cloud (ISC). Refer to [GenAI Entitlement Descriptions](https://documentation.sailpoint.com/saas/help/access/entitlements.html#genai-entitlement-descriptions) to learn more about SED in Identity Security Cloud (ISC).
- name: Tagged Objects - name: Tagged Objects
description: | description: |
Use this API to implement object tagging functionality. Use this API to implement object tagging functionality.

View File

@@ -431,10 +431,6 @@ tags:
For example, an administrator can use the pageId forget-username:user-email to set the custom text for the case when users forget their usernames and must enter their emails. For example, an administrator can use the pageId forget-username:user-email to set the custom text for the case when users forget their usernames and must enter their emails.
Refer to [Creating Custom Instruction Text](https://documentation.sailpoint.com/saas/help/pwd/pwd_reset.html#creating-custom-instruction-text) for more information about creating custom password instructions. Refer to [Creating Custom Instruction Text](https://documentation.sailpoint.com/saas/help/pwd/pwd_reset.html#creating-custom-instruction-text) for more information about creating custom password instructions.
- name: Data Segmentation
description: |
This service is responsible for creating segments that will determine how access is delegated to identities
withing the organization.
- name: Dimensions - name: Dimensions
description: description:
Use this API to implement and customize dynamic role functionality. Use this API to implement and customize dynamic role functionality.
@@ -1433,14 +1429,6 @@ paths:
$ref: ./v3/paths/connectors-source-template.yaml $ref: ./v3/paths/connectors-source-template.yaml
/connectors/{scriptName}/correlation-config: /connectors/{scriptName}/correlation-config:
$ref: ./v3/paths/connectors-correlation-config.yaml $ref: ./v3/paths/connectors-correlation-config.yaml
/data-segments/membership/{identityId}:
$ref: "./v2024/paths/data-segment-membership.yaml"
/data-segments/user-enabled/{identityId}:
$ref: "./v2024/paths/data-segment-user-enabled.yaml"
/data-segments/{segmentId}:
$ref: "./v2024/paths/data-segment.yaml"
/data-segments:
$ref: "./v2024/paths/data-segments.yaml"
/identities/{identity-id}/set-lifecycle-state: /identities/{identity-id}/set-lifecycle-state:
$ref: ./v3/paths/identity-set-lifecycle-state.yaml $ref: ./v3/paths/identity-set-lifecycle-state.yaml
/identity-profiles/{identity-profile-id}/lifecycle-states: /identity-profiles/{identity-profile-id}/lifecycle-states:

View File

@@ -1,40 +0,0 @@
get:
operationId: getDataSegmentIdentityMembership
security:
- userAuth: [ idn:data-segments:read ]
- applicationAuth: [ idn:data-segments:read ]
x-sailpoint-userLevels:
- ORG_ADMIN
tags:
- Data Segmentation
summary: Get SegmentMembership by Identity ID
description: >-
This API returns the segment membership specified by the given identity ID.
parameters:
- in: path
name: identityId
schema:
type: string
required: true
description: The identity ID to retrieve the segments they are in.
example: ef38f943-47e9-4562-b5bb-8424a56397d8
responses:
'200':
description: Segment Memberships for specified identity
content:
application/json:
schema:
items:
$ref: '../../internal/schemas/data-segment/SegmentMembership.yaml'
'400':
$ref: '../../v3/responses/400.yaml'
'401':
$ref: '../../v3/responses/401.yaml'
'403':
$ref: '../../v3/responses/403.yaml'
'404':
$ref: '../../v3/responses/404.yaml'
'429':
$ref: '../../v3/responses/429.yaml'
'500':
$ref: '../../v3/responses/500.yaml'

View File

@@ -1,39 +0,0 @@
get:
operationId: getDataSegmentationEnabledForUser
security:
- userAuth: [ idn:data-segments:read ]
- applicationAuth: [ idn:data-segments:read ]
x-sailpoint-userLevels:
- ORG_ADMIN
tags:
- Data Segmentation
summary: Is Segmentation enabled by Identity
description: >-
This API returns whether or not segmentation is enabled for the identity.
parameters:
- in: path
name: identityId
schema:
type: string
required: true
description: The identity ID to retrieve if segmentation is enabled for the identity.
example: ef38f943-47e9-4562-b5bb-8424a56397d8
responses:
'200':
description: Returns if segmentation is enabled for a specified User
content:
application/json:
schema:
type: boolean
'400':
$ref: '../../v3/responses/400.yaml'
'401':
$ref: '../../v3/responses/401.yaml'
'403':
$ref: '../../v3/responses/403.yaml'
'404':
$ref: '../../v3/responses/404.yaml'
'429':
$ref: '../../v3/responses/429.yaml'
'500':
$ref: '../../v3/responses/500.yaml'

View File

@@ -1,210 +0,0 @@
get:
operationId: getDataSegment
security:
- userAuth: [ idn:data-segments:read ]
- applicationAuth: [ idn:data-segments:read ]
x-sailpoint-userLevels:
- ORG_ADMIN
tags:
- Data Segmentation
summary: Get Segment by ID
description: >-
This API returns the segment specified by the given ID.
parameters:
- in: path
name: id
schema:
type: string
required: true
description: The segment ID to retrieve.
example: ef38f943-47e9-4562-b5bb-8424a56397d8
responses:
'200':
description: Segment
content:
application/json:
schema:
$ref: '../../internal/schemas/data-segment/Data-Segment.yaml'
'400':
$ref: '../../v3/responses/400.yaml'
'401':
$ref: '../../v3/responses/401.yaml'
'403':
$ref: '../../v3/responses/403.yaml'
'404':
$ref: '../../v3/responses/404.yaml'
'429':
$ref: '../../v3/responses/429.yaml'
'500':
$ref: '../../v3/responses/500.yaml'
post:
operationId: publishDataSegment
security:
- userAuth: [ idn:data-segments:write ]
- applicationAuth: [ idn:data-segments:write ]
x-sailpoint-userLevels:
- ORG_ADMIN
tags:
- Data Segmentation
summary: Publish segment by ID
description: >-
This will publish the segment so that it starts applying the segmentation to the desired users if enabled
parameters:
- in: query
name: publishAll
schema:
type: boolean
default: true
required: false
description: This flag decides whether you want to publish all unpublished or a list of specific segment ids
example: true
requestBody:
required: true
description: A list of segment ids that you wish to publish
content:
application/json:
schema:
type: array
items:
type: string
responses:
'200':
description: Segments published
'400':
$ref: '../../v3/responses/400.yaml'
'401':
$ref: '../../v3/responses/401.yaml'
'403':
$ref: '../../v3/responses/403.yaml'
'404':
$ref: '../../v3/responses/404.yaml'
'429':
$ref: '../../v3/responses/429.yaml'
'500':
$ref: '../../v3/responses/500.yaml'
patch:
operationId: patchDataSegment
security:
- userAuth: [ idn:data-segments:write ]
- applicationAuth: [ idn:data-segments:write ]
x-sailpoint-userLevels:
- ORG_ADMIN
tags:
- Data Segmentation
summary: Update Segment
description: >-
Use this API to update segment fields by using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
parameters:
- in: path
name: id
schema:
type: string
required: true
description: The segment ID to modify.
example: ef38f943-47e9-4562-b5bb-8424a56397d8
requestBody:
required: true
description: |
A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
The following fields are patchable:
* name
* description
* membership
* memberFilter
* memberSelection
* scopes
* enabled
content:
application/json-patch+json:
schema:
type: array
items:
type: object
examples:
Set Visibility Criteria:
description: Set the member filter
value:
- op: "replace"
path: "/memberFilter"
value:
expression:
operator: "AND"
children:
- operator: "EQUALS"
attribute: "location"
value:
type: "STRING"
value: "Philadelphia"
- operator: "EQUALS"
attribute: "department"
value:
type: "STRING"
value: "HR"
responses:
'200':
description: >-
Indicates the PATCH operation succeeded, and returns the segment's new representation.
content:
application/json:
schema:
$ref: '../../internal/schemas/data-segment/Data-Segment.yaml'
'400':
$ref: '../../v3/responses/400.yaml'
'401':
$ref: '../../v3/responses/401.yaml'
'403':
$ref: '../../v3/responses/403.yaml'
'404':
$ref: '../../v3/responses/404.yaml'
'429':
$ref: '../../v3/responses/429.yaml'
'500':
$ref: '../../v3/responses/500.yaml'
delete:
operationId: deleteDataSegment
security:
- userAuth: [ idn:data-segments:write ]
- applicationAuth: [ idn:data-segments:write ]
x-sailpoint-userLevels:
- ORG_ADMIN
tags:
- Data Segmentation
summary: Delete Segment by ID
description: >-
This API deletes the segment specified by the given ID.
parameters:
- in: path
name: id
schema:
type: string
required: true
description: The segment ID to delete.
example: ef38f943-47e9-4562-b5bb-8424a56397d8
- in: query
name: published
schema:
type: boolean
default: false
required: false
description: This determines which version of the segment to delete
example: false
responses:
'204':
description: No content.
'400':
$ref: '../../v3/responses/400.yaml'
'401':
$ref: '../../v3/responses/401.yaml'
'403':
$ref: '../../v3/responses/403.yaml'
'404':
$ref: '../../v3/responses/404.yaml'
'429':
$ref: '../../v3/responses/429.yaml'
'500':
$ref: '../../v3/responses/500.yaml'

View File

@@ -1,117 +0,0 @@
get:
operationId: listDataSegments
security:
- userAuth: [ idn:data-segments:read ]
- applicationAuth: [ idn:data-segments:read ]
x-sailpoint-userLevels:
- ORG_ADMIN
tags:
- Data Segmentation
summary: Get Segments
description: >-
This API returns the segment specified by the given ID.
parameters:
- in: query
name: enabled
required: false
description: This boolean indicates whether the segment is currently active. Inactive segments have no effect.
schema:
type: boolean
default: true
example: true
- in: query
name: unique
required: false
description: This returns only one record if set to true and that would be the published record if exists.
schema:
type: boolean
default: false
example: false
- in: query
name: published
required: false
description: This boolean indicates whether the segment is being applied to the accounts. If unpublished its being actively modified until published
schema:
type: boolean
default: true
example: true
- $ref: '../../v3/parameters/limit.yaml'
- $ref: '../../v3/parameters/offset.yaml'
- $ref: '../../v3/parameters/count.yaml'
- in: query
name: filters
required: false
schema:
type: string
example: name eq ""
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, sw*
**name**: *eq, in, sw*
responses:
'200':
description: List of all segments
content:
application/json:
schema:
type: array
items:
$ref: '../../internal/schemas/data-segment/Data-Segment.yaml'
'400':
$ref: '../../v3/responses/400.yaml'
'401':
$ref: '../../v3/responses/401.yaml'
'403':
$ref: '../../v3/responses/403.yaml'
'404':
$ref: '../../v3/responses/404.yaml'
'429':
$ref: '../../v3/responses/429.yaml'
'500':
$ref: '../../v3/responses/500.yaml'
post:
operationId: createDataSegment
security:
- userAuth: [ idn:data-segments:write ]
- applicationAuth: [ idn:data-segments:write ]
x-sailpoint-userLevels:
- ORG_ADMIN
tags:
- Data Segmentation
summary: Create Segment
description: >-
This API creates a segment.
>**Note:** Segment definitions may take time to propagate to all identities.
requestBody:
required: true
content:
application/json:
schema:
$ref: '../../internal/schemas/data-segment/Data-Segment.yaml'
responses:
'201':
description: Segment created
content:
application/json:
schema:
$ref: '../../internal/schemas/data-segment/Data-Segment.yaml'
'400':
$ref: '../../v3/responses/400.yaml'
'401':
$ref: '../../v3/responses/401.yaml'
'403':
$ref: '../../v3/responses/403.yaml'
'429':
$ref: '../../v3/responses/429.yaml'
'500':
$ref: '../../v3/responses/500.yaml'