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

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]](#)