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

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