diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaEntitlementsApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaEntitlementsApi.md index 17079dfc5..c49ed5903 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaEntitlementsApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaEntitlementsApi.md @@ -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" } ] }"@ diff --git a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityHistoryApi.md b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityHistoryApi.md index 2e9485fb8..ccc975c6f 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityHistoryApi.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityHistoryApi.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemAccessProfileResponse.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemAccessProfileResponse.md index e2d4f693f..e7b772ae0 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemAccessProfileResponse.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemAccessProfileResponse.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemAccessProfileResponseAppRefsInner.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemAccessProfileResponseAppRefsInner.md new file mode 100644 index 000000000..4b3e8618e --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemAccessProfileResponseAppRefsInner.md @@ -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]](#) + diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemAccountResponse.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemAccountResponse.md index 60fe170fc..5b0256f96 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemAccountResponse.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemAccountResponse.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemAppResponse.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemAppResponse.md index 34d3a9b24..03a0d7326 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemAppResponse.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemAppResponse.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemAssociated.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemAssociated.md index 8831488b8..34f592ccc 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemAssociated.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemAssociated.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemAssociatedAccessItem.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemAssociatedAccessItem.md index 32051aa37..e2e5814f0 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemAssociatedAccessItem.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemAssociatedAccessItem.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemEntitlementResponse.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemEntitlementResponse.md index 428a4897d..597bea544 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemEntitlementResponse.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemEntitlementResponse.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemRemoved.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemRemoved.md index 048897dc4..c7d4bd699 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemRemoved.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemRemoved.md @@ -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 ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemRoleResponse.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemRoleResponse.md index 18f0acd8d..ab7176f1a 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemRoleResponse.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessItemRoleResponse.md @@ -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 ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequested.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequested.md index bd45c729f..a3920031d 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequested.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccessRequested.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountStatusChanged.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountStatusChanged.md index f9fce0d66..2093fe35b 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountStatusChanged.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountStatusChanged.md @@ -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 ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountStatusChangedAccount.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountStatusChangedAccount.md index 951726c31..3b6b1c01a 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountStatusChangedAccount.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountStatusChangedAccount.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountStatusChangedStatusChange.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountStatusChangedStatusChange.md index bb74a96fd..ceb70da0d 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AccountStatusChangedStatusChange.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AccountStatusChangedStatusChange.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AttributeChange.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AttributeChange.md index 8b11f8877..34c421fc4 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AttributeChange.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AttributeChange.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/AttributesChanged.md b/docs/tools/sdk/powershell/Reference/Beta/Models/AttributesChanged.md index e591252fa..c0b2f14f6 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/AttributesChanged.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/AttributesChanged.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/CorrelatedGovernanceEvent.md b/docs/tools/sdk/powershell/Reference/Beta/Models/CorrelatedGovernanceEvent.md index 926d51d56..91f8cd48c 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/CorrelatedGovernanceEvent.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/CorrelatedGovernanceEvent.md @@ -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}] ` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/EntitlementBulkUpdateRequest.md b/docs/tools/sdk/powershell/Reference/Beta/Models/EntitlementBulkUpdateRequest.md index 29a53df46..8cf9f9908 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/EntitlementBulkUpdateRequest.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/EntitlementBulkUpdateRequest.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/GetHistoricalIdentityEvents200ResponseInner.md b/docs/tools/sdk/powershell/Reference/Beta/Models/GetHistoricalIdentityEvents200ResponseInner.md index 3fc10c1e8..eadb177ca 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/GetHistoricalIdentityEvents200ResponseInner.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/GetHistoricalIdentityEvents200ResponseInner.md @@ -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 ``` diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityCertified.md b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityCertified.md index 17751462e..dfdd9a5cf 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityCertified.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/IdentityCertified.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/ListIdentityAccessItems200ResponseInner.md b/docs/tools/sdk/powershell/Reference/Beta/Models/ListIdentityAccessItems200ResponseInner.md index 59da3416b..f7fac0526 100644 --- a/docs/tools/sdk/powershell/Reference/Beta/Models/ListIdentityAccessItems200ResponseInner.md +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/ListIdentityAccessItems200ResponseInner.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/Beta/Models/ListIdentitySnapshotAccessItems200ResponseInner.md b/docs/tools/sdk/powershell/Reference/Beta/Models/ListIdentitySnapshotAccessItems200ResponseInner.md new file mode 100644 index 000000000..e3597eddc --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/Beta/Models/ListIdentitySnapshotAccessItems200ResponseInner.md @@ -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]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024EntitlementsApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024EntitlementsApi.md index 66a2427c5..3bb55859e 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024EntitlementsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024EntitlementsApi.md @@ -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" } ] }"@ diff --git a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityHistoryApi.md b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityHistoryApi.md index fd65faafc..6c52e4731 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityHistoryApi.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024IdentityHistoryApi.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemAccessProfileResponse.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemAccessProfileResponse.md index 30f241cf6..21d43951b 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemAccessProfileResponse.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemAccessProfileResponse.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemAccessProfileResponseAppRefsInner.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemAccessProfileResponseAppRefsInner.md new file mode 100644 index 000000000..7cd9695b5 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemAccessProfileResponseAppRefsInner.md @@ -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]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemAccountResponse.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemAccountResponse.md index 9f4da4b5f..2a074fe0e 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemAccountResponse.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemAccountResponse.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemAppResponse.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemAppResponse.md index d0be49dbd..f6d0aaff4 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemAppResponse.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemAppResponse.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemAssociated.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemAssociated.md index a590c901c..e856ea540 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemAssociated.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemAssociated.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemAssociatedAccessItem.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemAssociatedAccessItem.md index 584f80f08..8e9fd9c8b 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemAssociatedAccessItem.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemAssociatedAccessItem.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemEntitlementResponse.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemEntitlementResponse.md index eef4f1d15..edf9b8084 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemEntitlementResponse.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemEntitlementResponse.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemRemoved.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemRemoved.md index fe8c9516a..fddf2c5e2 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemRemoved.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemRemoved.md @@ -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 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemRoleResponse.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemRoleResponse.md index 563bff093..f299c1dfc 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemRoleResponse.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessItemRoleResponse.md @@ -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 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestItemResponse.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestItemResponse.md deleted file mode 100644 index 08b851090..000000000 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestItemResponse.md +++ /dev/null @@ -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]](#) - diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestResponse1.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestResponse1.md deleted file mode 100644 index 794c6e61c..000000000 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestResponse1.md +++ /dev/null @@ -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]](#) - diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequested.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequested.md index ada397ea6..19f3d07b3 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequested.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequested.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountStatusChangedAccount.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestedAccount.md similarity index 52% rename from docs/tools/sdk/powershell/Reference/V2024/Models/AccountStatusChangedAccount.md rename to docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestedAccount.md index e8fd307a2..5f0496560 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountStatusChangedAccount.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestedAccount.md @@ -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 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestedStatusChange.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestedStatusChange.md new file mode 100644 index 000000000..186b0eeca --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccessRequestedStatusChange.md @@ -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]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountStatusChanged.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountStatusChanged.md index f38a0f47b..7f2675d20 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountStatusChanged.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountStatusChanged.md @@ -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 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountStatusChangedStatusChange.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AccountStatusChangedStatusChange.md deleted file mode 100644 index 0abefbaf0..000000000 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AccountStatusChangedStatusChange.md +++ /dev/null @@ -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]](#) - diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ApprovalInfoResponse.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ApprovalInfoResponse.md deleted file mode 100644 index 6d6769392..000000000 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ApprovalInfoResponse.md +++ /dev/null @@ -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]](#) - diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AttributeChange.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AttributeChange.md index 09b5e9f10..42ac5ed09 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AttributeChange.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AttributeChange.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/AttributesChanged.md b/docs/tools/sdk/powershell/Reference/V2024/Models/AttributesChanged.md index 2de72f1b2..d6a1f3e55 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/AttributesChanged.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/AttributesChanged.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/CorrelatedGovernanceEvent.md b/docs/tools/sdk/powershell/Reference/V2024/Models/CorrelatedGovernanceEvent.md index 15c61e726..6ff79d6c3 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/CorrelatedGovernanceEvent.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/CorrelatedGovernanceEvent.md @@ -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}] ` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/EntitlementBulkUpdateRequest.md b/docs/tools/sdk/powershell/Reference/V2024/Models/EntitlementBulkUpdateRequest.md index 4c3552808..c32170b76 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/EntitlementBulkUpdateRequest.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/EntitlementBulkUpdateRequest.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/GetHistoricalIdentityEvents200ResponseInner.md b/docs/tools/sdk/powershell/Reference/V2024/Models/GetHistoricalIdentityEvents200ResponseInner.md index c270b4137..85542ca9d 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/GetHistoricalIdentityEvents200ResponseInner.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/GetHistoricalIdentityEvents200ResponseInner.md @@ -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 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityCertified.md b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityCertified.md index b1f2bf166..5090bc1f1 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityCertified.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/IdentityCertified.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ListIdentityAccessItems200ResponseInner.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ListIdentityAccessItems200ResponseInner.md index 44e993b76..702608d2c 100644 --- a/docs/tools/sdk/powershell/Reference/V2024/Models/ListIdentityAccessItems200ResponseInner.md +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ListIdentityAccessItems200ResponseInner.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/V2024/Models/ListIdentitySnapshotAccessItems200ResponseInner.md b/docs/tools/sdk/powershell/Reference/V2024/Models/ListIdentitySnapshotAccessItems200ResponseInner.md new file mode 100644 index 000000000..c0d42f676 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2024/Models/ListIdentitySnapshotAccessItems200ResponseInner.md @@ -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]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025EntitlementsApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025EntitlementsApi.md index 3332af4fe..8ee0c8953 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025EntitlementsApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025EntitlementsApi.md @@ -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" } ] }"@ diff --git a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025IdentityHistoryApi.md b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025IdentityHistoryApi.md index f5205f685..fa9ce0a25 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025IdentityHistoryApi.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Methods/V2025IdentityHistoryApi.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemAccessProfileResponse.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemAccessProfileResponse.md index ff7b4810f..8b203de77 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemAccessProfileResponse.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemAccessProfileResponse.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemAccessProfileResponseAppRefsInner.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemAccessProfileResponseAppRefsInner.md new file mode 100644 index 000000000..75d6650dc --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemAccessProfileResponseAppRefsInner.md @@ -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]](#) + diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemAccountResponse.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemAccountResponse.md index 674aba167..8abd397a0 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemAccountResponse.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemAccountResponse.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemAppResponse.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemAppResponse.md index 57d85cca2..7576ec577 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemAppResponse.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemAppResponse.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemAssociated.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemAssociated.md index ec8417399..1e15a2100 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemAssociated.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemAssociated.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemAssociatedAccessItem.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemAssociatedAccessItem.md index 106347de0..42dec40cb 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemAssociatedAccessItem.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemAssociatedAccessItem.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemEntitlementResponse.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemEntitlementResponse.md index a12eb50db..e978f7a25 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemEntitlementResponse.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemEntitlementResponse.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemRemoved.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemRemoved.md index 819911ddd..5b8514bb7 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemRemoved.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemRemoved.md @@ -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 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemRoleResponse.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemRoleResponse.md index a7e796791..f7b5cd061 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemRoleResponse.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessItemRoleResponse.md @@ -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 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessRequested.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessRequested.md index 6761d3cf3..e9d9c57e5 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/AccessRequested.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccessRequested.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccountStatusChanged.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccountStatusChanged.md index 9dfbd228b..e8891b5bc 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/AccountStatusChanged.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccountStatusChanged.md @@ -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 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccountStatusChangedAccount.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccountStatusChangedAccount.md index 6231b262f..8fce3057c 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/AccountStatusChangedAccount.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccountStatusChangedAccount.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AccountStatusChangedStatusChange.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AccountStatusChangedStatusChange.md index ae45238df..ca30b4118 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/AccountStatusChangedStatusChange.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AccountStatusChangedStatusChange.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AttributeChange.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AttributeChange.md index 898e7dc50..cecab4450 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/AttributeChange.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AttributeChange.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/AttributesChanged.md b/docs/tools/sdk/powershell/Reference/V2025/Models/AttributesChanged.md index 27e21973d..e67d09217 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/AttributesChanged.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/AttributesChanged.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/CorrelatedGovernanceEvent.md b/docs/tools/sdk/powershell/Reference/V2025/Models/CorrelatedGovernanceEvent.md index 62fb20995..44b311e33 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/CorrelatedGovernanceEvent.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/CorrelatedGovernanceEvent.md @@ -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}] ` diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/EntitlementBulkUpdateRequest.md b/docs/tools/sdk/powershell/Reference/V2025/Models/EntitlementBulkUpdateRequest.md index db812550b..25153bad0 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/EntitlementBulkUpdateRequest.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/EntitlementBulkUpdateRequest.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/GetHistoricalIdentityEvents200ResponseInner.md b/docs/tools/sdk/powershell/Reference/V2025/Models/GetHistoricalIdentityEvents200ResponseInner.md index b9048b56a..3a2d2066d 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/GetHistoricalIdentityEvents200ResponseInner.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/GetHistoricalIdentityEvents200ResponseInner.md @@ -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 ``` diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/IdentityCertified.md b/docs/tools/sdk/powershell/Reference/V2025/Models/IdentityCertified.md index 5e94f4806..d536975d4 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/IdentityCertified.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/IdentityCertified.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/ListIdentityAccessItems200ResponseInner.md b/docs/tools/sdk/powershell/Reference/V2025/Models/ListIdentityAccessItems200ResponseInner.md index 078ffd4d2..2fe7700e8 100644 --- a/docs/tools/sdk/powershell/Reference/V2025/Models/ListIdentityAccessItems200ResponseInner.md +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/ListIdentityAccessItems200ResponseInner.md @@ -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 diff --git a/docs/tools/sdk/powershell/Reference/V2025/Models/ListIdentitySnapshotAccessItems200ResponseInner.md b/docs/tools/sdk/powershell/Reference/V2025/Models/ListIdentitySnapshotAccessItems200ResponseInner.md new file mode 100644 index 000000000..b338b29e3 --- /dev/null +++ b/docs/tools/sdk/powershell/Reference/V2025/Models/ListIdentitySnapshotAccessItems200ResponseInner.md @@ -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]](#) + diff --git a/static/code-examples/beta/powershell_code_examples_overlay.yaml b/static/code-examples/beta/powershell_code_examples_overlay.yaml index 0c9414252..6d1c73c84 100644 --- a/static/code-examples/beta/powershell_code_examples_overlay.yaml +++ b/static/code-examples/beta/powershell_code_examples_overlay.yaml @@ -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 diff --git a/static/code-examples/v2024/powershell_code_examples_overlay.yaml b/static/code-examples/v2024/powershell_code_examples_overlay.yaml index f00061cb9..01652f50b 100644 --- a/static/code-examples/v2024/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v2024/powershell_code_examples_overlay.yaml @@ -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 diff --git a/static/code-examples/v2025/powershell_code_examples_overlay.yaml b/static/code-examples/v2025/powershell_code_examples_overlay.yaml index aaa2ff1a5..59a6d3143 100644 --- a/static/code-examples/v2025/powershell_code_examples_overlay.yaml +++ b/static/code-examples/v2025/powershell_code_examples_overlay.yaml @@ -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