Update PowerShell SDK docs: 16507204442

This commit is contained in:
developer-relations-sp
2025-07-24 20:31:57 +00:00
parent 076fc2761f
commit ba44ba0234
76 changed files with 950 additions and 721 deletions

View File

@@ -734,12 +734,19 @@ try {
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
"This API applies an update to every entitlement of the list.\n\nThe\
\ number of entitlements to update is limited to 50 items maximum.\n\nThe JsonPatch\
\ update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.\
\ allowed operations : `**{ \"op\": \"replace\", \"path\": \"/privileged\", \"\
value\": boolean }** **{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\"\
: boolean }**`"
This API applies an update to every entitlement of the list.
The number of entitlements to update is limited to 50 items maximum.
The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
examples of allowed operations :
`**{ "op": "replace", "path": "/privileged", "value": boolean }**`
`**{ "op": "replace", "path": "/requestable","value": boolean }**`
`**{ "op": "replace", "path": "/privilegeOverride/overrideLevel","value": string }**`
A token with ORG_ADMIN or API authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-entitlements-in-bulk)
@@ -780,6 +787,10 @@ $EntitlementBulkUpdateRequest = @"{
"op" : "replace",
"path" : "/requestable",
"value" : false
}, {
"op" : "replace",
"path" : "/privilegeOverride/overrideLevel",
"value" : "HIGH"
} ]
}"@

View File

@@ -20,7 +20,7 @@ Method | HTTP request | Description
[**Compare-V2025IdentitySnapshots**](#compare-identity-snapshots) | **GET** `/historical-identities/{id}/compare` | Gets a difference of count for each access item types for the given identity between 2 snapshots
[**Compare-V2025IdentitySnapshotsAccessType**](#compare-identity-snapshots-access-type) | **GET** `/historical-identities/{id}/compare/{access-type}` | Gets a list of differences of specific accesstype for the given identity between 2 snapshots
[**Get-V2025HistoricalIdentity**](#get-historical-identity) | **GET** `/historical-identities/{id}` | Get latest snapshot of identity
[**Get-V2025HistoricalIdentityEvents**](#get-historical-identity-events) | **GET** `/historical-identities/{id}/events` | Lists all events for the given identity
[**Get-V2025HistoricalIdentityEvents**](#get-historical-identity-events) | **GET** `/historical-identities/{id}/events` | List identity event history
[**Get-V2025IdentitySnapshot**](#get-identity-snapshot) | **GET** `/historical-identities/{id}/snapshots/{date}` | Gets an identity snapshot at a given date
[**Get-V2025IdentitySnapshotSummary**](#get-identity-snapshot-summary) | **GET** `/historical-identities/{id}/snapshot-summary` | Gets the summary for the event count for a specific identity
[**Get-V2025IdentityStartDate**](#get-identity-start-date) | **GET** `/historical-identities/{id}/start-date` | Gets the start date of the identity
@@ -261,7 +261,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
# Lists all events for the given identity
# List identity event history
try {
Get-V2025HistoricalIdentityEvents -Id $Id -XSailPointExperimental $XSailPointExperimental
@@ -574,12 +574,12 @@ Path | Date | **String** | True | The specified date
Query | Type | **String** | (optional) | The access item type
### Return type
[**ListIdentityAccessItems200ResponseInner[]**](../models/list-identity-access-items200-response-inner)
[**ListIdentitySnapshotAccessItems200ResponseInner[]**](../models/list-identity-snapshot-access-items200-response-inner)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | The identity object. | ListIdentityAccessItems200ResponseInner[]
200 | The identity object. | ListIdentitySnapshotAccessItems200ResponseInner[]
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto