LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-07 12:27:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update PowerShell SDK docs: 16507204442

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaEntitlementsApi.md
View File

@@ -504,7 +504,7 @@ try {
## patch-entitlement
This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**, and **manuallyUpdatedFields**
The following fields are patchable: **requestable**, **privileged**, **segments**, **owner**, **name**, **description**, **privilegeOverride/overrideLevel** and **manuallyUpdatedFields**
When you're patching owner, only owner type and owner id must be provided. Owner name is optional, and it won't be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY.
@@ -684,11 +684,11 @@ 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. allowed operations :
`**{ "op": "replace", "path": "/privileged", "value": boolean }** **{ "op":
"replace", "path": "/requestable","value": boolean }**`
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.
@@ -729,6 +729,10 @@ $EntitlementBulkUpdateRequest = @"{
"op" : "replace",
"path" : "/requestable",
"value" : false
}, {
"op" : "replace",
"path" : "/privilegeOverride/overrideLevel",
"value" : "HIGH"
} ]
}"@

8
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityHistoryApi.md
View File

@@ -20,7 +20,7 @@ Method | HTTP request | Description
[**Compare-BetaIdentitySnapshots**](#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-BetaIdentitySnapshotsAccessType**](#compare-identity-snapshots-access-type) | **GET** `/historical-identities/{id}/compare/{accessType}` | Gets a list of differences of specific accesstype for the given identity between 2 snapshots
[**Get-BetaHistoricalIdentity**](#get-historical-identity) | **GET** `/historical-identities/{id}` | Get latest snapshot of identity
[**Get-BetaHistoricalIdentityEvents**](#get-historical-identity-events) | **GET** `/historical-identities/{id}/events` | Lists all events for the given identity
[**Get-BetaHistoricalIdentityEvents**](#get-historical-identity-events) | **GET** `/historical-identities/{id}/events` | List identity event history
[**Get-BetaIdentitySnapshot**](#get-identity-snapshot) | **GET** `/historical-identities/{id}/snapshots/{date}` | Gets an identity snapshot at a given date
[**Get-BetaIdentitySnapshotSummary**](#get-identity-snapshot-summary) | **GET** `/historical-identities/{id}/snapshot-summary` | Gets the summary for the event count for a specific identity
[**Get-BetaIdentityStartDate**](#get-identity-start-date) | **GET** `/historical-identities/{id}/start-date` | Gets the start date of the identity
@@ -241,7 +241,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-BetaHistoricalIdentityEvents -Id $Id
@@ -530,12 +530,12 @@ Path | Date | **String** | True | Specified date.
Query | Type | **String** | (optional) | 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 | Identity object. | ListIdentityAccessItems200ResponseInner[]
200 | 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. | ListAccessModelMetadataAttribute401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto

28
docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemAccessProfileResponse.md
View File

@@ -16,32 +16,30 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemAccessProfileResponse', 'Be
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessType** | **String** | the access item type. accessProfile in this case | [optional]
**Id** | **String** | the access item id | [optional]
**Name** | **String** | the access profile name | [optional]
**SourceName** | **String** | the name of the source | [optional]
**SourceId** | **String** | the id of the source | [optional]
**Description** | **String** | the description for the access profile | [optional]
**AccessType** | **String** | the access item type. accessProfile in this case | [optional]
**DisplayName** | **String** | the display name of the identity | [optional]
**EntitlementCount** | **String** | the number of entitlements the access profile will create | [optional]
**AppDisplayName** | **String** | the name of | [optional]
**SourceName** | **String** | the name of the source | [optional]
**EntitlementCount** | **Int32** | the number of entitlements the access profile will create | [required]
**Description** | **String** | the description for the access profile | [optional]
**SourceId** | **String** | the id of the source | [optional]
**AppRefs** | [**[]AccessItemAccessProfileResponseAppRefsInner**](access-item-access-profile-response-app-refs-inner) | the list of app ids associated with the access profile | [required]
**RemoveDate** | **String** | the date the access profile is no longer assigned to the specified identity | [optional]
**Standalone** | **Boolean** | indicates whether the access profile is standalone | [required]
**Revocable** | **Boolean** | indicates whether the access profile is | [required]
**Revocable** | **Boolean** | indicates whether the access profile is revocable | [required]
## Examples
- Prepare the resource
```powershell
$AccessItemAccessProfileResponse = Initialize-BetaAccessItemAccessProfileResponse -AccessType accessProfile `
-Id 2c918087763e69d901763e72e97f006f `
-Name sample `
-SourceName DataScienceDataset `
-SourceId 2793o32dwd `
-Description AccessProfile - Workday/Citizenship access `
$AccessItemAccessProfileResponse = Initialize-BetaAccessItemAccessProfileResponse -Id 2c918087763e69d901763e72e97f006f `
-AccessType accessProfile `
-DisplayName Dr. Arden Rogahn MD `
-SourceName DataScienceDataset `
-EntitlementCount 12 `
-AppDisplayName AppName `
-Description AccessProfile - Workday/Citizenship access `
-SourceId 2793o32dwd `
-AppRefs [{cloudAppId=8c190e6787aa4ed9a90bd9d5344523fb, cloudAppName=Sample App}, {cloudAppId=2c91808a77ff216301782327a50f09bf, cloudAppName=Another App}] `
-RemoveDate 2024-07-01T06:00:00.00Z `
-Standalone false `
-Revocable true

37
docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemAccessProfileResponseAppRefsInner.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: beta-access-item-access-profile-response-app-refs-inner
title: AccessItemAccessProfileResponseAppRefsInner
pagination_label: AccessItemAccessProfileResponseAppRefsInner
sidebar_label: AccessItemAccessProfileResponseAppRefsInner
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemAccessProfileResponseAppRefsInner', 'BetaAccessItemAccessProfileResponseAppRefsInner']
slug: /tools/sdk/powershell/beta/models/access-item-access-profile-response-app-refs-inner
tags: ['SDK', 'Software Development Kit', 'AccessItemAccessProfileResponseAppRefsInner', 'BetaAccessItemAccessProfileResponseAppRefsInner']
---
# AccessItemAccessProfileResponseAppRefsInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**CloudAppId** | **String** | the cloud app id associated with the access profile | [optional]
**CloudAppName** | **String** | the cloud app name associated with the access profile | [optional]
## Examples
- Prepare the resource
```powershell
$AccessItemAccessProfileResponseAppRefsInner = Initialize-BetaAccessItemAccessProfileResponseAppRefsInner -CloudAppId 8c190e6787aa4ed9a90bd9d5344523fb `
-CloudAppName Sample App
```
- Convert the resource to JSON
```powershell
$AccessItemAccessProfileResponseAppRefsInner | ConvertTo-JSON
```
[[Back to top]](#)

20
docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemAccountResponse.md
View File

@@ -16,25 +16,25 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemAccountResponse', 'BetaAcce
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessType** | **String** | the access item type. account in this case | [optional]
**Id** | **String** | the access item id | [optional]
**NativeIdentity** | **String** | the native identifier used to uniquely identify an acccount | [optional]
**SourceName** | **String** | the name of the source | [optional]
**SourceId** | **String** | the id of the source | [optional]
**EntitlementCount** | **String** | the number of entitlements the account will create | [optional]
**AccessType** | **String** | the access item type. account in this case | [optional]
**DisplayName** | **String** | the display name of the identity | [optional]
**SourceName** | **String** | the name of the source | [optional]
**NativeIdentity** | **String** | the native identifier used to uniquely identify an acccount | [required]
**SourceId** | **String** | the id of the source | [optional]
**EntitlementCount** | **Int32** | the number of entitlements the account will create | [optional]
## Examples
- Prepare the resource
```powershell
$AccessItemAccountResponse = Initialize-BetaAccessItemAccountResponse -AccessType account `
-Id 2c918087763e69d901763e72e97f006f `
-NativeIdentity dr.arden.ogahn.d `
$AccessItemAccountResponse = Initialize-BetaAccessItemAccountResponse -Id 2c918087763e69d901763e72e97f006f `
-AccessType account `
-DisplayName Dr. Arden Rogahn MD `
-SourceName DataScienceDataset `
-NativeIdentity dr.arden.ogahn.d `
-SourceId 2793o32dwd `
-EntitlementCount 12 `
-DisplayName Dr. Arden Rogahn MD
-EntitlementCount 12
```
- Convert the resource to JSON

8
docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemAppResponse.md
View File

@@ -16,18 +16,18 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemAppResponse', 'BetaAccessIt
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessType** | **String** | the access item type. entitlement in this case | [optional]
**Id** | **String** | the access item id | [optional]
**AccessType** | **String** | the access item type. entitlement in this case | [optional]
**DisplayName** | **String** | the access item display name | [optional]
**SourceName** | **String** | the associated source name if it exists | [optional]
**AppRoleId** | **String** | the app role id | [optional]
**AppRoleId** | **String** | the app role id | [required]
## Examples
- Prepare the resource
```powershell
$AccessItemAppResponse = Initialize-BetaAccessItemAppResponse -AccessType app `
-Id 2c918087763e69d901763e72e97f006f `
$AccessItemAppResponse = Initialize-BetaAccessItemAppResponse -Id 2c918087763e69d901763e72e97f006f `
-AccessType app `
-DisplayName Display Name `
-SourceName appName `
-AppRoleId 2c918087763e69d901763e72e97f006f

18
docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemAssociated.md
View File

@@ -16,21 +16,23 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemAssociated', 'BetaAccessIte
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessItem** | [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional]
**IdentityId** | **String** | the identity id | [optional]
**EventType** | **String** | the event type | [optional]
**Dt** | **String** | the date of event | [optional]
**GovernanceEvent** | [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [optional]
**DateTime** | **String** | the date of event | [optional]
**IdentityId** | **String** | the identity id | [optional]
**AccessItem** | [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [required]
**GovernanceEvent** | [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [required]
**AccessItemType** | **Enum** [ "account", "app", "entitlement", "role", "accessProfile" ] | the access item type | [optional]
## Examples
- Prepare the resource
```powershell
$AccessItemAssociated = Initialize-BetaAccessItemAssociated -AccessItem null `
$AccessItemAssociated = Initialize-BetaAccessItemAssociated -EventType AccessItemAssociated `
-DateTime 2019-03-08T22:37:33.901Z `
-IdentityId 8c190e6787aa4ed9a90bd9d5344523fb `
-EventType AccessItemAssociated `
-Dt 2019-03-08T22:37:33.901Z `
-GovernanceEvent null
-AccessItem null `
-GovernanceEvent null `
-AccessItemType account
```
- Convert the resource to JSON

58
docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemAssociatedAccessItem.md
View File

@@ -16,49 +16,47 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemAssociatedAccessItem', 'Bet
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessType** | **String** | the access item type. role in this case | [optional]
**Id** | **String** | the access item id | [optional]
**Name** | **String** | the access profile name | [optional]
**AccessType** | **String** | the access item type. entitlement in this case | [optional]
**DisplayName** | **String** | the access item display name | [optional]
**SourceName** | **String** | the associated source name if it exists | [optional]
**SourceId** | **String** | the id of the source | [optional]
**Attribute** | **String** | the entitlement attribute | [required]
**Value** | **String** | the associated value | [required]
**Type** | **String** | the type of entitlement | [required]
**Description** | **String** | the description for the role | [optional]
**DisplayName** | **String** | the role display name | [optional]
**EntitlementCount** | **String** | the number of entitlements the account will create | [optional]
**AppDisplayName** | **String** | the name of | [optional]
**RemoveDate** | **String** | the date the role is no longer assigned to the specified identity | [optional]
**Standalone** | **Boolean** | indicates whether the entitlement is standalone | [required]
**Revocable** | **Boolean** | indicates whether the role is revocable | [required]
**NativeIdentity** | **String** | the native identifier used to uniquely identify an acccount | [optional]
**AppRoleId** | **String** | the app role id | [optional]
**Attribute** | **String** | the entitlement attribute | [optional]
**Value** | **String** | the associated value | [optional]
**EntitlementType** | **String** | the type of entitlement | [optional]
**SourceId** | **String** | the id of the source | [optional]
**Standalone** | **Boolean** | indicates whether the access profile is standalone | [required]
**Privileged** | **Boolean** | indicates whether the entitlement is privileged | [required]
**CloudGoverned** | **Boolean** | indicates whether the entitlement is cloud governed | [required]
**EntitlementCount** | **Int32** | the number of entitlements the account will create | [required]
**AppRefs** | [**[]AccessItemAccessProfileResponseAppRefsInner**](access-item-access-profile-response-app-refs-inner) | the list of app ids associated with the access profile | [required]
**RemoveDate** | **String** | the date the role is no longer assigned to the specified identity | [optional]
**Revocable** | **Boolean** | indicates whether the role is revocable | [required]
**NativeIdentity** | **String** | the native identifier used to uniquely identify an acccount | [required]
**AppRoleId** | **String** | the app role id | [required]
## Examples
- Prepare the resource
```powershell
$AccessItemAssociatedAccessItem = Initialize-BetaAccessItemAssociatedAccessItem -AccessType role `
-Id 2c918087763e69d901763e72e97f006f `
-Name sample `
-SourceName Source Name `
-SourceId 2793o32dwd `
-Description Role - Workday/Citizenship access `
-DisplayName sample `
-EntitlementCount 12 `
-AppDisplayName AppName `
-RemoveDate 2024-07-01T06:00:00.00Z `
-Standalone true `
-Revocable true `
-NativeIdentity dr.arden.ogahn.d `
-AppRoleId 2c918087763e69d901763e72e97f006f `
$AccessItemAssociatedAccessItem = Initialize-BetaAccessItemAssociatedAccessItem -Id 2c918087763e69d901763e72e97f006f `
-AccessType app `
-DisplayName Display Name `
-SourceName appName `
-Attribute groups `
-Value Upward mobility access `
-EntitlementType entitlement `
-Type ENTITLEMENT `
-Description Role - Workday/Citizenship access `
-SourceId 2793o32dwd `
-Standalone false `
-Privileged false `
-CloudGoverned true
-CloudGoverned true `
-EntitlementCount 12 `
-AppRefs [{cloudAppId=8c190e6787aa4ed9a90bd9d5344523fb, cloudAppName=Sample App}, {cloudAppId=2c91808a77ff216301782327a50f09bf, cloudAppName=Another App}] `
-RemoveDate 2024-07-01T06:00:00.00Z `
-Revocable true `
-NativeIdentity dr.arden.ogahn.d `
-AppRoleId 2c918087763e69d901763e72e97f006f
```
- Convert the resource to JSON

26
docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemEntitlementResponse.md
View File

@@ -16,15 +16,15 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemEntitlementResponse', 'Beta
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessType** | **String** | the access item type. entitlement in this case | [optional]
**Id** | **String** | the access item id | [optional]
**Attribute** | **String** | the entitlement attribute | [optional]
**Value** | **String** | the associated value | [optional]
**EntitlementType** | **String** | the type of entitlement | [optional]
**SourceName** | **String** | the name of the source | [optional]
**SourceId** | **String** | the id of the source | [optional]
**Description** | **String** | the description for the entitlment | [optional]
**AccessType** | **String** | the access item type. entitlement in this case | [optional]
**DisplayName** | **String** | the display name of the identity | [optional]
**SourceName** | **String** | the name of the source | [optional]
**Attribute** | **String** | the entitlement attribute | [required]
**Value** | **String** | the associated value | [required]
**Type** | **String** | the type of entitlement | [required]
**Description** | **String** | the description for the entitlment | [optional]
**SourceId** | **String** | the id of the source | [optional]
**Standalone** | **Boolean** | indicates whether the entitlement is standalone | [required]
**Privileged** | **Boolean** | indicates whether the entitlement is privileged | [required]
**CloudGoverned** | **Boolean** | indicates whether the entitlement is cloud governed | [required]
@@ -33,15 +33,15 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$AccessItemEntitlementResponse = Initialize-BetaAccessItemEntitlementResponse -AccessType entitlement `
-Id 2c918087763e69d901763e72e97f006f `
$AccessItemEntitlementResponse = Initialize-BetaAccessItemEntitlementResponse -Id 2c918087763e69d901763e72e97f006f `
-AccessType entitlement `
-DisplayName Dr. Arden Rogahn MD `
-SourceName DataScienceDataset `
-Attribute groups `
-Value Upward mobility access `
-EntitlementType entitlement `
-SourceName DataScienceDataset `
-SourceId 2793o32dwd `
-Type ENTITLEMENT `
-Description Entitlement - Workday/Citizenship access `
-DisplayName Dr. Arden Rogahn MD `
-SourceId 2793o32dwd `
-Standalone true `
-Privileged false `
-CloudGoverned true

8
docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemRemoved.md
View File

@@ -16,10 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemRemoved', 'BetaAccessItemRe
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessItem** | [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional]
**AccessItem** | [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [required]
**IdentityId** | **String** | the identity id | [optional]
**EventType** | **String** | the event type | [optional]
**Dt** | **String** | the date of event | [optional]
**DateTime** | **String** | the date of event | [optional]
**AccessItemType** | **Enum** [ "account", "app", "entitlement", "role", "accessProfile" ] | the access item type | [optional]
**GovernanceEvent** | [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [optional]
## Examples
@@ -29,7 +30,8 @@ Name | Type | Description | Notes
$AccessItemRemoved = Initialize-BetaAccessItemRemoved -AccessItem null `
-IdentityId 8c190e6787aa4ed9a90bd9d5344523fb `
-EventType AccessItemRemoved `
-Dt 2019-03-08T22:37:33.901Z `
-DateTime 2019-03-08T22:37:33.901Z `
-AccessItemType account `
-GovernanceEvent null
```

10
docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemRoleResponse.md
View File

@@ -16,11 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemRoleResponse', 'BetaAccessI
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessType** | **String** | the access item type. role in this case | [optional]
**Id** | **String** | the access item id | [optional]
**AccessType** | **String** | the access item type. role in this case | [optional]
**DisplayName** | **String** | the role display name | [optional]
**Description** | **String** | the description for the role | [optional]
**SourceName** | **String** | the associated source name if it exists | [optional]
**Description** | **String** | the description for the role | [optional]
**RemoveDate** | **String** | the date the role is no longer assigned to the specified identity | [optional]
**Revocable** | **Boolean** | indicates whether the role is revocable | [required]
@@ -28,11 +28,11 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$AccessItemRoleResponse = Initialize-BetaAccessItemRoleResponse -AccessType role `
-Id 2c918087763e69d901763e72e97f006f `
$AccessItemRoleResponse = Initialize-BetaAccessItemRoleResponse -Id 2c918087763e69d901763e72e97f006f `
-AccessType role `
-DisplayName sample `
-Description Role - Workday/Citizenship access `
-SourceName Source Name `
-Description Role - Workday/Citizenship access `
-RemoveDate 2024-07-01T06:00:00.00Z `
-Revocable true
```

6
docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequested.md
View File

@@ -16,10 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequested', 'BetaAccessRequeste
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessRequest** | [**AccessRequestResponse1**](access-request-response1) | | [optional]
**AccessRequest** | [**AccessRequestResponse1**](access-request-response1) | | [required]
**IdentityId** | **String** | the identity id | [optional]
**EventType** | **String** | the event type | [optional]
**Dt** | **String** | the date of event | [optional]
**DateTime** | **String** | the date of event | [optional]
## Examples
@@ -28,7 +28,7 @@ Name | Type | Description | Notes
$AccessRequested = Initialize-BetaAccessRequested -AccessRequest null `
-IdentityId 8a80828f643d484f01643e14202e206f `
-EventType AccessRequested `
-Dt 2019-03-08T22:37:33.901Z
-DateTime 2019-03-08T22:37:33.901Z
```
- Convert the resource to JSON

12
docs/tools/sdk/powershell/Reference/Beta/Models/AccountStatusChanged.md
View File

@@ -18,17 +18,17 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**EventType** | **String** | the event type | [optional]
**IdentityId** | **String** | the identity id | [optional]
**Dt** | **String** | the date of event | [optional]
**Account** | [**AccountStatusChangedAccount**](account-status-changed-account) | | [optional]
**StatusChange** | [**AccountStatusChangedStatusChange**](account-status-changed-status-change) | | [optional]
**DateTime** | **String** | the date of event | [optional]
**Account** | [**AccountStatusChangedAccount**](account-status-changed-account) | | [required]
**StatusChange** | [**AccountStatusChangedStatusChange**](account-status-changed-status-change) | | [required]
## Examples
- Prepare the resource
```powershell
$AccountStatusChanged = Initialize-BetaAccountStatusChanged -EventType null `
-IdentityId null `
-Dt null `
$AccountStatusChanged = Initialize-BetaAccountStatusChanged -EventType AccountStatusChanged `
-IdentityId 8a80828f643d484f01643e14202e206f `
-DateTime 2019-03-08T22:37:33.901Z `
-Account null `
-StatusChange null
```

14
docs/tools/sdk/powershell/Reference/Beta/Models/AccountStatusChangedAccount.md
View File

@@ -28,13 +28,13 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$AccountStatusChangedAccount = Initialize-BetaAccountStatusChangedAccount -Id null `
-NativeIdentity null `
-DisplayName null `
-SourceId null `
-SourceName null `
-EntitlementCount null `
-AccessType null
$AccountStatusChangedAccount = Initialize-BetaAccountStatusChangedAccount -Id 2c91808a77ff216301782327a50f09bf `
-NativeIdentity dr.arden.ogahn.d `
-DisplayName Adam Archer `
-SourceId 8a80828f643d484f01643e14202e206f `
-SourceName JDBC Entitlements Source `
-EntitlementCount 2 `
-AccessType account
```
- Convert the resource to JSON

4
docs/tools/sdk/powershell/Reference/Beta/Models/AccountStatusChangedStatusChange.md
View File

@@ -23,8 +23,8 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$AccountStatusChangedStatusChange = Initialize-BetaAccountStatusChangedStatusChange -PreviousStatus null `
-NewStatus null
$AccountStatusChangedStatusChange = Initialize-BetaAccountStatusChangedStatusChange -PreviousStatus enabled `
-NewStatus disabled
```
- Convert the resource to JSON

6
docs/tools/sdk/powershell/Reference/Beta/Models/AttributeChange.md
View File

@@ -24,9 +24,9 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$AttributeChange = Initialize-BetaAttributeChange -Name null `
-PreviousValue null `
-NewValue null
$AttributeChange = Initialize-BetaAttributeChange -Name firstname `
-PreviousValue adam `
-NewValue zampa
```
- Convert the resource to JSON

12
docs/tools/sdk/powershell/Reference/Beta/Models/AttributesChanged.md
View File

@@ -16,19 +16,19 @@ tags: ['SDK', 'Software Development Kit', 'AttributesChanged', 'BetaAttributesCh
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Changes** | [**[]AttributeChange**](attribute-change) | | [optional]
**AttributeChanges** | [**[]AttributeChange**](attribute-change) | | [required]
**EventType** | **String** | the event type | [optional]
**IdentityId** | **String** | the identity id | [optional]
**Dt** | **String** | the date of event | [optional]
**DateTime** | **String** | the date of event | [optional]
## Examples
- Prepare the resource
```powershell
$AttributesChanged = Initialize-BetaAttributesChanged -Changes null `
-EventType null `
-IdentityId null `
-Dt null
$AttributesChanged = Initialize-BetaAttributesChanged -AttributeChanges null `
-EventType AttributesChanged `
-IdentityId 8a80828f643d484f01643e14202e206f `
-DateTime 2019-03-08T22:37:33.901Z
```
- Convert the resource to JSON

4
docs/tools/sdk/powershell/Reference/Beta/Models/CorrelatedGovernanceEvent.md
View File

@@ -17,7 +17,7 @@ tags: ['SDK', 'Software Development Kit', 'CorrelatedGovernanceEvent', 'BetaCorr
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Name** | **String** | The name of the governance event, such as the certification name or access request ID. | [optional]
**Dt** | **String** | The date that the certification or access request was completed. | [optional]
**DateTime** | **String** | The date that the certification or access request was completed. | [optional]
**Type** | **Enum** [ "certification", "accessRequest" ] | The type of governance event. | [optional]
**GovernanceId** | **String** | The ID of the instance that caused the event - either the certification ID or access request ID. | [optional]
**Owners** | [**[]CertifierResponse**](certifier-response) | The owners of the governance event (the certifiers or approvers) | [optional]
@@ -29,7 +29,7 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$CorrelatedGovernanceEvent = Initialize-BetaCorrelatedGovernanceEvent -Name Manager Certification for Jon Snow `
-Dt 2019-03-08T22:37:33.901Z `
-DateTime 2019-03-08T22:37:33.901Z `
-Type certification `
-GovernanceId 2c91808a77ff216301782327a50f09bf `
-Owners [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] `

4
docs/tools/sdk/powershell/Reference/Beta/Models/EntitlementBulkUpdateRequest.md
View File

@@ -17,14 +17,14 @@ tags: ['SDK', 'Software Development Kit', 'EntitlementBulkUpdateRequest', 'BetaE
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**EntitlementIds** | **[]String** | List of entitlement ids to update | [required]
**JsonPatch** | [**[]JsonPatchOperation**](json-patch-operation) | | [required]
**JsonPatch** | [**[]JsonPatchOperation**](json-patch-operation) | List of entitlement ids to update | [required]
## Examples
- Prepare the resource
```powershell
$EntitlementBulkUpdateRequest = Initialize-BetaEntitlementBulkUpdateRequest -EntitlementIds [2c91808a7624751a01762f19d665220d, 2c91808a7624751a01762f19d67c220e, 2c91808a7624751a01762f19d692220f] `
-JsonPatch [{op=replace, path=/privileged, value=false}, {op=replace, path=/requestable, value=false}]
-JsonPatch [{op=replace, path=/privileged, value=false}, {op=replace, path=/requestable, value=false}, {op=replace, path=/privilegeOverride/overrideLevel, value=HIGH}]
```
- Convert the resource to JSON

40
docs/tools/sdk/powershell/Reference/Beta/Models/GetHistoricalIdentityEvents200ResponseInner.md
View File

@@ -16,39 +16,41 @@ tags: ['SDK', 'Software Development Kit', 'GetHistoricalIdentityEvents200Respons
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessItem** | [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional]
**IdentityId** | **String** | the identity id | [optional]
**EventType** | **String** | the event type | [optional]
**Dt** | **String** | the date of event | [optional]
**GovernanceEvent** | [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [optional]
**Changes** | [**[]AttributeChange**](attribute-change) | | [optional]
**AccessRequest** | [**AccessRequestResponse1**](access-request-response1) | | [optional]
**CertificationId** | **String** | the id of the certification item | [optional]
**CertificationName** | **String** | the certification item name | [optional]
**CertificationId** | **String** | the id of the certification item | [required]
**CertificationName** | **String** | the certification item name | [required]
**SignedDate** | **String** | the date ceritification was signed | [optional]
**Certifiers** | [**[]CertifierResponse**](certifier-response) | this field is deprecated and may go away | [optional]
**Reviewers** | [**[]CertifierResponse**](certifier-response) | The list of identities who review this certification | [optional]
**Signer** | [**CertifierResponse**](certifier-response) | | [optional]
**Account** | [**AccountStatusChangedAccount**](account-status-changed-account) | | [optional]
**StatusChange** | [**AccountStatusChangedStatusChange**](account-status-changed-status-change) | | [optional]
**EventType** | **String** | the event type | [optional]
**DateTime** | **String** | the date of event | [optional]
**IdentityId** | **String** | the identity id | [optional]
**AccessItem** | [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [required]
**GovernanceEvent** | [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [required]
**AccessItemType** | **Enum** [ "account", "app", "entitlement", "role", "accessProfile" ] | the access item type | [optional]
**AttributeChanges** | [**[]AttributeChange**](attribute-change) | | [required]
**AccessRequest** | [**AccessRequestResponse1**](access-request-response1) | | [required]
**Account** | [**AccountStatusChangedAccount**](account-status-changed-account) | | [required]
**StatusChange** | [**AccountStatusChangedStatusChange**](account-status-changed-status-change) | | [required]
## Examples
- Prepare the resource
```powershell
$GetHistoricalIdentityEvents200ResponseInner = Initialize-BetaGetHistoricalIdentityEvents200ResponseInner -AccessItem null `
-IdentityId null `
-EventType null `
-Dt null `
-GovernanceEvent null `
-Changes null `
-AccessRequest null `
-CertificationId 2c91808a77ff216301782327a50f09bf `
$GetHistoricalIdentityEvents200ResponseInner = Initialize-BetaGetHistoricalIdentityEvents200ResponseInner -CertificationId 2c91808a77ff216301782327a50f09bf `
-CertificationName Cert name `
-SignedDate 2019-03-08T22:37:33.901Z `
-Certifiers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] `
-Reviewers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] `
-Signer null `
-EventType AccountStatusChanged `
-DateTime 2019-03-08T22:37:33.901Z `
-IdentityId 8a80828f643d484f01643e14202e206f `
-AccessItem null `
-GovernanceEvent null `
-AccessItemType account `
-AttributeChanges null `
-AccessRequest null `
-Account null `
-StatusChange null
```

8
docs/tools/sdk/powershell/Reference/Beta/Models/IdentityCertified.md
View File

@@ -16,14 +16,14 @@ tags: ['SDK', 'Software Development Kit', 'IdentityCertified', 'BetaIdentityCert
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**CertificationId** | **String** | the id of the certification item | [optional]
**CertificationName** | **String** | the certification item name | [optional]
**CertificationId** | **String** | the id of the certification item | [required]
**CertificationName** | **String** | the certification item name | [required]
**SignedDate** | **String** | the date ceritification was signed | [optional]
**Certifiers** | [**[]CertifierResponse**](certifier-response) | this field is deprecated and may go away | [optional]
**Reviewers** | [**[]CertifierResponse**](certifier-response) | The list of identities who review this certification | [optional]
**Signer** | [**CertifierResponse**](certifier-response) | | [optional]
**EventType** | **String** | the event type | [optional]
**Dt** | **String** | the date of event | [optional]
**DateTime** | **String** | the date of event | [optional]
## Examples
@@ -36,7 +36,7 @@ $IdentityCertified = Initialize-BetaIdentityCertified -CertificationId 2c91808a
-Reviewers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] `
-Signer null `
-EventType IdentityCertified `
-Dt 2019-03-08T22:37:33.901Z
-DateTime 2019-03-08T22:37:33.901Z
```
- Convert the resource to JSON

58
docs/tools/sdk/powershell/Reference/Beta/Models/ListIdentityAccessItems200ResponseInner.md
View File

@@ -16,49 +16,47 @@ tags: ['SDK', 'Software Development Kit', 'ListIdentityAccessItems200ResponseInn
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessType** | **String** | the access item type. role in this case | [optional]
**Id** | **String** | the access item id | [optional]
**Name** | **String** | the access profile name | [optional]
**AccessType** | **String** | the access item type. entitlement in this case | [optional]
**DisplayName** | **String** | the access item display name | [optional]
**SourceName** | **String** | the associated source name if it exists | [optional]
**SourceId** | **String** | the id of the source | [optional]
**Attribute** | **String** | the entitlement attribute | [required]
**Value** | **String** | the associated value | [required]
**Type** | **String** | the type of entitlement | [required]
**Description** | **String** | the description for the role | [optional]
**DisplayName** | **String** | the role display name | [optional]
**EntitlementCount** | **String** | the number of entitlements the account will create | [optional]
**AppDisplayName** | **String** | the name of | [optional]
**RemoveDate** | **String** | the date the role is no longer assigned to the specified identity | [optional]
**Standalone** | **Boolean** | indicates whether the entitlement is standalone | [required]
**Revocable** | **Boolean** | indicates whether the role is revocable | [required]
**NativeIdentity** | **String** | the native identifier used to uniquely identify an acccount | [optional]
**AppRoleId** | **String** | the app role id | [optional]
**Attribute** | **String** | the entitlement attribute | [optional]
**Value** | **String** | the associated value | [optional]
**EntitlementType** | **String** | the type of entitlement | [optional]
**SourceId** | **String** | the id of the source | [optional]
**Standalone** | **Boolean** | indicates whether the access profile is standalone | [required]
**Privileged** | **Boolean** | indicates whether the entitlement is privileged | [required]
**CloudGoverned** | **Boolean** | indicates whether the entitlement is cloud governed | [required]
**EntitlementCount** | **Int32** | the number of entitlements the account will create | [required]
**AppRefs** | [**[]AccessItemAccessProfileResponseAppRefsInner**](access-item-access-profile-response-app-refs-inner) | the list of app ids associated with the access profile | [required]
**RemoveDate** | **String** | the date the role is no longer assigned to the specified identity | [optional]
**Revocable** | **Boolean** | indicates whether the role is revocable | [required]
**NativeIdentity** | **String** | the native identifier used to uniquely identify an acccount | [required]
**AppRoleId** | **String** | the app role id | [required]
## Examples
- Prepare the resource
```powershell
$ListIdentityAccessItems200ResponseInner = Initialize-BetaListIdentityAccessItems200ResponseInner -AccessType role `
-Id 2c918087763e69d901763e72e97f006f `
-Name sample `
-SourceName Source Name `
-SourceId 2793o32dwd `
-Description Role - Workday/Citizenship access `
-DisplayName sample `
-EntitlementCount 12 `
-AppDisplayName AppName `
-RemoveDate 2024-07-01T06:00:00.00Z `
-Standalone true `
-Revocable true `
-NativeIdentity dr.arden.ogahn.d `
-AppRoleId 2c918087763e69d901763e72e97f006f `
$ListIdentityAccessItems200ResponseInner = Initialize-BetaListIdentityAccessItems200ResponseInner -Id 2c918087763e69d901763e72e97f006f `
-AccessType app `
-DisplayName Display Name `
-SourceName appName `
-Attribute groups `
-Value Upward mobility access `
-EntitlementType entitlement `
-Type ENTITLEMENT `
-Description Role - Workday/Citizenship access `
-SourceId 2793o32dwd `
-Standalone false `
-Privileged false `
-CloudGoverned true
-CloudGoverned true `
-EntitlementCount 12 `
-AppRefs [{cloudAppId=8c190e6787aa4ed9a90bd9d5344523fb, cloudAppName=Sample App}, {cloudAppId=2c91808a77ff216301782327a50f09bf, cloudAppName=Another App}] `
-RemoveDate 2024-07-01T06:00:00.00Z `
-Revocable true `
-NativeIdentity dr.arden.ogahn.d `
-AppRoleId 2c918087763e69d901763e72e97f006f
```
- Convert the resource to JSON

69
docs/tools/sdk/powershell/Reference/Beta/Models/ListIdentitySnapshotAccessItems200ResponseInner.md Normal file
View File

@@ -0,0 +1,69 @@
---
id: beta-list-identity-snapshot-access-items200-response-inner
title: ListIdentitySnapshotAccessItems200ResponseInner
pagination_label: ListIdentitySnapshotAccessItems200ResponseInner
sidebar_label: ListIdentitySnapshotAccessItems200ResponseInner
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ListIdentitySnapshotAccessItems200ResponseInner', 'BetaListIdentitySnapshotAccessItems200ResponseInner']
slug: /tools/sdk/powershell/beta/models/list-identity-snapshot-access-items200-response-inner
tags: ['SDK', 'Software Development Kit', 'ListIdentitySnapshotAccessItems200ResponseInner', 'BetaListIdentitySnapshotAccessItems200ResponseInner']
---
# ListIdentitySnapshotAccessItems200ResponseInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | the access item id | [optional]
**AccessType** | **String** | the access item type. role in this case | [optional]
**DisplayName** | **String** | the role display name | [optional]
**SourceName** | **String** | the associated source name if it exists | [optional]
**EntitlementCount** | **Int32** | the number of entitlements the account will create | [required]
**Description** | **String** | the description for the role | [optional]
**SourceId** | **String** | the id of the source | [optional]
**AppRefs** | [**[]AccessItemAccessProfileResponseAppRefsInner**](access-item-access-profile-response-app-refs-inner) | the list of app ids associated with the access profile | [required]
**RemoveDate** | **String** | the date the role is no longer assigned to the specified identity | [optional]
**Standalone** | **Boolean** | indicates whether the entitlement is standalone | [required]
**Revocable** | **Boolean** | indicates whether the role is revocable | [required]
**NativeIdentity** | **String** | the native identifier used to uniquely identify an acccount | [required]
**AppRoleId** | **String** | the app role id | [required]
**Attribute** | **String** | the entitlement attribute | [required]
**Value** | **String** | the associated value | [required]
**Type** | **String** | the type of entitlement | [required]
**Privileged** | **Boolean** | indicates whether the entitlement is privileged | [required]
**CloudGoverned** | **Boolean** | indicates whether the entitlement is cloud governed | [required]
## Examples
- Prepare the resource
```powershell
$ListIdentitySnapshotAccessItems200ResponseInner = Initialize-BetaListIdentitySnapshotAccessItems200ResponseInner -Id 2c918087763e69d901763e72e97f006f `
-AccessType role `
-DisplayName sample `
-SourceName Source Name `
-EntitlementCount 12 `
-Description Role - Workday/Citizenship access `
-SourceId 2793o32dwd `
-AppRefs [{cloudAppId=8c190e6787aa4ed9a90bd9d5344523fb, cloudAppName=Sample App}, {cloudAppId=2c91808a77ff216301782327a50f09bf, cloudAppName=Another App}] `
-RemoveDate 2024-07-01T06:00:00.00Z `
-Standalone true `
-Revocable true `
-NativeIdentity dr.arden.ogahn.d `
-AppRoleId 2c918087763e69d901763e72e97f006f `
-Attribute groups `
-Value Upward mobility access `
-Type ENTITLEMENT `
-Privileged false `
-CloudGoverned true
```
- Convert the resource to JSON
```powershell
$ListIdentitySnapshotAccessItems200ResponseInner | ConvertTo-JSON
```
[[Back to top]](#)

23
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024EntitlementsApi.md
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/v2024/update-entitlements-in-bulk)
@@ -780,6 +787,10 @@ $EntitlementBulkUpdateRequest = @"{
"op" : "replace",
"path" : "/requestable",
"value" : false
}, {
"op" : "replace",
"path" : "/privilegeOverride/overrideLevel",
"value" : "HIGH"
} ]
}"@

8
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityHistoryApi.md
View File

@@ -20,7 +20,7 @@ Method | HTTP request | Description
[**Compare-V2024IdentitySnapshots**](#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-V2024IdentitySnapshotsAccessType**](#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-V2024HistoricalIdentity**](#get-historical-identity) | **GET** `/historical-identities/{id}` | Get latest snapshot of identity
[**Get-V2024HistoricalIdentityEvents**](#get-historical-identity-events) | **GET** `/historical-identities/{id}/events` | Lists all events for the given identity
[**Get-V2024HistoricalIdentityEvents**](#get-historical-identity-events) | **GET** `/historical-identities/{id}/events` | List identity event history
[**Get-V2024IdentitySnapshot**](#get-identity-snapshot) | **GET** `/historical-identities/{id}/snapshots/{date}` | Gets an identity snapshot at a given date
[**Get-V2024IdentitySnapshotSummary**](#get-identity-snapshot-summary) | **GET** `/historical-identities/{id}/snapshot-summary` | Gets the summary for the event count for a specific identity
[**Get-V2024IdentityStartDate**](#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-V2024HistoricalIdentityEvents -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

28
docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemAccessProfileResponse.md
View File

@@ -16,32 +16,30 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemAccessProfileResponse', 'V2
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessType** | **String** | the access item type. accessProfile in this case | [optional]
**Id** | **String** | the access item id | [optional]
**Name** | **String** | the access profile name | [optional]
**SourceName** | **String** | the name of the source | [optional]
**SourceId** | **String** | the id of the source | [optional]
**Description** | **String** | the description for the access profile | [optional]
**AccessType** | **String** | the access item type. accessProfile in this case | [optional]
**DisplayName** | **String** | the display name of the identity | [optional]
**EntitlementCount** | **String** | the number of entitlements the access profile will create | [optional]
**AppDisplayName** | **String** | the name of | [optional]
**SourceName** | **String** | the name of the source | [optional]
**EntitlementCount** | **Int32** | the number of entitlements the access profile will create | [required]
**Description** | **String** | the description for the access profile | [optional]
**SourceId** | **String** | the id of the source | [optional]
**AppRefs** | [**[]AccessItemAccessProfileResponseAppRefsInner**](access-item-access-profile-response-app-refs-inner) | the list of app ids associated with the access profile | [required]
**RemoveDate** | **String** | the date the access profile is no longer assigned to the specified identity | [optional]
**Standalone** | **Boolean** | indicates whether the access profile is standalone | [required]
**Revocable** | **Boolean** | indicates whether the access profile is | [required]
**Revocable** | **Boolean** | indicates whether the access profile is revocable | [required]
## Examples
- Prepare the resource
```powershell
$AccessItemAccessProfileResponse = Initialize-V2024AccessItemAccessProfileResponse -AccessType accessProfile `
-Id 2c918087763e69d901763e72e97f006f `
-Name sample `
-SourceName DataScienceDataset `
-SourceId 2793o32dwd `
-Description AccessProfile - Workday/Citizenship access `
$AccessItemAccessProfileResponse = Initialize-V2024AccessItemAccessProfileResponse -Id 2c918087763e69d901763e72e97f006f `
-AccessType accessProfile `
-DisplayName Dr. Arden Rogahn MD `
-SourceName DataScienceDataset `
-EntitlementCount 12 `
-AppDisplayName AppName `
-Description AccessProfile - Workday/Citizenship access `
-SourceId 2793o32dwd `
-AppRefs [{cloudAppId=8c190e6787aa4ed9a90bd9d5344523fb, cloudAppName=Sample App}, {cloudAppId=2c91808a77ff216301782327a50f09bf, cloudAppName=Another App}] `
-RemoveDate 2024-07-01T06:00:00.00Z `
-Standalone false `
-Revocable true

37
docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemAccessProfileResponseAppRefsInner.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: v2024-access-item-access-profile-response-app-refs-inner
title: AccessItemAccessProfileResponseAppRefsInner
pagination_label: AccessItemAccessProfileResponseAppRefsInner
sidebar_label: AccessItemAccessProfileResponseAppRefsInner
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemAccessProfileResponseAppRefsInner', 'V2024AccessItemAccessProfileResponseAppRefsInner']
slug: /tools/sdk/powershell/v2024/models/access-item-access-profile-response-app-refs-inner
tags: ['SDK', 'Software Development Kit', 'AccessItemAccessProfileResponseAppRefsInner', 'V2024AccessItemAccessProfileResponseAppRefsInner']
---
# AccessItemAccessProfileResponseAppRefsInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**CloudAppId** | **String** | the cloud app id associated with the access profile | [optional]
**CloudAppName** | **String** | the cloud app name associated with the access profile | [optional]
## Examples
- Prepare the resource
```powershell
$AccessItemAccessProfileResponseAppRefsInner = Initialize-V2024AccessItemAccessProfileResponseAppRefsInner -CloudAppId 8c190e6787aa4ed9a90bd9d5344523fb `
-CloudAppName Sample App
```
- Convert the resource to JSON
```powershell
$AccessItemAccessProfileResponseAppRefsInner | ConvertTo-JSON
```
[[Back to top]](#)

20
docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemAccountResponse.md
View File

@@ -16,25 +16,25 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemAccountResponse', 'V2024Acc
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessType** | **String** | the access item type. account in this case | [optional]
**Id** | **String** | the access item id | [optional]
**NativeIdentity** | **String** | the native identifier used to uniquely identify an acccount | [optional]
**SourceName** | **String** | the name of the source | [optional]
**SourceId** | **String** | the id of the source | [optional]
**EntitlementCount** | **String** | the number of entitlements the account will create | [optional]
**AccessType** | **String** | the access item type. account in this case | [optional]
**DisplayName** | **String** | the display name of the identity | [optional]
**SourceName** | **String** | the name of the source | [optional]
**NativeIdentity** | **String** | the native identifier used to uniquely identify an acccount | [required]
**SourceId** | **String** | the id of the source | [optional]
**EntitlementCount** | **Int32** | the number of entitlements the account will create | [optional]
## Examples
- Prepare the resource
```powershell
$AccessItemAccountResponse = Initialize-V2024AccessItemAccountResponse -AccessType account `
-Id 2c918087763e69d901763e72e97f006f `
-NativeIdentity dr.arden.ogahn.d `
$AccessItemAccountResponse = Initialize-V2024AccessItemAccountResponse -Id 2c918087763e69d901763e72e97f006f `
-AccessType account `
-DisplayName Dr. Arden Rogahn MD `
-SourceName DataScienceDataset `
-NativeIdentity dr.arden.ogahn.d `
-SourceId 2793o32dwd `
-EntitlementCount 12 `
-DisplayName Dr. Arden Rogahn MD
-EntitlementCount 12
```
- Convert the resource to JSON

8
docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemAppResponse.md
View File

@@ -16,18 +16,18 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemAppResponse', 'V2024AccessI
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessType** | **String** | the access item type. entitlement in this case | [optional]
**Id** | **String** | the access item id | [optional]
**AccessType** | **String** | the access item type. entitlement in this case | [optional]
**DisplayName** | **String** | the access item display name | [optional]
**SourceName** | **String** | the associated source name if it exists | [optional]
**AppRoleId** | **String** | the app role id | [optional]
**AppRoleId** | **String** | the app role id | [required]
## Examples
- Prepare the resource
```powershell
$AccessItemAppResponse = Initialize-V2024AccessItemAppResponse -AccessType app `
-Id 2c918087763e69d901763e72e97f006f `
$AccessItemAppResponse = Initialize-V2024AccessItemAppResponse -Id 2c918087763e69d901763e72e97f006f `
-AccessType app `
-DisplayName Display Name `
-SourceName appName `
-AppRoleId 2c918087763e69d901763e72e97f006f

18
docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemAssociated.md
View File

@@ -16,21 +16,23 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemAssociated', 'V2024AccessIt
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessItem** | [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional]
**IdentityId** | **String** | the identity id | [optional]
**EventType** | **String** | the event type | [optional]
**Dt** | **String** | the date of event | [optional]
**GovernanceEvent** | [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [optional]
**DateTime** | **String** | the date of event | [optional]
**IdentityId** | **String** | the identity id | [optional]
**AccessItem** | [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [required]
**GovernanceEvent** | [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [required]
**AccessItemType** | **Enum** [ "account", "app", "entitlement", "role", "accessProfile" ] | the access item type | [optional]
## Examples
- Prepare the resource
```powershell
$AccessItemAssociated = Initialize-V2024AccessItemAssociated -AccessItem null `
$AccessItemAssociated = Initialize-V2024AccessItemAssociated -EventType AccessItemAssociated `
-DateTime 2019-03-08T22:37:33.901Z `
-IdentityId 8c190e6787aa4ed9a90bd9d5344523fb `
-EventType AccessItemAssociated `
-Dt 2019-03-08T22:37:33.901Z `
-GovernanceEvent null
-AccessItem null `
-GovernanceEvent null `
-AccessItemType account
```
- Convert the resource to JSON

58
docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemAssociatedAccessItem.md
View File

@@ -16,49 +16,47 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemAssociatedAccessItem', 'V20
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessType** | **String** | the access item type. role in this case | [optional]
**Id** | **String** | the access item id | [optional]
**Name** | **String** | the access profile name | [optional]
**AccessType** | **String** | the access item type. entitlement in this case | [optional]
**DisplayName** | **String** | the access item display name | [optional]
**SourceName** | **String** | the associated source name if it exists | [optional]
**SourceId** | **String** | the id of the source | [optional]
**Attribute** | **String** | the entitlement attribute | [required]
**Value** | **String** | the associated value | [required]
**Type** | **String** | the type of entitlement | [required]
**Description** | **String** | the description for the role | [optional]
**DisplayName** | **String** | the role display name | [optional]
**EntitlementCount** | **String** | the number of entitlements the account will create | [optional]
**AppDisplayName** | **String** | the name of | [optional]
**RemoveDate** | **String** | the date the role is no longer assigned to the specified identity | [optional]
**Standalone** | **Boolean** | indicates whether the entitlement is standalone | [required]
**Revocable** | **Boolean** | indicates whether the role is revocable | [required]
**NativeIdentity** | **String** | the native identifier used to uniquely identify an acccount | [optional]
**AppRoleId** | **String** | the app role id | [optional]
**Attribute** | **String** | the entitlement attribute | [optional]
**Value** | **String** | the associated value | [optional]
**EntitlementType** | **String** | the type of entitlement | [optional]
**SourceId** | **String** | the id of the source | [optional]
**Standalone** | **Boolean** | indicates whether the access profile is standalone | [required]
**Privileged** | **Boolean** | indicates whether the entitlement is privileged | [required]
**CloudGoverned** | **Boolean** | indicates whether the entitlement is cloud governed | [required]
**EntitlementCount** | **Int32** | the number of entitlements the account will create | [required]
**AppRefs** | [**[]AccessItemAccessProfileResponseAppRefsInner**](access-item-access-profile-response-app-refs-inner) | the list of app ids associated with the access profile | [required]
**RemoveDate** | **String** | the date the role is no longer assigned to the specified identity | [optional]
**Revocable** | **Boolean** | indicates whether the role is revocable | [required]
**NativeIdentity** | **String** | the native identifier used to uniquely identify an acccount | [required]
**AppRoleId** | **String** | the app role id | [required]
## Examples
- Prepare the resource
```powershell
$AccessItemAssociatedAccessItem = Initialize-V2024AccessItemAssociatedAccessItem -AccessType role `
-Id 2c918087763e69d901763e72e97f006f `
-Name sample `
-SourceName Source Name `
-SourceId 2793o32dwd `
-Description Role - Workday/Citizenship access `
-DisplayName sample `
-EntitlementCount 12 `
-AppDisplayName AppName `
-RemoveDate 2024-07-01T06:00:00.00Z `
-Standalone true `
-Revocable true `
-NativeIdentity dr.arden.ogahn.d `
-AppRoleId 2c918087763e69d901763e72e97f006f `
$AccessItemAssociatedAccessItem = Initialize-V2024AccessItemAssociatedAccessItem -Id 2c918087763e69d901763e72e97f006f `
-AccessType app `
-DisplayName Display Name `
-SourceName appName `
-Attribute groups `
-Value Upward mobility access `
-EntitlementType entitlement `
-Type ENTITLEMENT `
-Description Role - Workday/Citizenship access `
-SourceId 2793o32dwd `
-Standalone false `
-Privileged false `
-CloudGoverned true
-CloudGoverned true `
-EntitlementCount 12 `
-AppRefs [{cloudAppId=8c190e6787aa4ed9a90bd9d5344523fb, cloudAppName=Sample App}, {cloudAppId=2c91808a77ff216301782327a50f09bf, cloudAppName=Another App}] `
-RemoveDate 2024-07-01T06:00:00.00Z `
-Revocable true `
-NativeIdentity dr.arden.ogahn.d `
-AppRoleId 2c918087763e69d901763e72e97f006f
```
- Convert the resource to JSON

26
docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemEntitlementResponse.md
View File

@@ -16,15 +16,15 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemEntitlementResponse', 'V202
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessType** | **String** | the access item type. entitlement in this case | [optional]
**Id** | **String** | the access item id | [optional]
**Attribute** | **String** | the entitlement attribute | [optional]
**Value** | **String** | the associated value | [optional]
**EntitlementType** | **String** | the type of entitlement | [optional]
**SourceName** | **String** | the name of the source | [optional]
**SourceId** | **String** | the id of the source | [optional]
**Description** | **String** | the description for the entitlment | [optional]
**AccessType** | **String** | the access item type. entitlement in this case | [optional]
**DisplayName** | **String** | the display name of the identity | [optional]
**SourceName** | **String** | the name of the source | [optional]
**Attribute** | **String** | the entitlement attribute | [required]
**Value** | **String** | the associated value | [required]
**Type** | **String** | the type of entitlement | [required]
**Description** | **String** | the description for the entitlment | [optional]
**SourceId** | **String** | the id of the source | [optional]
**Standalone** | **Boolean** | indicates whether the entitlement is standalone | [required]
**Privileged** | **Boolean** | indicates whether the entitlement is privileged | [required]
**CloudGoverned** | **Boolean** | indicates whether the entitlement is cloud governed | [required]
@@ -33,15 +33,15 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$AccessItemEntitlementResponse = Initialize-V2024AccessItemEntitlementResponse -AccessType entitlement `
-Id 2c918087763e69d901763e72e97f006f `
$AccessItemEntitlementResponse = Initialize-V2024AccessItemEntitlementResponse -Id 2c918087763e69d901763e72e97f006f `
-AccessType entitlement `
-DisplayName Dr. Arden Rogahn MD `
-SourceName DataScienceDataset `
-Attribute groups `
-Value Upward mobility access `
-EntitlementType entitlement `
-SourceName DataScienceDataset `
-SourceId 2793o32dwd `
-Type ENTITLEMENT `
-Description Entitlement - Workday/Citizenship access `
-DisplayName Dr. Arden Rogahn MD `
-SourceId 2793o32dwd `
-Standalone true `
-Privileged false `
-CloudGoverned true

8
docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemRemoved.md
View File

@@ -16,10 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemRemoved', 'V2024AccessItemR
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessItem** | [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional]
**AccessItem** | [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [required]
**IdentityId** | **String** | the identity id | [optional]
**EventType** | **String** | the event type | [optional]
**Dt** | **String** | the date of event | [optional]
**DateTime** | **String** | the date of event | [optional]
**AccessItemType** | **Enum** [ "account", "app", "entitlement", "role", "accessProfile" ] | the access item type | [optional]
**GovernanceEvent** | [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [optional]
## Examples
@@ -29,7 +30,8 @@ Name | Type | Description | Notes
$AccessItemRemoved = Initialize-V2024AccessItemRemoved -AccessItem null `
-IdentityId 8c190e6787aa4ed9a90bd9d5344523fb `
-EventType AccessItemRemoved `
-Dt 2019-03-08T22:37:33.901Z `
-DateTime 2019-03-08T22:37:33.901Z `
-AccessItemType account `
-GovernanceEvent null
```

10
docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemRoleResponse.md
View File

@@ -16,11 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemRoleResponse', 'V2024Access
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessType** | **String** | the access item type. role in this case | [optional]
**Id** | **String** | the access item id | [optional]
**AccessType** | **String** | the access item type. role in this case | [optional]
**DisplayName** | **String** | the role display name | [optional]
**Description** | **String** | the description for the role | [optional]
**SourceName** | **String** | the associated source name if it exists | [optional]
**Description** | **String** | the description for the role | [optional]
**RemoveDate** | **String** | the date the role is no longer assigned to the specified identity | [optional]
**Revocable** | **Boolean** | indicates whether the role is revocable | [required]
@@ -28,11 +28,11 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$AccessItemRoleResponse = Initialize-V2024AccessItemRoleResponse -AccessType role `
-Id 2c918087763e69d901763e72e97f006f `
$AccessItemRoleResponse = Initialize-V2024AccessItemRoleResponse -Id 2c918087763e69d901763e72e97f006f `
-AccessType role `
-DisplayName sample `
-Description Role - Workday/Citizenship access `
-SourceName Source Name `
-Description Role - Workday/Citizenship access `
-RemoveDate 2024-07-01T06:00:00.00Z `
-Revocable true
```

49
docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestItemResponse.md
View File

@@ -1,49 +0,0 @@
---
id: v2024-access-request-item-response
title: AccessRequestItemResponse
pagination_label: AccessRequestItemResponse
sidebar_label: AccessRequestItemResponse
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestItemResponse', 'V2024AccessRequestItemResponse']
slug: /tools/sdk/powershell/v2024/models/access-request-item-response
tags: ['SDK', 'Software Development Kit', 'AccessRequestItemResponse', 'V2024AccessRequestItemResponse']
---
# AccessRequestItemResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Operation** | **String** | the access request item operation | [optional]
**AccessItemType** | **String** | the access item type | [optional]
**Name** | **String** | the name of access request item | [optional]
**Decision** | **Enum** [ "APPROVED", "REJECTED" ] | the final decision for the access request | [optional]
**Description** | **String** | the description of access request item | [optional]
**SourceId** | **String** | the source id | [optional]
**SourceName** | **String** | the source Name | [optional]
**ApprovalInfos** | [**[]ApprovalInfoResponse**](approval-info-response) | | [optional]
## Examples
- Prepare the resource
```powershell
$AccessRequestItemResponse = Initialize-V2024AccessRequestItemResponse -Operation Add `
-AccessItemType role `
-Name Role-1 `
-Decision APPROVED `
-Description The role descrition `
-SourceId 8a80828f643d484f01643e14202e206f `
-SourceName Source1 `
-ApprovalInfos [{name=John Snow, id=8a80828f643d484f01643e14202e2000, status=Approved}]
```
- Convert the resource to JSON
```powershell
$AccessRequestItemResponse | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestResponse1.md
View File

@@ -1,39 +0,0 @@
---
id: v2024-access-request-response1
title: AccessRequestResponse1
pagination_label: AccessRequestResponse1
sidebar_label: AccessRequestResponse1
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestResponse1', 'V2024AccessRequestResponse1']
slug: /tools/sdk/powershell/v2024/models/access-request-response1
tags: ['SDK', 'Software Development Kit', 'AccessRequestResponse1', 'V2024AccessRequestResponse1']
---
# AccessRequestResponse1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**RequesterId** | **String** | the requester Id | [optional]
**RequesterName** | **String** | the requesterName | [optional]
**Items** | [**[]AccessRequestItemResponse**](access-request-item-response) | | [optional]
## Examples
- Prepare the resource
```powershell
$AccessRequestResponse1 = Initialize-V2024AccessRequestResponse1 -RequesterId 2c91808a77ff216301782327a50f09bf `
-RequesterName Bing C `
-Items [{operation=Add, accessItemType=role, name=Role-1, decision=APPROVED, description=The role descrition, sourceId=8a80828f643d484f01643e14202e206f, sourceName=Source1, approvalInfos=[{name=John Snow, id=8a80828f643d484f01643e14202e2000, status=Approved}]}]
```
- Convert the resource to JSON
```powershell
$AccessRequestResponse1 | ConvertTo-JSON
```
[[Back to top]](#)

14
docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequested.md
View File

@@ -16,19 +16,21 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequested', 'V2024AccessRequest
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessRequest** | [**AccessRequestResponse1**](access-request-response1) | | [optional]
**IdentityId** | **String** | the identity id | [optional]
**EventType** | **String** | the event type | [optional]
**Dt** | **String** | the date of event | [optional]
**IdentityId** | **String** | the identity id | [optional]
**DateTime** | **String** | the date of event | [optional]
**Account** | [**AccessRequestedAccount**](access-requested-account) | | [required]
**StatusChange** | [**AccessRequestedStatusChange**](access-requested-status-change) | | [required]
## Examples
- Prepare the resource
```powershell
$AccessRequested = Initialize-V2024AccessRequested -AccessRequest null `
$AccessRequested = Initialize-V2024AccessRequested -EventType AccountStatusChanged `
-IdentityId 8a80828f643d484f01643e14202e206f `
-EventType AccessRequested `
-Dt 2019-03-08T22:37:33.901Z
-DateTime 2019-03-08T22:37:33.901Z `
-Account null `
-StatusChange null
```
- Convert the resource to JSON

32
docs/tools/sdk/powershell/Reference/V2024/Models/AccountStatusChangedAccount.md → docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestedAccount.md
View File

@@ -1,16 +1,16 @@
---
id: v2024-account-status-changed-account
title: AccountStatusChangedAccount
pagination_label: AccountStatusChangedAccount
sidebar_label: AccountStatusChangedAccount
id: v2024-access-requested-account
title: AccessRequestedAccount
pagination_label: AccessRequestedAccount
sidebar_label: AccessRequestedAccount
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountStatusChangedAccount', 'V2024AccountStatusChangedAccount']
slug: /tools/sdk/powershell/v2024/models/account-status-changed-account
tags: ['SDK', 'Software Development Kit', 'AccountStatusChangedAccount', 'V2024AccountStatusChangedAccount']
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestedAccount', 'V2024AccessRequestedAccount']
slug: /tools/sdk/powershell/v2024/models/access-requested-account
tags: ['SDK', 'Software Development Kit', 'AccessRequestedAccount', 'V2024AccessRequestedAccount']
---
# AccountStatusChangedAccount
# AccessRequestedAccount
## Properties
@@ -28,18 +28,18 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$AccountStatusChangedAccount = Initialize-V2024AccountStatusChangedAccount -Id null `
-NativeIdentity null `
-DisplayName null `
-SourceId null `
-SourceName null `
-EntitlementCount null `
-AccessType null
$AccessRequestedAccount = Initialize-V2024AccessRequestedAccount -Id 2c91808a77ff216301782327a50f09bf `
-NativeIdentity dr.arden.ogahn.d `
-DisplayName Adam Archer `
-SourceId 8a80828f643d484f01643e14202e206f `
-SourceName JDBC Entitlements Source `
-EntitlementCount 2 `
-AccessType account
```
- Convert the resource to JSON
```powershell
$AccountStatusChangedAccount | ConvertTo-JSON
$AccessRequestedAccount | ConvertTo-JSON
```

37
docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestedStatusChange.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: v2024-access-requested-status-change
title: AccessRequestedStatusChange
pagination_label: AccessRequestedStatusChange
sidebar_label: AccessRequestedStatusChange
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessRequestedStatusChange', 'V2024AccessRequestedStatusChange']
slug: /tools/sdk/powershell/v2024/models/access-requested-status-change
tags: ['SDK', 'Software Development Kit', 'AccessRequestedStatusChange', 'V2024AccessRequestedStatusChange']
---
# AccessRequestedStatusChange
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**PreviousStatus** | **Enum** [ "enabled", "disabled", "locked" ] | the previous status of the account | [optional]
**NewStatus** | **Enum** [ "enabled", "disabled", "locked" ] | the new status of the account | [optional]
## Examples
- Prepare the resource
```powershell
$AccessRequestedStatusChange = Initialize-V2024AccessRequestedStatusChange -PreviousStatus enabled `
-NewStatus disabled
```
- Convert the resource to JSON
```powershell
$AccessRequestedStatusChange | ConvertTo-JSON
```
[[Back to top]](#)

12
docs/tools/sdk/powershell/Reference/V2024/Models/AccountStatusChanged.md
View File

@@ -18,17 +18,17 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**EventType** | **String** | the event type | [optional]
**IdentityId** | **String** | the identity id | [optional]
**Dt** | **String** | the date of event | [optional]
**Account** | [**AccountStatusChangedAccount**](account-status-changed-account) | | [optional]
**StatusChange** | [**AccountStatusChangedStatusChange**](account-status-changed-status-change) | | [optional]
**DateTime** | **String** | the date of event | [optional]
**Account** | [**AccessRequestedAccount**](access-requested-account) | | [required]
**StatusChange** | [**AccessRequestedStatusChange**](access-requested-status-change) | | [required]
## Examples
- Prepare the resource
```powershell
$AccountStatusChanged = Initialize-V2024AccountStatusChanged -EventType null `
-IdentityId null `
-Dt null `
$AccountStatusChanged = Initialize-V2024AccountStatusChanged -EventType AccountStatusChanged `
-IdentityId 8a80828f643d484f01643e14202e206f `
-DateTime 2019-03-08T22:37:33.901Z `
-Account null `
-StatusChange null
```

37
docs/tools/sdk/powershell/Reference/V2024/Models/AccountStatusChangedStatusChange.md
View File

@@ -1,37 +0,0 @@
---
id: v2024-account-status-changed-status-change
title: AccountStatusChangedStatusChange
pagination_label: AccountStatusChangedStatusChange
sidebar_label: AccountStatusChangedStatusChange
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccountStatusChangedStatusChange', 'V2024AccountStatusChangedStatusChange']
slug: /tools/sdk/powershell/v2024/models/account-status-changed-status-change
tags: ['SDK', 'Software Development Kit', 'AccountStatusChangedStatusChange', 'V2024AccountStatusChangedStatusChange']
---
# AccountStatusChangedStatusChange
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**PreviousStatus** | **Enum** [ "enabled", "disabled", "locked" ] | the previous status of the account | [optional]
**NewStatus** | **Enum** [ "enabled", "disabled", "locked" ] | the new status of the account | [optional]
## Examples
- Prepare the resource
```powershell
$AccountStatusChangedStatusChange = Initialize-V2024AccountStatusChangedStatusChange -PreviousStatus null `
-NewStatus null
```
- Convert the resource to JSON
```powershell
$AccountStatusChangedStatusChange | ConvertTo-JSON
```
[[Back to top]](#)

39
docs/tools/sdk/powershell/Reference/V2024/Models/ApprovalInfoResponse.md
View File

@@ -1,39 +0,0 @@
---
id: v2024-approval-info-response
title: ApprovalInfoResponse
pagination_label: ApprovalInfoResponse
sidebar_label: ApprovalInfoResponse
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ApprovalInfoResponse', 'V2024ApprovalInfoResponse']
slug: /tools/sdk/powershell/v2024/models/approval-info-response
tags: ['SDK', 'Software Development Kit', 'ApprovalInfoResponse', 'V2024ApprovalInfoResponse']
---
# ApprovalInfoResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | the id of approver | [optional]
**Name** | **String** | the name of approver | [optional]
**Status** | **String** | the status of the approval request | [optional]
## Examples
- Prepare the resource
```powershell
$ApprovalInfoResponse = Initialize-V2024ApprovalInfoResponse -Id 8a80828f643d484f01643e14202e2000 `
-Name John Snow `
-Status Approved
```
- Convert the resource to JSON
```powershell
$ApprovalInfoResponse | ConvertTo-JSON
```
[[Back to top]](#)

6
docs/tools/sdk/powershell/Reference/V2024/Models/AttributeChange.md
View File

@@ -24,9 +24,9 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$AttributeChange = Initialize-V2024AttributeChange -Name null `
-PreviousValue null `
-NewValue null
$AttributeChange = Initialize-V2024AttributeChange -Name firstname `
-PreviousValue adam `
-NewValue zampa
```
- Convert the resource to JSON

12
docs/tools/sdk/powershell/Reference/V2024/Models/AttributesChanged.md
View File

@@ -16,19 +16,19 @@ tags: ['SDK', 'Software Development Kit', 'AttributesChanged', 'V2024AttributesC
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Changes** | [**[]AttributeChange**](attribute-change) | | [optional]
**AttributeChanges** | [**[]AttributeChange**](attribute-change) | | [required]
**EventType** | **String** | the event type | [optional]
**IdentityId** | **String** | the identity id | [optional]
**Dt** | **String** | the date of event | [optional]
**DateTime** | **String** | the date of event | [optional]
## Examples
- Prepare the resource
```powershell
$AttributesChanged = Initialize-V2024AttributesChanged -Changes null `
-EventType null `
-IdentityId null `
-Dt null
$AttributesChanged = Initialize-V2024AttributesChanged -AttributeChanges null `
-EventType AttributesChanged `
-IdentityId 8c190e6787aa4ed9a90bd9d5344523fb `
-DateTime 2019-03-08T22:37:33.901Z
```
- Convert the resource to JSON

4
docs/tools/sdk/powershell/Reference/V2024/Models/CorrelatedGovernanceEvent.md
View File

@@ -17,7 +17,7 @@ tags: ['SDK', 'Software Development Kit', 'CorrelatedGovernanceEvent', 'V2024Cor
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Name** | **String** | The name of the governance event, such as the certification name or access request ID. | [optional]
**Dt** | **String** | The date that the certification or access request was completed. | [optional]
**DateTime** | **String** | The date that the certification or access request was completed. | [optional]
**Type** | **Enum** [ "certification", "accessRequest" ] | The type of governance event. | [optional]
**GovernanceId** | **String** | The ID of the instance that caused the event - either the certification ID or access request ID. | [optional]
**Owners** | [**[]CertifierResponse**](certifier-response) | The owners of the governance event (the certifiers or approvers) | [optional]
@@ -29,7 +29,7 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$CorrelatedGovernanceEvent = Initialize-V2024CorrelatedGovernanceEvent -Name Manager Certification for Jon Snow `
-Dt 2019-03-08T22:37:33.901Z `
-DateTime 2019-03-08T22:37:33.901Z `
-Type certification `
-GovernanceId 2c91808a77ff216301782327a50f09bf `
-Owners [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] `

2
docs/tools/sdk/powershell/Reference/V2024/Models/EntitlementBulkUpdateRequest.md
View File

@@ -24,7 +24,7 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$EntitlementBulkUpdateRequest = Initialize-V2024EntitlementBulkUpdateRequest -EntitlementIds [2c91808a7624751a01762f19d665220d, 2c91808a7624751a01762f19d67c220e, 2c91808a7624751a01762f19d692220f] `
-JsonPatch [{op=replace, path=/privileged, value=false}, {op=replace, path=/requestable, value=false}]
-JsonPatch [{op=replace, path=/privileged, value=false}, {op=replace, path=/requestable, value=false}, {op=replace, path=/privilegeOverride/overrideLevel, value=HIGH}]
```
- Convert the resource to JSON

38
docs/tools/sdk/powershell/Reference/V2024/Models/GetHistoricalIdentityEvents200ResponseInner.md
View File

@@ -16,39 +16,39 @@ tags: ['SDK', 'Software Development Kit', 'GetHistoricalIdentityEvents200Respons
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessItem** | [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional]
**IdentityId** | **String** | the identity id | [optional]
**EventType** | **String** | the event type | [optional]
**Dt** | **String** | the date of event | [optional]
**GovernanceEvent** | [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [optional]
**Changes** | [**[]AttributeChange**](attribute-change) | | [optional]
**AccessRequest** | [**AccessRequestResponse1**](access-request-response1) | | [optional]
**CertificationId** | **String** | the id of the certification item | [optional]
**CertificationName** | **String** | the certification item name | [optional]
**CertificationId** | **String** | the id of the certification item | [required]
**CertificationName** | **String** | the certification item name | [required]
**SignedDate** | **String** | the date ceritification was signed | [optional]
**Certifiers** | [**[]CertifierResponse**](certifier-response) | this field is deprecated and may go away | [optional]
**Reviewers** | [**[]CertifierResponse**](certifier-response) | The list of identities who review this certification | [optional]
**Signer** | [**CertifierResponse**](certifier-response) | | [optional]
**Account** | [**AccountStatusChangedAccount**](account-status-changed-account) | | [optional]
**StatusChange** | [**AccountStatusChangedStatusChange**](account-status-changed-status-change) | | [optional]
**EventType** | **String** | the event type | [optional]
**DateTime** | **String** | the date of event | [optional]
**IdentityId** | **String** | the identity id | [optional]
**AccessItem** | [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [required]
**GovernanceEvent** | [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [required]
**AccessItemType** | **Enum** [ "account", "app", "entitlement", "role", "accessProfile" ] | the access item type | [optional]
**AttributeChanges** | [**[]AttributeChange**](attribute-change) | | [required]
**Account** | [**AccessRequestedAccount**](access-requested-account) | | [required]
**StatusChange** | [**AccessRequestedStatusChange**](access-requested-status-change) | | [required]
## Examples
- Prepare the resource
```powershell
$GetHistoricalIdentityEvents200ResponseInner = Initialize-V2024GetHistoricalIdentityEvents200ResponseInner -AccessItem null `
-IdentityId null `
-EventType null `
-Dt null `
-GovernanceEvent null `
-Changes null `
-AccessRequest null `
-CertificationId 2c91808a77ff216301782327a50f09bf `
$GetHistoricalIdentityEvents200ResponseInner = Initialize-V2024GetHistoricalIdentityEvents200ResponseInner -CertificationId 2c91808a77ff216301782327a50f09bf `
-CertificationName Cert name `
-SignedDate 2019-03-08T22:37:33.901Z `
-Certifiers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] `
-Reviewers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] `
-Signer null `
-EventType AccountStatusChanged `
-DateTime 2019-03-08T22:37:33.901Z `
-IdentityId 8a80828f643d484f01643e14202e206f `
-AccessItem null `
-GovernanceEvent null `
-AccessItemType account `
-AttributeChanges null `
-Account null `
-StatusChange null
```

8
docs/tools/sdk/powershell/Reference/V2024/Models/IdentityCertified.md
View File

@@ -16,14 +16,14 @@ tags: ['SDK', 'Software Development Kit', 'IdentityCertified', 'V2024IdentityCer
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**CertificationId** | **String** | the id of the certification item | [optional]
**CertificationName** | **String** | the certification item name | [optional]
**CertificationId** | **String** | the id of the certification item | [required]
**CertificationName** | **String** | the certification item name | [required]
**SignedDate** | **String** | the date ceritification was signed | [optional]
**Certifiers** | [**[]CertifierResponse**](certifier-response) | this field is deprecated and may go away | [optional]
**Reviewers** | [**[]CertifierResponse**](certifier-response) | The list of identities who review this certification | [optional]
**Signer** | [**CertifierResponse**](certifier-response) | | [optional]
**EventType** | **String** | the event type | [optional]
**Dt** | **String** | the date of event | [optional]
**DateTime** | **String** | the date of event | [optional]
## Examples
@@ -36,7 +36,7 @@ $IdentityCertified = Initialize-V2024IdentityCertified -CertificationId 2c91808
-Reviewers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] `
-Signer null `
-EventType IdentityCertified `
-Dt 2019-03-08T22:37:33.901Z
-DateTime 2019-03-08T22:37:33.901Z
```
- Convert the resource to JSON

58
docs/tools/sdk/powershell/Reference/V2024/Models/ListIdentityAccessItems200ResponseInner.md
View File

@@ -16,49 +16,47 @@ tags: ['SDK', 'Software Development Kit', 'ListIdentityAccessItems200ResponseInn
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessType** | **String** | the access item type. role in this case | [optional]
**Id** | **String** | the access item id | [optional]
**Name** | **String** | the access profile name | [optional]
**AccessType** | **String** | the access item type. entitlement in this case | [optional]
**DisplayName** | **String** | the access item display name | [optional]
**SourceName** | **String** | the associated source name if it exists | [optional]
**SourceId** | **String** | the id of the source | [optional]
**Attribute** | **String** | the entitlement attribute | [required]
**Value** | **String** | the associated value | [required]
**Type** | **String** | the type of entitlement | [required]
**Description** | **String** | the description for the role | [optional]
**DisplayName** | **String** | the role display name | [optional]
**EntitlementCount** | **String** | the number of entitlements the account will create | [optional]
**AppDisplayName** | **String** | the name of | [optional]
**RemoveDate** | **String** | the date the role is no longer assigned to the specified identity | [optional]
**Standalone** | **Boolean** | indicates whether the entitlement is standalone | [required]
**Revocable** | **Boolean** | indicates whether the role is revocable | [required]
**NativeIdentity** | **String** | the native identifier used to uniquely identify an acccount | [optional]
**AppRoleId** | **String** | the app role id | [optional]
**Attribute** | **String** | the entitlement attribute | [optional]
**Value** | **String** | the associated value | [optional]
**EntitlementType** | **String** | the type of entitlement | [optional]
**SourceId** | **String** | the id of the source | [optional]
**Standalone** | **Boolean** | indicates whether the access profile is standalone | [required]
**Privileged** | **Boolean** | indicates whether the entitlement is privileged | [required]
**CloudGoverned** | **Boolean** | indicates whether the entitlement is cloud governed | [required]
**EntitlementCount** | **Int32** | the number of entitlements the account will create | [required]
**AppRefs** | [**[]AccessItemAccessProfileResponseAppRefsInner**](access-item-access-profile-response-app-refs-inner) | the list of app ids associated with the access profile | [required]
**RemoveDate** | **String** | the date the role is no longer assigned to the specified identity | [optional]
**Revocable** | **Boolean** | indicates whether the role is revocable | [required]
**NativeIdentity** | **String** | the native identifier used to uniquely identify an acccount | [required]
**AppRoleId** | **String** | the app role id | [required]
## Examples
- Prepare the resource
```powershell
$ListIdentityAccessItems200ResponseInner = Initialize-V2024ListIdentityAccessItems200ResponseInner -AccessType role `
-Id 2c918087763e69d901763e72e97f006f `
-Name sample `
-SourceName Source Name `
-SourceId 2793o32dwd `
-Description Role - Workday/Citizenship access `
-DisplayName sample `
-EntitlementCount 12 `
-AppDisplayName AppName `
-RemoveDate 2024-07-01T06:00:00.00Z `
-Standalone true `
-Revocable true `
-NativeIdentity dr.arden.ogahn.d `
-AppRoleId 2c918087763e69d901763e72e97f006f `
$ListIdentityAccessItems200ResponseInner = Initialize-V2024ListIdentityAccessItems200ResponseInner -Id 2c918087763e69d901763e72e97f006f `
-AccessType app `
-DisplayName Display Name `
-SourceName appName `
-Attribute groups `
-Value Upward mobility access `
-EntitlementType entitlement `
-Type ENTITLEMENT `
-Description Role - Workday/Citizenship access `
-SourceId 2793o32dwd `
-Standalone false `
-Privileged false `
-CloudGoverned true
-CloudGoverned true `
-EntitlementCount 12 `
-AppRefs [{cloudAppId=8c190e6787aa4ed9a90bd9d5344523fb, cloudAppName=Sample App}, {cloudAppId=2c91808a77ff216301782327a50f09bf, cloudAppName=Another App}] `
-RemoveDate 2024-07-01T06:00:00.00Z `
-Revocable true `
-NativeIdentity dr.arden.ogahn.d `
-AppRoleId 2c918087763e69d901763e72e97f006f
```
- Convert the resource to JSON

69
docs/tools/sdk/powershell/Reference/V2024/Models/ListIdentitySnapshotAccessItems200ResponseInner.md Normal file
View File

@@ -0,0 +1,69 @@
---
id: v2024-list-identity-snapshot-access-items200-response-inner
title: ListIdentitySnapshotAccessItems200ResponseInner
pagination_label: ListIdentitySnapshotAccessItems200ResponseInner
sidebar_label: ListIdentitySnapshotAccessItems200ResponseInner
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ListIdentitySnapshotAccessItems200ResponseInner', 'V2024ListIdentitySnapshotAccessItems200ResponseInner']
slug: /tools/sdk/powershell/v2024/models/list-identity-snapshot-access-items200-response-inner
tags: ['SDK', 'Software Development Kit', 'ListIdentitySnapshotAccessItems200ResponseInner', 'V2024ListIdentitySnapshotAccessItems200ResponseInner']
---
# ListIdentitySnapshotAccessItems200ResponseInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | the access item id | [optional]
**AccessType** | **String** | the access item type. role in this case | [optional]
**DisplayName** | **String** | the role display name | [optional]
**SourceName** | **String** | the associated source name if it exists | [optional]
**EntitlementCount** | **Int32** | the number of entitlements the account will create | [required]
**Description** | **String** | the description for the role | [optional]
**SourceId** | **String** | the id of the source | [optional]
**AppRefs** | [**[]AccessItemAccessProfileResponseAppRefsInner**](access-item-access-profile-response-app-refs-inner) | the list of app ids associated with the access profile | [required]
**RemoveDate** | **String** | the date the role is no longer assigned to the specified identity | [optional]
**Standalone** | **Boolean** | indicates whether the entitlement is standalone | [required]
**Revocable** | **Boolean** | indicates whether the role is revocable | [required]
**NativeIdentity** | **String** | the native identifier used to uniquely identify an acccount | [required]
**AppRoleId** | **String** | the app role id | [required]
**Attribute** | **String** | the entitlement attribute | [required]
**Value** | **String** | the associated value | [required]
**Type** | **String** | the type of entitlement | [required]
**Privileged** | **Boolean** | indicates whether the entitlement is privileged | [required]
**CloudGoverned** | **Boolean** | indicates whether the entitlement is cloud governed | [required]
## Examples
- Prepare the resource
```powershell
$ListIdentitySnapshotAccessItems200ResponseInner = Initialize-V2024ListIdentitySnapshotAccessItems200ResponseInner -Id 2c918087763e69d901763e72e97f006f `
-AccessType role `
-DisplayName sample `
-SourceName Source Name `
-EntitlementCount 12 `
-Description Role - Workday/Citizenship access `
-SourceId 2793o32dwd `
-AppRefs [{cloudAppId=8c190e6787aa4ed9a90bd9d5344523fb, cloudAppName=Sample App}, {cloudAppId=2c91808a77ff216301782327a50f09bf, cloudAppName=Another App}] `
-RemoveDate 2024-07-01T06:00:00.00Z `
-Standalone true `
-Revocable true `
-NativeIdentity dr.arden.ogahn.d `
-AppRoleId 2c918087763e69d901763e72e97f006f `
-Attribute groups `
-Value Upward mobility access `
-Type ENTITLEMENT `
-Privileged false `
-CloudGoverned true
```
- Convert the resource to JSON
```powershell
$ListIdentitySnapshotAccessItems200ResponseInner | ConvertTo-JSON
```
[[Back to top]](#)

23
docs/tools/sdk/powershell/Reference/V2025/Methods/V2025EntitlementsApi.md
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"
} ]
}"@

8
docs/tools/sdk/powershell/Reference/V2025/Methods/V2025IdentityHistoryApi.md
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

28
docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemAccessProfileResponse.md
View File

@@ -16,32 +16,30 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemAccessProfileResponse', 'V2
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessType** | **String** | the access item type. accessProfile in this case | [optional]
**Id** | **String** | the access item id | [optional]
**Name** | **String** | the access profile name | [optional]
**SourceName** | **String** | the name of the source | [optional]
**SourceId** | **String** | the id of the source | [optional]
**Description** | **String** | the description for the access profile | [optional]
**AccessType** | **String** | the access item type. accessProfile in this case | [optional]
**DisplayName** | **String** | the display name of the identity | [optional]
**EntitlementCount** | **String** | the number of entitlements the access profile will create | [optional]
**AppDisplayName** | **String** | the name of | [optional]
**SourceName** | **String** | the name of the source | [optional]
**EntitlementCount** | **Int32** | the number of entitlements the access profile will create | [required]
**Description** | **String** | the description for the access profile | [optional]
**SourceId** | **String** | the id of the source | [optional]
**AppRefs** | [**[]AccessItemAccessProfileResponseAppRefsInner**](access-item-access-profile-response-app-refs-inner) | the list of app ids associated with the access profile | [required]
**RemoveDate** | **String** | the date the access profile is no longer assigned to the specified identity | [optional]
**Standalone** | **Boolean** | indicates whether the access profile is standalone | [required]
**Revocable** | **Boolean** | indicates whether the access profile is | [required]
**Revocable** | **Boolean** | indicates whether the access profile is revocable | [required]
## Examples
- Prepare the resource
```powershell
$AccessItemAccessProfileResponse = Initialize-V2025AccessItemAccessProfileResponse -AccessType accessProfile `
-Id 2c918087763e69d901763e72e97f006f `
-Name sample `
-SourceName DataScienceDataset `
-SourceId 2793o32dwd `
-Description AccessProfile - Workday/Citizenship access `
$AccessItemAccessProfileResponse = Initialize-V2025AccessItemAccessProfileResponse -Id 2c918087763e69d901763e72e97f006f `
-AccessType accessProfile `
-DisplayName Dr. Arden Rogahn MD `
-SourceName DataScienceDataset `
-EntitlementCount 12 `
-AppDisplayName AppName `
-Description AccessProfile - Workday/Citizenship access `
-SourceId 2793o32dwd `
-AppRefs [{cloudAppId=8c190e6787aa4ed9a90bd9d5344523fb, cloudAppName=Sample App}, {cloudAppId=2c91808a77ff216301782327a50f09bf, cloudAppName=Another App}] `
-RemoveDate 2024-07-01T06:00:00.00Z `
-Standalone false `
-Revocable true

37
docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemAccessProfileResponseAppRefsInner.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: v2025-access-item-access-profile-response-app-refs-inner
title: AccessItemAccessProfileResponseAppRefsInner
pagination_label: AccessItemAccessProfileResponseAppRefsInner
sidebar_label: AccessItemAccessProfileResponseAppRefsInner
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessItemAccessProfileResponseAppRefsInner', 'V2025AccessItemAccessProfileResponseAppRefsInner']
slug: /tools/sdk/powershell/v2025/models/access-item-access-profile-response-app-refs-inner
tags: ['SDK', 'Software Development Kit', 'AccessItemAccessProfileResponseAppRefsInner', 'V2025AccessItemAccessProfileResponseAppRefsInner']
---
# AccessItemAccessProfileResponseAppRefsInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**CloudAppId** | **String** | the cloud app id associated with the access profile | [optional]
**CloudAppName** | **String** | the cloud app name associated with the access profile | [optional]
## Examples
- Prepare the resource
```powershell
$AccessItemAccessProfileResponseAppRefsInner = Initialize-V2025AccessItemAccessProfileResponseAppRefsInner -CloudAppId 8c190e6787aa4ed9a90bd9d5344523fb `
-CloudAppName Sample App
```
- Convert the resource to JSON
```powershell
$AccessItemAccessProfileResponseAppRefsInner | ConvertTo-JSON
```
[[Back to top]](#)

20
docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemAccountResponse.md
View File

@@ -16,25 +16,25 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemAccountResponse', 'V2025Acc
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessType** | **String** | the access item type. account in this case | [optional]
**Id** | **String** | the access item id | [optional]
**NativeIdentity** | **String** | the native identifier used to uniquely identify an acccount | [optional]
**SourceName** | **String** | the name of the source | [optional]
**SourceId** | **String** | the id of the source | [optional]
**EntitlementCount** | **String** | the number of entitlements the account will create | [optional]
**AccessType** | **String** | the access item type. account in this case | [optional]
**DisplayName** | **String** | the display name of the identity | [optional]
**SourceName** | **String** | the name of the source | [optional]
**NativeIdentity** | **String** | the native identifier used to uniquely identify an acccount | [required]
**SourceId** | **String** | the id of the source | [optional]
**EntitlementCount** | **Int32** | the number of entitlements the account will create | [optional]
## Examples
- Prepare the resource
```powershell
$AccessItemAccountResponse = Initialize-V2025AccessItemAccountResponse -AccessType account `
-Id 2c918087763e69d901763e72e97f006f `
-NativeIdentity dr.arden.ogahn.d `
$AccessItemAccountResponse = Initialize-V2025AccessItemAccountResponse -Id 2c918087763e69d901763e72e97f006f `
-AccessType account `
-DisplayName Dr. Arden Rogahn MD `
-SourceName DataScienceDataset `
-NativeIdentity dr.arden.ogahn.d `
-SourceId 2793o32dwd `
-EntitlementCount 12 `
-DisplayName Dr. Arden Rogahn MD
-EntitlementCount 12
```
- Convert the resource to JSON

8
docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemAppResponse.md
View File

@@ -16,18 +16,18 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemAppResponse', 'V2025AccessI
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessType** | **String** | the access item type. entitlement in this case | [optional]
**Id** | **String** | the access item id | [optional]
**AccessType** | **String** | the access item type. entitlement in this case | [optional]
**DisplayName** | **String** | the access item display name | [optional]
**SourceName** | **String** | the associated source name if it exists | [optional]
**AppRoleId** | **String** | the app role id | [optional]
**AppRoleId** | **String** | the app role id | [required]
## Examples
- Prepare the resource
```powershell
$AccessItemAppResponse = Initialize-V2025AccessItemAppResponse -AccessType app `
-Id 2c918087763e69d901763e72e97f006f `
$AccessItemAppResponse = Initialize-V2025AccessItemAppResponse -Id 2c918087763e69d901763e72e97f006f `
-AccessType app `
-DisplayName Display Name `
-SourceName appName `
-AppRoleId 2c918087763e69d901763e72e97f006f

18
docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemAssociated.md
View File

@@ -16,21 +16,23 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemAssociated', 'V2025AccessIt
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessItem** | [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional]
**IdentityId** | **String** | the identity id | [optional]
**EventType** | **String** | the event type | [optional]
**Dt** | **String** | the date of event | [optional]
**GovernanceEvent** | [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [optional]
**DateTime** | **String** | the date of event | [optional]
**IdentityId** | **String** | the identity id | [optional]
**AccessItem** | [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [required]
**GovernanceEvent** | [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [required]
**AccessItemType** | **Enum** [ "account", "app", "entitlement", "role", "accessProfile" ] | the access item type | [optional]
## Examples
- Prepare the resource
```powershell
$AccessItemAssociated = Initialize-V2025AccessItemAssociated -AccessItem null `
$AccessItemAssociated = Initialize-V2025AccessItemAssociated -EventType AccessItemAssociated `
-DateTime 2019-03-08T22:37:33.901Z `
-IdentityId 8c190e6787aa4ed9a90bd9d5344523fb `
-EventType AccessItemAssociated `
-Dt 2019-03-08T22:37:33.901Z `
-GovernanceEvent null
-AccessItem null `
-GovernanceEvent null `
-AccessItemType account
```
- Convert the resource to JSON

58
docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemAssociatedAccessItem.md
View File

@@ -16,49 +16,47 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemAssociatedAccessItem', 'V20
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessType** | **String** | the access item type. role in this case | [optional]
**Id** | **String** | the access item id | [optional]
**Name** | **String** | the access profile name | [optional]
**AccessType** | **String** | the access item type. entitlement in this case | [optional]
**DisplayName** | **String** | the access item display name | [optional]
**SourceName** | **String** | the associated source name if it exists | [optional]
**SourceId** | **String** | the id of the source | [optional]
**Attribute** | **String** | the entitlement attribute | [required]
**Value** | **String** | the associated value | [required]
**Type** | **String** | the type of entitlement | [required]
**Description** | **String** | the description for the role | [optional]
**DisplayName** | **String** | the role display name | [optional]
**EntitlementCount** | **String** | the number of entitlements the account will create | [optional]
**AppDisplayName** | **String** | the name of | [optional]
**RemoveDate** | **String** | the date the role is no longer assigned to the specified identity | [optional]
**Standalone** | **Boolean** | indicates whether the entitlement is standalone | [required]
**Revocable** | **Boolean** | indicates whether the role is revocable | [required]
**NativeIdentity** | **String** | the native identifier used to uniquely identify an acccount | [optional]
**AppRoleId** | **String** | the app role id | [optional]
**Attribute** | **String** | the entitlement attribute | [optional]
**Value** | **String** | the associated value | [optional]
**EntitlementType** | **String** | the type of entitlement | [optional]
**SourceId** | **String** | the id of the source | [optional]
**Standalone** | **Boolean** | indicates whether the access profile is standalone | [required]
**Privileged** | **Boolean** | indicates whether the entitlement is privileged | [required]
**CloudGoverned** | **Boolean** | indicates whether the entitlement is cloud governed | [required]
**EntitlementCount** | **Int32** | the number of entitlements the account will create | [required]
**AppRefs** | [**[]AccessItemAccessProfileResponseAppRefsInner**](access-item-access-profile-response-app-refs-inner) | the list of app ids associated with the access profile | [required]
**RemoveDate** | **String** | the date the role is no longer assigned to the specified identity | [optional]
**Revocable** | **Boolean** | indicates whether the role is revocable | [required]
**NativeIdentity** | **String** | the native identifier used to uniquely identify an acccount | [required]
**AppRoleId** | **String** | the app role id | [required]
## Examples
- Prepare the resource
```powershell
$AccessItemAssociatedAccessItem = Initialize-V2025AccessItemAssociatedAccessItem -AccessType role `
-Id 2c918087763e69d901763e72e97f006f `
-Name sample `
-SourceName Source Name `
-SourceId 2793o32dwd `
-Description Role - Workday/Citizenship access `
-DisplayName sample `
-EntitlementCount 12 `
-AppDisplayName AppName `
-RemoveDate 2024-07-01T06:00:00.00Z `
-Standalone true `
-Revocable true `
-NativeIdentity dr.arden.ogahn.d `
-AppRoleId 2c918087763e69d901763e72e97f006f `
$AccessItemAssociatedAccessItem = Initialize-V2025AccessItemAssociatedAccessItem -Id 2c918087763e69d901763e72e97f006f `
-AccessType app `
-DisplayName Display Name `
-SourceName appName `
-Attribute groups `
-Value Upward mobility access `
-EntitlementType entitlement `
-Type ENTITLEMENT `
-Description Role - Workday/Citizenship access `
-SourceId 2793o32dwd `
-Standalone false `
-Privileged false `
-CloudGoverned true
-CloudGoverned true `
-EntitlementCount 12 `
-AppRefs [{cloudAppId=8c190e6787aa4ed9a90bd9d5344523fb, cloudAppName=Sample App}, {cloudAppId=2c91808a77ff216301782327a50f09bf, cloudAppName=Another App}] `
-RemoveDate 2024-07-01T06:00:00.00Z `
-Revocable true `
-NativeIdentity dr.arden.ogahn.d `
-AppRoleId 2c918087763e69d901763e72e97f006f
```
- Convert the resource to JSON

26
docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemEntitlementResponse.md
View File

@@ -16,15 +16,15 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemEntitlementResponse', 'V202
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessType** | **String** | the access item type. entitlement in this case | [optional]
**Id** | **String** | the access item id | [optional]
**Attribute** | **String** | the entitlement attribute | [optional]
**Value** | **String** | the associated value | [optional]
**EntitlementType** | **String** | the type of entitlement | [optional]
**SourceName** | **String** | the name of the source | [optional]
**SourceId** | **String** | the id of the source | [optional]
**Description** | **String** | the description for the entitlment | [optional]
**AccessType** | **String** | the access item type. entitlement in this case | [optional]
**DisplayName** | **String** | the display name of the identity | [optional]
**SourceName** | **String** | the name of the source | [optional]
**Attribute** | **String** | the entitlement attribute | [required]
**Value** | **String** | the associated value | [required]
**Type** | **String** | the type of entitlement | [required]
**Description** | **String** | the description for the entitlment | [optional]
**SourceId** | **String** | the id of the source | [optional]
**Standalone** | **Boolean** | indicates whether the entitlement is standalone | [required]
**Privileged** | **Boolean** | indicates whether the entitlement is privileged | [required]
**CloudGoverned** | **Boolean** | indicates whether the entitlement is cloud governed | [required]
@@ -33,15 +33,15 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$AccessItemEntitlementResponse = Initialize-V2025AccessItemEntitlementResponse -AccessType entitlement `
-Id 2c918087763e69d901763e72e97f006f `
$AccessItemEntitlementResponse = Initialize-V2025AccessItemEntitlementResponse -Id 2c918087763e69d901763e72e97f006f `
-AccessType entitlement `
-DisplayName Dr. Arden Rogahn MD `
-SourceName DataScienceDataset `
-Attribute groups `
-Value Upward mobility access `
-EntitlementType entitlement `
-SourceName DataScienceDataset `
-SourceId 2793o32dwd `
-Type ENTITLEMENT `
-Description Entitlement - Workday/Citizenship access `
-DisplayName Dr. Arden Rogahn MD `
-SourceId 2793o32dwd `
-Standalone true `
-Privileged false `
-CloudGoverned true

8
docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemRemoved.md
View File

@@ -16,10 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemRemoved', 'V2025AccessItemR
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessItem** | [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional]
**AccessItem** | [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [required]
**IdentityId** | **String** | the identity id | [optional]
**EventType** | **String** | the event type | [optional]
**Dt** | **String** | the date of event | [optional]
**DateTime** | **String** | the date of event | [optional]
**AccessItemType** | **Enum** [ "account", "app", "entitlement", "role", "accessProfile" ] | the access item type | [optional]
**GovernanceEvent** | [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [optional]
## Examples
@@ -29,7 +30,8 @@ Name | Type | Description | Notes
$AccessItemRemoved = Initialize-V2025AccessItemRemoved -AccessItem null `
-IdentityId 8c190e6787aa4ed9a90bd9d5344523fb `
-EventType AccessItemRemoved `
-Dt 2019-03-08T22:37:33.901Z `
-DateTime 2019-03-08T22:37:33.901Z `
-AccessItemType account `
-GovernanceEvent null
```

10
docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemRoleResponse.md
View File

@@ -16,11 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemRoleResponse', 'V2025Access
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessType** | **String** | the access item type. role in this case | [optional]
**Id** | **String** | the access item id | [optional]
**AccessType** | **String** | the access item type. role in this case | [optional]
**DisplayName** | **String** | the role display name | [optional]
**Description** | **String** | the description for the role | [optional]
**SourceName** | **String** | the associated source name if it exists | [optional]
**Description** | **String** | the description for the role | [optional]
**RemoveDate** | **String** | the date the role is no longer assigned to the specified identity | [optional]
**Revocable** | **Boolean** | indicates whether the role is revocable | [required]
@@ -28,11 +28,11 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$AccessItemRoleResponse = Initialize-V2025AccessItemRoleResponse -AccessType role `
-Id 2c918087763e69d901763e72e97f006f `
$AccessItemRoleResponse = Initialize-V2025AccessItemRoleResponse -Id 2c918087763e69d901763e72e97f006f `
-AccessType role `
-DisplayName sample `
-Description Role - Workday/Citizenship access `
-SourceName Source Name `
-Description Role - Workday/Citizenship access `
-RemoveDate 2024-07-01T06:00:00.00Z `
-Revocable true
```

6
docs/tools/sdk/powershell/Reference/V2025/Models/AccessRequested.md
View File

@@ -16,10 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequested', 'V2025AccessRequest
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessRequest** | [**AccessRequestResponse1**](access-request-response1) | | [optional]
**AccessRequest** | [**AccessRequestResponse1**](access-request-response1) | | [required]
**IdentityId** | **String** | the identity id | [optional]
**EventType** | **String** | the event type | [optional]
**Dt** | **String** | the date of event | [optional]
**DateTime** | **String** | the date of event | [optional]
## Examples
@@ -28,7 +28,7 @@ Name | Type | Description | Notes
$AccessRequested = Initialize-V2025AccessRequested -AccessRequest null `
-IdentityId 8a80828f643d484f01643e14202e206f `
-EventType AccessRequested `
-Dt 2019-03-08T22:37:33.901Z
-DateTime 2019-03-08T22:37:33.901Z
```
- Convert the resource to JSON

12
docs/tools/sdk/powershell/Reference/V2025/Models/AccountStatusChanged.md
View File

@@ -18,17 +18,17 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**EventType** | **String** | the event type | [optional]
**IdentityId** | **String** | the identity id | [optional]
**Dt** | **String** | the date of event | [optional]
**Account** | [**AccountStatusChangedAccount**](account-status-changed-account) | | [optional]
**StatusChange** | [**AccountStatusChangedStatusChange**](account-status-changed-status-change) | | [optional]
**DateTime** | **String** | the date of event | [optional]
**Account** | [**AccountStatusChangedAccount**](account-status-changed-account) | | [required]
**StatusChange** | [**AccountStatusChangedStatusChange**](account-status-changed-status-change) | | [required]
## Examples
- Prepare the resource
```powershell
$AccountStatusChanged = Initialize-V2025AccountStatusChanged -EventType null `
-IdentityId null `
-Dt null `
$AccountStatusChanged = Initialize-V2025AccountStatusChanged -EventType AccountStatusChanged `
-IdentityId 8a80828f643d484f01643e14202e206f `
-DateTime 2019-03-08T22:37:33.901Z `
-Account null `
-StatusChange null
```

14
docs/tools/sdk/powershell/Reference/V2025/Models/AccountStatusChangedAccount.md
View File

@@ -28,13 +28,13 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$AccountStatusChangedAccount = Initialize-V2025AccountStatusChangedAccount -Id null `
-NativeIdentity null `
-DisplayName null `
-SourceId null `
-SourceName null `
-EntitlementCount null `
-AccessType null
$AccountStatusChangedAccount = Initialize-V2025AccountStatusChangedAccount -Id 2c91808a77ff216301782327a50f09bf `
-NativeIdentity dr.arden.ogahn.d `
-DisplayName Adam Archer `
-SourceId 8a80828f643d484f01643e14202e206f `
-SourceName JDBC Entitlements Source `
-EntitlementCount 2 `
-AccessType account
```
- Convert the resource to JSON

4
docs/tools/sdk/powershell/Reference/V2025/Models/AccountStatusChangedStatusChange.md
View File

@@ -23,8 +23,8 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$AccountStatusChangedStatusChange = Initialize-V2025AccountStatusChangedStatusChange -PreviousStatus null `
-NewStatus null
$AccountStatusChangedStatusChange = Initialize-V2025AccountStatusChangedStatusChange -PreviousStatus enabled `
-NewStatus disabled
```
- Convert the resource to JSON

6
docs/tools/sdk/powershell/Reference/V2025/Models/AttributeChange.md
View File

@@ -24,9 +24,9 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$AttributeChange = Initialize-V2025AttributeChange -Name null `
-PreviousValue null `
-NewValue null
$AttributeChange = Initialize-V2025AttributeChange -Name firstname `
-PreviousValue adam `
-NewValue zampa
```
- Convert the resource to JSON

12
docs/tools/sdk/powershell/Reference/V2025/Models/AttributesChanged.md
View File

@@ -16,19 +16,19 @@ tags: ['SDK', 'Software Development Kit', 'AttributesChanged', 'V2025AttributesC
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Changes** | [**[]AttributeChange**](attribute-change) | | [optional]
**AttributeChanges** | [**[]AttributeChange**](attribute-change) | | [required]
**EventType** | **String** | the event type | [optional]
**IdentityId** | **String** | the identity id | [optional]
**Dt** | **String** | the date of event | [optional]
**DateTime** | **String** | the date of event | [optional]
## Examples
- Prepare the resource
```powershell
$AttributesChanged = Initialize-V2025AttributesChanged -Changes null `
-EventType null `
-IdentityId null `
-Dt null
$AttributesChanged = Initialize-V2025AttributesChanged -AttributeChanges null `
-EventType AttributesChanged `
-IdentityId 8a80828f643d484f01643e14202e206f `
-DateTime 2019-03-08T22:37:33.901Z
```
- Convert the resource to JSON

4
docs/tools/sdk/powershell/Reference/V2025/Models/CorrelatedGovernanceEvent.md
View File

@@ -17,7 +17,7 @@ tags: ['SDK', 'Software Development Kit', 'CorrelatedGovernanceEvent', 'V2025Cor
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Name** | **String** | The name of the governance event, such as the certification name or access request ID. | [optional]
**Dt** | **String** | The date that the certification or access request was completed. | [optional]
**DateTime** | **String** | The date that the certification or access request was completed. | [optional]
**Type** | **Enum** [ "certification", "accessRequest" ] | The type of governance event. | [optional]
**GovernanceId** | **String** | The ID of the instance that caused the event - either the certification ID or access request ID. | [optional]
**Owners** | [**[]CertifierResponse**](certifier-response) | The owners of the governance event (the certifiers or approvers) | [optional]
@@ -29,7 +29,7 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$CorrelatedGovernanceEvent = Initialize-V2025CorrelatedGovernanceEvent -Name Manager Certification for Jon Snow `
-Dt 2019-03-08T22:37:33.901Z `
-DateTime 2019-03-08T22:37:33.901Z `
-Type certification `
-GovernanceId 2c91808a77ff216301782327a50f09bf `
-Owners [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] `

2
docs/tools/sdk/powershell/Reference/V2025/Models/EntitlementBulkUpdateRequest.md
View File

@@ -24,7 +24,7 @@ Name | Type | Description | Notes
- Prepare the resource
```powershell
$EntitlementBulkUpdateRequest = Initialize-V2025EntitlementBulkUpdateRequest -EntitlementIds [2c91808a7624751a01762f19d665220d, 2c91808a7624751a01762f19d67c220e, 2c91808a7624751a01762f19d692220f] `
-JsonPatch [{op=replace, path=/privileged, value=false}, {op=replace, path=/requestable, value=false}]
-JsonPatch [{op=replace, path=/privileged, value=false}, {op=replace, path=/requestable, value=false}, {op=replace, path=/privilegeOverride/overrideLevel, value=HIGH}]
```
- Convert the resource to JSON

40
docs/tools/sdk/powershell/Reference/V2025/Models/GetHistoricalIdentityEvents200ResponseInner.md
View File

@@ -16,39 +16,41 @@ tags: ['SDK', 'Software Development Kit', 'GetHistoricalIdentityEvents200Respons
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessItem** | [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional]
**IdentityId** | **String** | the identity id | [optional]
**EventType** | **String** | the event type | [optional]
**Dt** | **String** | the date of event | [optional]
**GovernanceEvent** | [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [optional]
**Changes** | [**[]AttributeChange**](attribute-change) | | [optional]
**AccessRequest** | [**AccessRequestResponse1**](access-request-response1) | | [optional]
**CertificationId** | **String** | the id of the certification item | [optional]
**CertificationName** | **String** | the certification item name | [optional]
**CertificationId** | **String** | the id of the certification item | [required]
**CertificationName** | **String** | the certification item name | [required]
**SignedDate** | **String** | the date ceritification was signed | [optional]
**Certifiers** | [**[]CertifierResponse**](certifier-response) | this field is deprecated and may go away | [optional]
**Reviewers** | [**[]CertifierResponse**](certifier-response) | The list of identities who review this certification | [optional]
**Signer** | [**CertifierResponse**](certifier-response) | | [optional]
**Account** | [**AccountStatusChangedAccount**](account-status-changed-account) | | [optional]
**StatusChange** | [**AccountStatusChangedStatusChange**](account-status-changed-status-change) | | [optional]
**EventType** | **String** | the event type | [optional]
**DateTime** | **String** | the date of event | [optional]
**IdentityId** | **String** | the identity id | [optional]
**AccessItem** | [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [required]
**GovernanceEvent** | [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [required]
**AccessItemType** | **Enum** [ "account", "app", "entitlement", "role", "accessProfile" ] | the access item type | [optional]
**AttributeChanges** | [**[]AttributeChange**](attribute-change) | | [required]
**AccessRequest** | [**AccessRequestResponse1**](access-request-response1) | | [required]
**Account** | [**AccountStatusChangedAccount**](account-status-changed-account) | | [required]
**StatusChange** | [**AccountStatusChangedStatusChange**](account-status-changed-status-change) | | [required]
## Examples
- Prepare the resource
```powershell
$GetHistoricalIdentityEvents200ResponseInner = Initialize-V2025GetHistoricalIdentityEvents200ResponseInner -AccessItem null `
-IdentityId null `
-EventType null `
-Dt null `
-GovernanceEvent null `
-Changes null `
-AccessRequest null `
-CertificationId 2c91808a77ff216301782327a50f09bf `
$GetHistoricalIdentityEvents200ResponseInner = Initialize-V2025GetHistoricalIdentityEvents200ResponseInner -CertificationId 2c91808a77ff216301782327a50f09bf `
-CertificationName Cert name `
-SignedDate 2019-03-08T22:37:33.901Z `
-Certifiers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] `
-Reviewers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] `
-Signer null `
-EventType AccountStatusChanged `
-DateTime 2019-03-08T22:37:33.901Z `
-IdentityId 8a80828f643d484f01643e14202e206f `
-AccessItem null `
-GovernanceEvent null `
-AccessItemType account `
-AttributeChanges null `
-AccessRequest null `
-Account null `
-StatusChange null
```

8
docs/tools/sdk/powershell/Reference/V2025/Models/IdentityCertified.md
View File

@@ -16,14 +16,14 @@ tags: ['SDK', 'Software Development Kit', 'IdentityCertified', 'V2025IdentityCer
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**CertificationId** | **String** | the id of the certification item | [optional]
**CertificationName** | **String** | the certification item name | [optional]
**CertificationId** | **String** | the id of the certification item | [required]
**CertificationName** | **String** | the certification item name | [required]
**SignedDate** | **String** | the date ceritification was signed | [optional]
**Certifiers** | [**[]CertifierResponse**](certifier-response) | this field is deprecated and may go away | [optional]
**Reviewers** | [**[]CertifierResponse**](certifier-response) | The list of identities who review this certification | [optional]
**Signer** | [**CertifierResponse**](certifier-response) | | [optional]
**EventType** | **String** | the event type | [optional]
**Dt** | **String** | the date of event | [optional]
**DateTime** | **String** | the date of event | [optional]
## Examples
@@ -36,7 +36,7 @@ $IdentityCertified = Initialize-V2025IdentityCertified -CertificationId 2c91808
-Reviewers [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}] `
-Signer null `
-EventType IdentityCertified `
-Dt 2019-03-08T22:37:33.901Z
-DateTime 2019-03-08T22:37:33.901Z
```
- Convert the resource to JSON

58
docs/tools/sdk/powershell/Reference/V2025/Models/ListIdentityAccessItems200ResponseInner.md
View File

@@ -16,49 +16,47 @@ tags: ['SDK', 'Software Development Kit', 'ListIdentityAccessItems200ResponseInn
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**AccessType** | **String** | the access item type. role in this case | [optional]
**Id** | **String** | the access item id | [optional]
**Name** | **String** | the access profile name | [optional]
**AccessType** | **String** | the access item type. entitlement in this case | [optional]
**DisplayName** | **String** | the access item display name | [optional]
**SourceName** | **String** | the associated source name if it exists | [optional]
**SourceId** | **String** | the id of the source | [optional]
**Attribute** | **String** | the entitlement attribute | [required]
**Value** | **String** | the associated value | [required]
**Type** | **String** | the type of entitlement | [required]
**Description** | **String** | the description for the role | [optional]
**DisplayName** | **String** | the role display name | [optional]
**EntitlementCount** | **String** | the number of entitlements the account will create | [optional]
**AppDisplayName** | **String** | the name of | [optional]
**RemoveDate** | **String** | the date the role is no longer assigned to the specified identity | [optional]
**Standalone** | **Boolean** | indicates whether the entitlement is standalone | [required]
**Revocable** | **Boolean** | indicates whether the role is revocable | [required]
**NativeIdentity** | **String** | the native identifier used to uniquely identify an acccount | [optional]
**AppRoleId** | **String** | the app role id | [optional]
**Attribute** | **String** | the entitlement attribute | [optional]
**Value** | **String** | the associated value | [optional]
**EntitlementType** | **String** | the type of entitlement | [optional]
**SourceId** | **String** | the id of the source | [optional]
**Standalone** | **Boolean** | indicates whether the access profile is standalone | [required]
**Privileged** | **Boolean** | indicates whether the entitlement is privileged | [required]
**CloudGoverned** | **Boolean** | indicates whether the entitlement is cloud governed | [required]
**EntitlementCount** | **Int32** | the number of entitlements the account will create | [required]
**AppRefs** | [**[]AccessItemAccessProfileResponseAppRefsInner**](access-item-access-profile-response-app-refs-inner) | the list of app ids associated with the access profile | [required]
**RemoveDate** | **String** | the date the role is no longer assigned to the specified identity | [optional]
**Revocable** | **Boolean** | indicates whether the role is revocable | [required]
**NativeIdentity** | **String** | the native identifier used to uniquely identify an acccount | [required]
**AppRoleId** | **String** | the app role id | [required]
## Examples
- Prepare the resource
```powershell
$ListIdentityAccessItems200ResponseInner = Initialize-V2025ListIdentityAccessItems200ResponseInner -AccessType role `
-Id 2c918087763e69d901763e72e97f006f `
-Name sample `
-SourceName Source Name `
-SourceId 2793o32dwd `
-Description Role - Workday/Citizenship access `
-DisplayName sample `
-EntitlementCount 12 `
-AppDisplayName AppName `
-RemoveDate 2024-07-01T06:00:00.00Z `
-Standalone true `
-Revocable true `
-NativeIdentity dr.arden.ogahn.d `
-AppRoleId 2c918087763e69d901763e72e97f006f `
$ListIdentityAccessItems200ResponseInner = Initialize-V2025ListIdentityAccessItems200ResponseInner -Id 2c918087763e69d901763e72e97f006f `
-AccessType app `
-DisplayName Display Name `
-SourceName appName `
-Attribute groups `
-Value Upward mobility access `
-EntitlementType entitlement `
-Type ENTITLEMENT `
-Description Role - Workday/Citizenship access `
-SourceId 2793o32dwd `
-Standalone false `
-Privileged false `
-CloudGoverned true
-CloudGoverned true `
-EntitlementCount 12 `
-AppRefs [{cloudAppId=8c190e6787aa4ed9a90bd9d5344523fb, cloudAppName=Sample App}, {cloudAppId=2c91808a77ff216301782327a50f09bf, cloudAppName=Another App}] `
-RemoveDate 2024-07-01T06:00:00.00Z `
-Revocable true `
-NativeIdentity dr.arden.ogahn.d `
-AppRoleId 2c918087763e69d901763e72e97f006f
```
- Convert the resource to JSON

69
docs/tools/sdk/powershell/Reference/V2025/Models/ListIdentitySnapshotAccessItems200ResponseInner.md Normal file
View File

@@ -0,0 +1,69 @@
---
id: v2025-list-identity-snapshot-access-items200-response-inner
title: ListIdentitySnapshotAccessItems200ResponseInner
pagination_label: ListIdentitySnapshotAccessItems200ResponseInner
sidebar_label: ListIdentitySnapshotAccessItems200ResponseInner
sidebar_class_name: powershellsdk
keywords: ['powershell', 'PowerShell', 'sdk', 'ListIdentitySnapshotAccessItems200ResponseInner', 'V2025ListIdentitySnapshotAccessItems200ResponseInner']
slug: /tools/sdk/powershell/v2025/models/list-identity-snapshot-access-items200-response-inner
tags: ['SDK', 'Software Development Kit', 'ListIdentitySnapshotAccessItems200ResponseInner', 'V2025ListIdentitySnapshotAccessItems200ResponseInner']
---
# ListIdentitySnapshotAccessItems200ResponseInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**Id** | **String** | the access item id | [optional]
**AccessType** | **String** | the access item type. role in this case | [optional]
**DisplayName** | **String** | the role display name | [optional]
**SourceName** | **String** | the associated source name if it exists | [optional]
**EntitlementCount** | **Int32** | the number of entitlements the account will create | [required]
**Description** | **String** | the description for the role | [optional]
**SourceId** | **String** | the id of the source | [optional]
**AppRefs** | [**[]AccessItemAccessProfileResponseAppRefsInner**](access-item-access-profile-response-app-refs-inner) | the list of app ids associated with the access profile | [required]
**RemoveDate** | **String** | the date the role is no longer assigned to the specified identity | [optional]
**Standalone** | **Boolean** | indicates whether the entitlement is standalone | [required]
**Revocable** | **Boolean** | indicates whether the role is revocable | [required]
**NativeIdentity** | **String** | the native identifier used to uniquely identify an acccount | [required]
**AppRoleId** | **String** | the app role id | [required]
**Attribute** | **String** | the entitlement attribute | [required]
**Value** | **String** | the associated value | [required]
**Type** | **String** | the type of entitlement | [required]
**Privileged** | **Boolean** | indicates whether the entitlement is privileged | [required]
**CloudGoverned** | **Boolean** | indicates whether the entitlement is cloud governed | [required]
## Examples
- Prepare the resource
```powershell
$ListIdentitySnapshotAccessItems200ResponseInner = Initialize-V2025ListIdentitySnapshotAccessItems200ResponseInner -Id 2c918087763e69d901763e72e97f006f `
-AccessType role `
-DisplayName sample `
-SourceName Source Name `
-EntitlementCount 12 `
-Description Role - Workday/Citizenship access `
-SourceId 2793o32dwd `
-AppRefs [{cloudAppId=8c190e6787aa4ed9a90bd9d5344523fb, cloudAppName=Sample App}, {cloudAppId=2c91808a77ff216301782327a50f09bf, cloudAppName=Another App}] `
-RemoveDate 2024-07-01T06:00:00.00Z `
-Standalone true `
-Revocable true `
-NativeIdentity dr.arden.ogahn.d `
-AppRoleId 2c918087763e69d901763e72e97f006f `
-Attribute groups `
-Value Upward mobility access `
-Type ENTITLEMENT `
-Privileged false `
-CloudGoverned true
```
- Convert the resource to JSON
```powershell
$ListIdentitySnapshotAccessItems200ResponseInner | ConvertTo-JSON
```
[[Back to top]](#)

6
static/code-examples/beta/powershell_code_examples_overlay.yaml
View File

@@ -3909,6 +3909,10 @@
"op" : "replace",
"path" : "/requestable",
"value" : false
}, {
"op" : "replace",
"path" : "/privilegeOverride/overrideLevel",
"value" : "HIGH"
} ]
}
"@
@@ -5914,7 +5918,7 @@
$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-BetaHistoricalIdentityEvents -Id $Id

6
static/code-examples/v2024/powershell_code_examples_overlay.yaml
View File

@@ -5796,6 +5796,10 @@
"op" : "replace",
"path" : "/requestable",
"value" : false
}, {
"op" : "replace",
"path" : "/privilegeOverride/overrideLevel",
"value" : "HIGH"
} ]
}
"@
@@ -8098,7 +8102,7 @@
$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-V2024HistoricalIdentityEvents -Id $Id -XSailPointExperimental $XSailPointExperimental

6
static/code-examples/v2025/powershell_code_examples_overlay.yaml
View File

@@ -6047,6 +6047,10 @@
"op" : "replace",
"path" : "/requestable",
"value" : false
}, {
"op" : "replace",
"path" : "/privilegeOverride/overrideLevel",
"value" : "HIGH"
} ]
}
"@
@@ -8350,7 +8354,7 @@
$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