mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-09 12:27:47 +00:00
Update to powershell SDK docs: 13123805130
This commit is contained in:
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessConstraint', 'BetaAccessConstra
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | **Enum** [ "ENTITLEMENT", "ACCESS_PROFILE", "ROLE" ] | Type of Access | [required]
|
||||
**Ids** | Pointer to **[]String** | Must be set only if operator is SELECTED. | [optional]
|
||||
**Operator** | **Enum** [ "ALL", "SELECTED" ] | Used to determine whether the scope of the campaign should be reduced for selected ids or all. | [required]
|
||||
**Type** | **Enum** [ "ENTITLEMENT", "ACCESS_PROFILE", "ROLE" ] | Type of Access | [required]
|
||||
**Ids** | **[]String** | Must be set only if operator is SELECTED. | [optional]
|
||||
**Operator** | **Enum** [ "ALL", "SELECTED" ] | Used to determine whether the scope of the campaign should be reduced for selected ids or all. | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccessCriteria', 'BetaAccessCriteria'
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Name** | Pointer to **String** | Business name for the access construct list | [optional]
|
||||
**CriteriaList** | Pointer to [**[]AccessCriteriaCriteriaListInner**](access-criteria-criteria-list-inner) | List of criteria. There is a min of 1 and max of 50 items in the list. | [optional]
|
||||
**Name** | **String** | Business name for the access construct list | [optional]
|
||||
**CriteriaList** | [**[]AccessCriteriaCriteriaListInner**](access-criteria-criteria-list-inner) | List of criteria. There is a min of 1 and max of 50 items in the list. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessCriteriaCriteriaListInner', 'Be
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | Pointer to **Enum** [ "ENTITLEMENT" ] | DTO type | [optional]
|
||||
**Id** | Pointer to **String** | ID of the object to which this reference applies to | [optional]
|
||||
**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies to | [optional]
|
||||
**Type** | **Enum** [ "ENTITLEMENT" ] | DTO type | [optional]
|
||||
**Id** | **String** | ID of the object to which this reference applies to | [optional]
|
||||
**Name** | **String** | Human-readable display name of the object to which this reference applies to | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,18 +16,18 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemAccessProfileResponse', 'Be
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**AccessType** | Pointer to **String** | the access item type. accessProfile in this case | [optional]
|
||||
**Id** | Pointer to **String** | the access item id | [optional]
|
||||
**Name** | Pointer to **String** | the access profile name | [optional]
|
||||
**SourceName** | Pointer to **String** | the name of the source | [optional]
|
||||
**SourceId** | Pointer to **String** | the id of the source | [optional]
|
||||
**Description** | Pointer to **String** | the description for the access profile | [optional]
|
||||
**DisplayName** | Pointer to **String** | the display name of the identity | [optional]
|
||||
**EntitlementCount** | Pointer to **String** | the number of entitlements the access profile will create | [optional]
|
||||
**AppDisplayName** | Pointer to **String** | the name of | [optional]
|
||||
**RemoveDate** | Pointer to **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]
|
||||
**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]
|
||||
**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]
|
||||
**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]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,13 +16,13 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemAccountResponse', 'BetaAcce
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**AccessType** | Pointer to **String** | the access item type. account in this case | [optional]
|
||||
**Id** | Pointer to **String** | the access item id | [optional]
|
||||
**NativeIdentity** | Pointer to **String** | the native identifier used to uniquely identify an acccount | [optional]
|
||||
**SourceName** | Pointer to **String** | the name of the source | [optional]
|
||||
**SourceId** | Pointer to **String** | the id of the source | [optional]
|
||||
**EntitlementCount** | Pointer to **String** | the number of entitlements the account will create | [optional]
|
||||
**DisplayName** | Pointer to **String** | the display name of the identity | [optional]
|
||||
**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]
|
||||
**DisplayName** | **String** | the display name of the identity | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,11 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemAppResponse', 'BetaAccessIt
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**AccessType** | Pointer to **String** | the access item type. entitlement in this case | [optional]
|
||||
**Id** | Pointer to **String** | the access item id | [optional]
|
||||
**DisplayName** | Pointer to **String** | the access item display name | [optional]
|
||||
**SourceName** | Pointer to **String** | the associated source name if it exists | [optional]
|
||||
**AppRoleId** | Pointer to **String** | the app role id | [optional]
|
||||
**AccessType** | **String** | the access item type. entitlement in this case | [optional]
|
||||
**Id** | **String** | the access item id | [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]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemApproverDto', 'BetaAccessIt
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | Pointer to **Enum** [ "IDENTITY" ] | DTO type of identity who approved the access item request. | [optional]
|
||||
**Id** | Pointer to **String** | ID of identity who approved the access item request. | [optional]
|
||||
**Name** | Pointer to **String** | Human-readable display name of identity who approved the access item request. | [optional]
|
||||
**Type** | **Enum** [ "IDENTITY" ] | DTO type of identity who approved the access item request. | [optional]
|
||||
**Id** | **String** | ID of identity who approved the access item request. | [optional]
|
||||
**Name** | **String** | Human-readable display name of identity who approved the access item request. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,11 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemAssociated', 'BetaAccessIte
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**AccessItem** | Pointer to [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional]
|
||||
**IdentityId** | Pointer to **String** | the identity id | [optional]
|
||||
**EventType** | Pointer to **String** | the event type | [optional]
|
||||
**Dt** | Pointer to **String** | the date of event | [optional]
|
||||
**GovernanceEvent** | Pointer to [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [optional]
|
||||
**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]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,25 +16,25 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemAssociatedAccessItem', 'Bet
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**AccessType** | Pointer to **String** | the access item type. role in this case | [optional]
|
||||
**Id** | Pointer to **String** | the access item id | [optional]
|
||||
**Name** | Pointer to **String** | the access profile name | [optional]
|
||||
**SourceName** | Pointer to **String** | the associated source name if it exists | [optional]
|
||||
**SourceId** | Pointer to **String** | the id of the source | [optional]
|
||||
**Description** | Pointer to **String** | the description for the role | [optional]
|
||||
**DisplayName** | Pointer to **String** | the role display name | [optional]
|
||||
**EntitlementCount** | Pointer to **String** | the number of entitlements the account will create | [optional]
|
||||
**AppDisplayName** | Pointer to **String** | the name of | [optional]
|
||||
**RemoveDate** | Pointer to **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** | Pointer to **String** | the native identifier used to uniquely identify an acccount | [optional]
|
||||
**AppRoleId** | Pointer to **String** | the app role id | [optional]
|
||||
**Attribute** | Pointer to **String** | the entitlement attribute | [optional]
|
||||
**Value** | Pointer to **String** | the associated value | [optional]
|
||||
**EntitlementType** | Pointer to **String** | the type of entitlement | [optional]
|
||||
**Privileged** | **Boolean** | indicates whether the entitlement is privileged | [required]
|
||||
**CloudGoverned** | **Boolean** | indicates whether the entitlement is cloud governed | [required]
|
||||
**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]
|
||||
**SourceName** | **String** | the associated source name if it exists | [optional]
|
||||
**SourceId** | **String** | the id of the source | [optional]
|
||||
**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]
|
||||
**Privileged** | **Boolean** | indicates whether the entitlement is privileged | [required]
|
||||
**CloudGoverned** | **Boolean** | indicates whether the entitlement is cloud governed | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,10 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemDiff', 'BetaAccessItemDiff'
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | Pointer to **String** | the id of the access item | [optional]
|
||||
**EventType** | Pointer to **Enum** [ "ADD", "REMOVE" ] | | [optional]
|
||||
**DisplayName** | Pointer to **String** | the display name of the access item | [optional]
|
||||
**SourceName** | Pointer to **String** | the source name of the access item | [optional]
|
||||
**Id** | **String** | the id of the access item | [optional]
|
||||
**EventType** | **Enum** [ "ADD", "REMOVE" ] | | [optional]
|
||||
**DisplayName** | **String** | the display name of the access item | [optional]
|
||||
**SourceName** | **String** | the source name of the access item | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,18 +16,18 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemEntitlementResponse', 'Beta
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**AccessType** | Pointer to **String** | the access item type. entitlement in this case | [optional]
|
||||
**Id** | Pointer to **String** | the access item id | [optional]
|
||||
**Attribute** | Pointer to **String** | the entitlement attribute | [optional]
|
||||
**Value** | Pointer to **String** | the associated value | [optional]
|
||||
**EntitlementType** | Pointer to **String** | the type of entitlement | [optional]
|
||||
**SourceName** | Pointer to **String** | the name of the source | [optional]
|
||||
**SourceId** | Pointer to **String** | the id of the source | [optional]
|
||||
**Description** | Pointer to **String** | the description for the entitlment | [optional]
|
||||
**DisplayName** | Pointer to **String** | the display name of the identity | [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]
|
||||
**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]
|
||||
**DisplayName** | **String** | the display name of the identity | [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]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemOwnerDto', 'BetaAccessItemO
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | Pointer to **Enum** [ "IDENTITY" ] | Access item owner's DTO type. | [optional]
|
||||
**Id** | Pointer to **String** | Access item owner's identity ID. | [optional]
|
||||
**Name** | Pointer to **String** | Access item owner's human-readable display name. | [optional]
|
||||
**Type** | **Enum** [ "IDENTITY" ] | Access item owner's DTO type. | [optional]
|
||||
**Id** | **String** | Access item owner's identity ID. | [optional]
|
||||
**Name** | **String** | Access item owner's human-readable display name. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemRef', 'BetaAccessItemRef']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | Pointer to **String** | ID of the access item to retrieve the recommendation for. | [optional]
|
||||
**Type** | Pointer to **Enum** [ "ENTITLEMENT", "ACCESS_PROFILE", "ROLE" ] | Access item's type. | [optional]
|
||||
**Id** | **String** | ID of the access item to retrieve the recommendation for. | [optional]
|
||||
**Type** | **Enum** [ "ENTITLEMENT", "ACCESS_PROFILE", "ROLE" ] | Access item's type. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,11 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemRemoved', 'BetaAccessItemRe
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**AccessItem** | Pointer to [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional]
|
||||
**IdentityId** | Pointer to **String** | the identity id | [optional]
|
||||
**EventType** | Pointer to **String** | the event type | [optional]
|
||||
**Dt** | Pointer to **String** | the date of event | [optional]
|
||||
**GovernanceEvent** | Pointer to [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [optional]
|
||||
**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]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemRequestedForDto', 'BetaAcce
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | Pointer to **Enum** [ "IDENTITY" ] | DTO type of identity the access item is requested for. | [optional]
|
||||
**Id** | Pointer to **String** | ID of identity the access item is requested for. | [optional]
|
||||
**Name** | Pointer to **String** | Human-readable display name of identity the access item is requested for. | [optional]
|
||||
**Type** | **Enum** [ "IDENTITY" ] | DTO type of identity the access item is requested for. | [optional]
|
||||
**Id** | **String** | ID of identity the access item is requested for. | [optional]
|
||||
**Name** | **String** | Human-readable display name of identity the access item is requested for. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemRequester', 'BetaAccessItem
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | Pointer to **Enum** [ "IDENTITY" ] | Access item requester's DTO type. | [optional]
|
||||
**Id** | Pointer to **String** | Access item requester's identity ID. | [optional]
|
||||
**Name** | Pointer to **String** | Access item owner's human-readable display name. | [optional]
|
||||
**Type** | **Enum** [ "IDENTITY" ] | Access item requester's DTO type. | [optional]
|
||||
**Id** | **String** | Access item requester's identity ID. | [optional]
|
||||
**Name** | **String** | Access item owner's human-readable display name. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemRequesterDto', 'BetaAccessI
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | Pointer to **Enum** [ "IDENTITY" ] | Access item requester's DTO type. | [optional]
|
||||
**Id** | Pointer to **String** | Access item requester's identity ID. | [optional]
|
||||
**Name** | Pointer to **String** | Access item owner's human-readable display name. | [optional]
|
||||
**Type** | **Enum** [ "IDENTITY" ] | Access item requester's DTO type. | [optional]
|
||||
**Id** | **String** | Access item requester's identity ID. | [optional]
|
||||
**Name** | **String** | Access item owner's human-readable display name. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemReviewedBy', 'BetaAccessIte
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | Pointer to **Enum** [ "IDENTITY" ] | DTO type of identity who reviewed the access item request. | [optional]
|
||||
**Id** | Pointer to **String** | ID of identity who reviewed the access item request. | [optional]
|
||||
**Name** | Pointer to **String** | Human-readable display name of identity who reviewed the access item request. | [optional]
|
||||
**Type** | **Enum** [ "IDENTITY" ] | DTO type of identity who reviewed the access item request. | [optional]
|
||||
**Id** | **String** | ID of identity who reviewed the access item request. | [optional]
|
||||
**Name** | **String** | Human-readable display name of identity who reviewed the access item request. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,13 +16,13 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemRoleResponse', 'BetaAccessI
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**AccessType** | Pointer to **String** | the access item type. role in this case | [optional]
|
||||
**Id** | Pointer to **String** | the access item id | [optional]
|
||||
**DisplayName** | Pointer to **String** | the role display name | [optional]
|
||||
**Description** | Pointer to **String** | the description for the role | [optional]
|
||||
**SourceName** | Pointer to **String** | the associated source name if it exists | [optional]
|
||||
**RemoveDate** | Pointer to **String** | the date the role is no longer assigned to the specified identity | [optional]
|
||||
**Revocable** | **Boolean** | indicates whether the role is revocable | [required]
|
||||
**AccessType** | **String** | the access item type. role in this case | [optional]
|
||||
**Id** | **String** | the access item id | [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]
|
||||
**RemoveDate** | **String** | the date the role is no longer assigned to the specified identity | [optional]
|
||||
**Revocable** | **Boolean** | indicates whether the role is revocable | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,20 +16,20 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfile', 'BetaAccessProfile']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | Pointer to **String** | The ID of the Access Profile | [optional] [readonly]
|
||||
**Name** | **String** | Name of the Access Profile | [required]
|
||||
**Description** | Pointer to **String** | Information about the Access Profile | [optional]
|
||||
**Created** | Pointer to **System.DateTime** | Date the Access Profile was created | [optional] [readonly]
|
||||
**Modified** | Pointer to **System.DateTime** | Date the Access Profile was last modified. | [optional] [readonly]
|
||||
**Enabled** | Pointer to **Boolean** | Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement. | [optional] [default to $true]
|
||||
**Owner** | [**OwnerReference**](owner-reference) | | [required]
|
||||
**Source** | [**AccessProfileSourceRef**](access-profile-source-ref) | | [required]
|
||||
**Entitlements** | Pointer to [**[]EntitlementRef**](entitlement-ref) | A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. | [optional]
|
||||
**Requestable** | Pointer to **Boolean** | Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error. | [optional] [default to $true]
|
||||
**AccessRequestConfig** | Pointer to [**Requestability**](requestability) | | [optional]
|
||||
**RevocationRequestConfig** | Pointer to [**Revocability**](revocability) | | [optional]
|
||||
**Segments** | Pointer to **[]String** | List of IDs of segments, if any, to which this Access Profile is assigned. | [optional]
|
||||
**ProvisioningCriteria** | Pointer to [**ProvisioningCriteriaLevel1**](provisioning-criteria-level1) | | [optional]
|
||||
**Id** | **String** | The ID of the Access Profile | [optional] [readonly]
|
||||
**Name** | **String** | Name of the Access Profile | [required]
|
||||
**Description** | **String** | Information about the Access Profile | [optional]
|
||||
**Created** | **System.DateTime** | Date the Access Profile was created | [optional] [readonly]
|
||||
**Modified** | **System.DateTime** | Date the Access Profile was last modified. | [optional] [readonly]
|
||||
**Enabled** | **Boolean** | Whether the Access Profile is enabled. If the Access Profile is enabled then you must include at least one Entitlement. | [optional] [default to $true]
|
||||
**Owner** | [**OwnerReference**](owner-reference) | | [required]
|
||||
**Source** | [**AccessProfileSourceRef**](access-profile-source-ref) | | [required]
|
||||
**Entitlements** | [**[]EntitlementRef**](entitlement-ref) | A list of entitlements associated with the Access Profile. If enabled is false this is allowed to be empty otherwise it needs to contain at least one Entitlement. | [optional]
|
||||
**Requestable** | **Boolean** | Whether the Access Profile is requestable via access request. Currently, making an Access Profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an Access Profile with a value **false** in this field results in a 400 error. | [optional] [default to $true]
|
||||
**AccessRequestConfig** | [**Requestability**](requestability) | | [optional]
|
||||
**RevocationRequestConfig** | [**Revocability**](revocability) | | [optional]
|
||||
**Segments** | **[]String** | List of IDs of segments, if any, to which this Access Profile is assigned. | [optional]
|
||||
**ProvisioningCriteria** | [**ProvisioningCriteriaLevel1**](provisioning-criteria-level1) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileApprovalScheme', 'BetaAc
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**ApproverType** | Pointer to **Enum** [ "APP_OWNER", "OWNER", "SOURCE_OWNER", "MANAGER", "GOVERNANCE_GROUP" ] | Describes the individual or group that is responsible for an approval step. Values are as follows. **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional]
|
||||
**ApproverId** | Pointer to **String** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP | [optional]
|
||||
**ApproverType** | **Enum** [ "APP_OWNER", "OWNER", "SOURCE_OWNER", "MANAGER", "GOVERNANCE_GROUP" ] | Describes the individual or group that is responsible for an approval step. Values are as follows. **APP_OWNER**: The owner of the Application **OWNER**: Owner of the associated Access Profile or Role **SOURCE_OWNER**: Owner of the Source associated with an Access Profile **MANAGER**: Manager of the Identity making the request **GOVERNANCE_GROUP**: A Governance Group, the ID of which is specified by the **approverId** field | [optional]
|
||||
**ApproverId** | **String** | Id of the specific approver, used only when approverType is GOVERNANCE_GROUP | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkDeleteRequest', 'Bet
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**AccessProfileIds** | Pointer to **[]String** | List of IDs of Access Profiles to be deleted. | [optional]
|
||||
**BestEffortOnly** | Pointer to **Boolean** | If **true**, silently skip over any of the specified Access Profiles if they cannot be deleted because they are in use. If **false**, no deletions will be attempted if any of the Access Profiles are in use. | [optional]
|
||||
**AccessProfileIds** | **[]String** | List of IDs of Access Profiles to be deleted. | [optional]
|
||||
**BestEffortOnly** | **Boolean** | If **true**, silently skip over any of the specified Access Profiles if they cannot be deleted because they are in use. If **false**, no deletions will be attempted if any of the Access Profiles are in use. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkDeleteResponse', 'Be
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**TaskId** | Pointer to **String** | ID of the task which is executing the bulk deletion. This can be passed to the **/task-status** API to track status. | [optional]
|
||||
**Pending** | Pointer to **[]String** | List of IDs of Access Profiles which are pending deletion. | [optional]
|
||||
**InUse** | Pointer to [**[]AccessProfileUsage**](access-profile-usage) | List of usages of Access Profiles targeted for deletion. | [optional]
|
||||
**TaskId** | **String** | ID of the task which is executing the bulk deletion. This can be passed to the **/task-status** API to track status. | [optional]
|
||||
**Pending** | **[]String** | List of IDs of Access Profiles which are pending deletion. | [optional]
|
||||
**InUse** | [**[]AccessProfileUsage**](access-profile-usage) | List of usages of Access Profiles targeted for deletion. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileBulkUpdateRequestInner',
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | Pointer to **String** | Access Profile ID. | [optional]
|
||||
**Requestable** | Pointer to **Boolean** | Access Profile is requestable or not. | [optional]
|
||||
**Id** | **String** | Access Profile ID. | [optional]
|
||||
**Requestable** | **Boolean** | Access Profile is requestable or not. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,29 +16,29 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileDetails', 'BetaAccessPro
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | Pointer to **String** | The ID of the Access Profile | [optional]
|
||||
**Name** | Pointer to **String** | Name of the Access Profile | [optional]
|
||||
**Description** | Pointer to **String** | Information about the Access Profile | [optional]
|
||||
**Created** | Pointer to **System.DateTime** | Date the Access Profile was created | [optional]
|
||||
**Modified** | Pointer to **System.DateTime** | Date the Access Profile was last modified. | [optional]
|
||||
**Disabled** | Pointer to **Boolean** | Whether the Access Profile is enabled. | [optional] [default to $true]
|
||||
**Requestable** | Pointer to **Boolean** | Whether the Access Profile is requestable via access request. | [optional] [default to $false]
|
||||
**Protected** | Pointer to **Boolean** | Whether the Access Profile is protected. | [optional] [default to $false]
|
||||
**OwnerId** | Pointer to **String** | The owner ID of the Access Profile | [optional]
|
||||
**SourceId** | Pointer to **Int64** | The source ID of the Access Profile | [optional]
|
||||
**SourceName** | Pointer to **String** | The source name of the Access Profile | [optional]
|
||||
**AppId** | Pointer to **Int64** | The source app ID of the Access Profile | [optional]
|
||||
**AppName** | Pointer to **String** | The source app name of the Access Profile | [optional]
|
||||
**ApplicationId** | Pointer to **String** | The id of the application | [optional]
|
||||
**Type** | Pointer to **String** | The type of the access profile | [optional]
|
||||
**Entitlements** | Pointer to **[]String** | List of IDs of entitlements | [optional]
|
||||
**EntitlementCount** | Pointer to **Int32** | The number of entitlements in the access profile | [optional]
|
||||
**Segments** | Pointer to **[]String** | List of IDs of segments, if any, to which this Access Profile is assigned. | [optional]
|
||||
**ApprovalSchemes** | Pointer to **String** | Comma-separated list of approval schemes. Each approval scheme is one of - manager - appOwner - sourceOwner - accessProfileOwner - workgroup:<workgroupId> | [optional]
|
||||
**RevokeRequestApprovalSchemes** | Pointer to **String** | Comma-separated list of revoke request approval schemes. Each approval scheme is one of - manager - sourceOwner - accessProfileOwner - workgroup:<workgroupId> | [optional]
|
||||
**RequestCommentsRequired** | Pointer to **Boolean** | Whether the access profile require request comment for access request. | [optional] [default to $false]
|
||||
**DeniedCommentsRequired** | Pointer to **Boolean** | Whether denied comment is required when access request is denied. | [optional] [default to $false]
|
||||
**AccountSelector** | Pointer to [**AccessProfileDetailsAccountSelector**](access-profile-details-account-selector) | | [optional]
|
||||
**Id** | **String** | The ID of the Access Profile | [optional]
|
||||
**Name** | **String** | Name of the Access Profile | [optional]
|
||||
**Description** | **String** | Information about the Access Profile | [optional]
|
||||
**Created** | **System.DateTime** | Date the Access Profile was created | [optional]
|
||||
**Modified** | **System.DateTime** | Date the Access Profile was last modified. | [optional]
|
||||
**Disabled** | **Boolean** | Whether the Access Profile is enabled. | [optional] [default to $true]
|
||||
**Requestable** | **Boolean** | Whether the Access Profile is requestable via access request. | [optional] [default to $false]
|
||||
**Protected** | **Boolean** | Whether the Access Profile is protected. | [optional] [default to $false]
|
||||
**OwnerId** | **String** | The owner ID of the Access Profile | [optional]
|
||||
**SourceId** | **Int64** | The source ID of the Access Profile | [optional]
|
||||
**SourceName** | **String** | The source name of the Access Profile | [optional]
|
||||
**AppId** | **Int64** | The source app ID of the Access Profile | [optional]
|
||||
**AppName** | **String** | The source app name of the Access Profile | [optional]
|
||||
**ApplicationId** | **String** | The id of the application | [optional]
|
||||
**Type** | **String** | The type of the access profile | [optional]
|
||||
**Entitlements** | **[]String** | List of IDs of entitlements | [optional]
|
||||
**EntitlementCount** | **Int32** | The number of entitlements in the access profile | [optional]
|
||||
**Segments** | **[]String** | List of IDs of segments, if any, to which this Access Profile is assigned. | [optional]
|
||||
**ApprovalSchemes** | **String** | Comma-separated list of approval schemes. Each approval scheme is one of - manager - appOwner - sourceOwner - accessProfileOwner - workgroup:<workgroupId> | [optional]
|
||||
**RevokeRequestApprovalSchemes** | **String** | Comma-separated list of revoke request approval schemes. Each approval scheme is one of - manager - sourceOwner - accessProfileOwner - workgroup:<workgroupId> | [optional]
|
||||
**RequestCommentsRequired** | **Boolean** | Whether the access profile require request comment for access request. | [optional] [default to $false]
|
||||
**DeniedCommentsRequired** | **Boolean** | Whether denied comment is required when access request is denied. | [optional] [default to $false]
|
||||
**AccountSelector** | [**AccessProfileDetailsAccountSelector**](access-profile-details-account-selector) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileDetailsAccountSelector',
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Selectors** | Pointer to [**[]Selector**](selector) | | [optional]
|
||||
**Selectors** | [**[]Selector**](selector) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileRef', 'BetaAccessProfile
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | Pointer to **String** | ID of the Access Profile | [optional]
|
||||
**Type** | Pointer to **Enum** [ "ACCESS_PROFILE" ] | Type of requested object. This field must be either left null or set to 'ACCESS_PROFILE' when creating an Access Profile, otherwise a 400 Bad Request error will result. | [optional]
|
||||
**Name** | Pointer to **String** | Human-readable display name of the Access Profile. This field is ignored on input. | [optional]
|
||||
**Id** | **String** | ID of the Access Profile | [optional]
|
||||
**Type** | **Enum** [ "ACCESS_PROFILE" ] | Type of requested object. This field must be either left null or set to 'ACCESS_PROFILE' when creating an Access Profile, otherwise a 400 Bad Request error will result. | [optional]
|
||||
**Name** | **String** | Human-readable display name of the Access Profile. This field is ignored on input. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileSourceRef', 'BetaAccessP
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | Pointer to **String** | The ID of the Source with with which the Access Profile is associated | [optional]
|
||||
**Type** | Pointer to **Enum** [ "SOURCE" ] | The type of the Source, will always be SOURCE | [optional]
|
||||
**Name** | Pointer to **String** | The display name of the associated Source | [optional]
|
||||
**Id** | **String** | The ID of the Source with with which the Access Profile is associated | [optional]
|
||||
**Type** | **Enum** [ "SOURCE" ] | The type of the Source, will always be SOURCE | [optional]
|
||||
**Name** | **String** | The display name of the associated Source | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,10 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileUpdateItem', 'BetaAccess
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | Identifier of Access Profile in bulk update request. | [required]
|
||||
**Requestable** | **Boolean** | Access Profile requestable or not. | [required]
|
||||
**Status** | **String** | The HTTP response status code returned for an individual Access Profile that is requested for update during a bulk update operation. > 201 - Access profile is updated successfully. > 404 - Access profile not found. | [required]
|
||||
**Description** | Pointer to **String** | Human readable status description and containing additional context information about success or failures etc. | [optional]
|
||||
**Id** | **String** | Identifier of Access Profile in bulk update request. | [required]
|
||||
**Requestable** | **Boolean** | Access Profile requestable or not. | [required]
|
||||
**Status** | **String** | The HTTP response status code returned for an individual Access Profile that is requested for update during a bulk update operation. > 201 - Access profile is updated successfully. > 404 - Access profile not found. | [required]
|
||||
**Description** | **String** | Human readable status description and containing additional context information about success or failures etc. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileUsage', 'BetaAccessProfi
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**AccessProfileId** | Pointer to **String** | ID of the Access Profile that is in use | [optional]
|
||||
**UsedBy** | Pointer to [**[]AccessProfileUsageUsedByInner**](access-profile-usage-used-by-inner) | List of references to objects which are using the indicated Access Profile | [optional]
|
||||
**AccessProfileId** | **String** | ID of the Access Profile that is in use | [optional]
|
||||
**UsedBy** | [**[]AccessProfileUsageUsedByInner**](access-profile-usage-used-by-inner) | List of references to objects which are using the indicated Access Profile | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileUsageUsedByInner', 'Beta
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | Pointer to **Enum** [ "ROLE" ] | DTO type of role using the access profile. | [optional]
|
||||
**Id** | Pointer to **String** | ID of role using the access profile. | [optional]
|
||||
**Name** | Pointer to **String** | Display name of role using the access profile. | [optional]
|
||||
**Type** | **Enum** [ "ROLE" ] | DTO type of role using the access profile. | [optional]
|
||||
**Id** | **String** | ID of role using the access profile. | [optional]
|
||||
**Name** | **String** | Display name of role using the access profile. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'AccessRecommendationMessage', 'BetaAc
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Interpretation** | Pointer to **String** | Information about why the access item was recommended. | [optional]
|
||||
**Interpretation** | **String** | Information about why the access item was recommended. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,10 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequest', 'BetaAccessRequest']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**RequestedFor** | **[]String** | A list of Identity IDs for whom the Access is requested. If it's a Revoke request, there can only be one Identity ID. | [required]
|
||||
**RequestType** | Pointer to [**AccessRequestType**](access-request-type) | | [optional]
|
||||
**RequestedItems** | [**[]AccessRequestItem**](access-request-item) | | [required]
|
||||
**ClientMetadata** | Pointer to **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional]
|
||||
**RequestedFor** | **[]String** | A list of Identity IDs for whom the Access is requested. If it's a Revoke request, there can only be one Identity ID. | [required]
|
||||
**RequestType** | [**AccessRequestType**](access-request-type) | | [optional]
|
||||
**RequestedItems** | [**[]AccessRequestItem**](access-request-item) | | [required]
|
||||
**ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,12 +16,12 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestConfig', 'BetaAccessRequ
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**ApprovalsMustBeExternal** | Pointer to **Boolean** | If this is true, approvals must be processed by an external system. Also, if this is true, it blocks Request Center access requests and returns an error for any user who isn't an org admin. | [optional] [default to $false]
|
||||
**AutoApprovalEnabled** | Pointer to **Boolean** | If this is true and the requester and reviewer are the same, the request is automatically approved. | [optional] [default to $false]
|
||||
**ReauthorizationEnabled** | Pointer to **Boolean** | If this is true, reauthorization will be enforced for appropriately configured access items. Enablement of this feature is currently in a limited state. | [optional] [default to $false]
|
||||
**RequestOnBehalfOfConfig** | Pointer to [**RequestOnBehalfOfConfig**](request-on-behalf-of-config) | | [optional]
|
||||
**ApprovalReminderAndEscalationConfig** | Pointer to [**ApprovalReminderAndEscalationConfig**](approval-reminder-and-escalation-config) | | [optional]
|
||||
**EntitlementRequestConfig** | Pointer to [**EntitlementRequestConfig1**](entitlement-request-config1) | | [optional]
|
||||
**ApprovalsMustBeExternal** | **Boolean** | If this is true, approvals must be processed by an external system. Also, if this is true, it blocks Request Center access requests and returns an error for any user who isn't an org admin. | [optional] [default to $false]
|
||||
**AutoApprovalEnabled** | **Boolean** | If this is true and the requester and reviewer are the same, the request is automatically approved. | [optional] [default to $false]
|
||||
**ReauthorizationEnabled** | **Boolean** | If this is true, reauthorization will be enforced for appropriately configured access items. Enablement of this feature is currently in a limited state. | [optional] [default to $false]
|
||||
**RequestOnBehalfOfConfig** | [**RequestOnBehalfOfConfig**](request-on-behalf-of-config) | | [optional]
|
||||
**ApprovalReminderAndEscalationConfig** | [**ApprovalReminderAndEscalationConfig**](approval-reminder-and-escalation-config) | | [optional]
|
||||
**EntitlementRequestConfig** | [**EntitlementRequestConfig1**](entitlement-request-config1) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestContext', 'BetaAccessReq
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**ContextAttributes** | Pointer to [**[]ContextAttributeDto**](context-attribute-dto) | | [optional]
|
||||
**ContextAttributes** | [**[]ContextAttributeDto**](context-attribute-dto) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,10 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestDynamicApprover', 'BetaA
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**AccessRequestId** | **String** | The unique ID of the access request object. Can be used with the [access request status endpoint](https://developer.sailpoint.com/idn/api/beta/list-access-request-status) to get the status of the request. | [required]
|
||||
**RequestedFor** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | [required]
|
||||
**RequestedItems** | [**[]AccessRequestDynamicApproverRequestedItemsInner**](access-request-dynamic-approver-requested-items-inner) | The access items that are being requested. | [required]
|
||||
**RequestedBy** | [**AccessItemRequesterDto**](access-item-requester-dto) | | [required]
|
||||
**AccessRequestId** | **String** | The unique ID of the access request object. Can be used with the [access request status endpoint](https://developer.sailpoint.com/idn/api/beta/list-access-request-status) to get the status of the request. | [required]
|
||||
**RequestedFor** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | [required]
|
||||
**RequestedItems** | [**[]AccessRequestDynamicApproverRequestedItemsInner**](access-request-dynamic-approver-requested-items-inner) | The access items that are being requested. | [required]
|
||||
**RequestedBy** | [**AccessItemRequesterDto**](access-item-requester-dto) | | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestDynamicApprover1', 'Beta
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | The unique ID of the identity to add to the approver list for the access request. | [required]
|
||||
**Name** | **String** | The name of the identity to add to the approver list for the access request. | [required]
|
||||
**Type** | **Enum** [ "IDENTITY", "GOVERNANCE_GROUP" ] | The type of object being referenced. | [required]
|
||||
**Id** | **String** | The unique ID of the identity to add to the approver list for the access request. | [required]
|
||||
**Name** | **String** | The name of the identity to add to the approver list for the access request. | [required]
|
||||
**Type** | **Enum** [ "IDENTITY", "GOVERNANCE_GROUP" ] | The type of object being referenced. | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,12 +16,12 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestDynamicApproverRequested
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | The unique ID of the access item. | [required]
|
||||
**Name** | **String** | Human friendly name of the access item. | [required]
|
||||
**Description** | Pointer to **String** | Extended description of the access item. | [optional]
|
||||
**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | The type of access item being requested. | [required]
|
||||
**Operation** | **Enum** [ "Add", "Remove" ] | Grant or revoke the access item | [required]
|
||||
**Comment** | Pointer to **String** | A comment from the requestor on why the access is needed. | [optional]
|
||||
**Id** | **String** | The unique ID of the access item. | [required]
|
||||
**Name** | **String** | Human friendly name of the access item. | [required]
|
||||
**Description** | **String** | Extended description of the access item. | [optional]
|
||||
**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | The type of access item being requested. | [required]
|
||||
**Operation** | **Enum** [ "Add", "Remove" ] | Grant or revoke the access item | [required]
|
||||
**Comment** | **String** | A comment from the requestor on why the access is needed. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,11 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestItem', 'BetaAccessReques
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | The type of the item being requested. | [required]
|
||||
**Id** | **String** | ID of Role, Access Profile or Entitlement being requested. | [required]
|
||||
**Comment** | Pointer to **String** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional]
|
||||
**ClientMetadata** | Pointer to **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional]
|
||||
**RemoveDate** | Pointer to **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional]
|
||||
**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | The type of the item being requested. | [required]
|
||||
**Id** | **String** | ID of Role, Access Profile or Entitlement being requested. | [required]
|
||||
**Comment** | **String** | Comment provided by requester. * Comment is required when the request is of type Revoke Access. | [optional]
|
||||
**ClientMetadata** | **map[string]String** | Arbitrary key-value pairs. They will never be processed by the IdentityNow system but will be returned on associated APIs such as /account-activities and /access-request-status. | [optional]
|
||||
**RemoveDate** | **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. Also known as the expiration date. * Specify a date in the future. * The current SLA for the deprovisioning is 24 hours. * This date can be modified to either extend or decrease the duration of access item assignments for the specified identity. You can change the expiration date for requests for yourself or direct reports, but you cannot remove an expiration date on an already approved item. If the access request has not been approved, you can cancel it and submit a new one without the expiration. If it has already been approved, then you have to revoke the access and then re-request without the expiration. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,14 +16,14 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestItemResponse', 'BetaAcce
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Operation** | Pointer to **String** | the access request item operation | [optional]
|
||||
**AccessItemType** | Pointer to **String** | the access item type | [optional]
|
||||
**Name** | Pointer to **String** | the name of access request item | [optional]
|
||||
**Decision** | Pointer to **Enum** [ "APPROVED", "REJECTED" ] | the final decision for the access request | [optional]
|
||||
**Description** | Pointer to **String** | the description of access request item | [optional]
|
||||
**SourceId** | Pointer to **String** | the source id | [optional]
|
||||
**SourceName** | Pointer to **String** | the source Name | [optional]
|
||||
**ApprovalInfos** | Pointer to [**[]ApprovalInfoResponse**](approval-info-response) | | [optional]
|
||||
**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
|
||||
|
||||
|
||||
@@ -16,12 +16,12 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestPhases', 'BetaAccessRequ
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Started** | Pointer to **System.DateTime** | The time that this phase started. | [optional]
|
||||
**Finished** | Pointer to **System.DateTime** | The time that this phase finished. | [optional]
|
||||
**Name** | Pointer to **String** | The name of this phase. | [optional]
|
||||
**State** | Pointer to **Enum** [ "PENDING", "EXECUTING", "COMPLETED", "CANCELLED", "NOT_EXECUTED" ] | The state of this phase. | [optional]
|
||||
**Result** | Pointer to **Enum** [ "SUCCESSFUL", "FAILED" ] | The state of this phase. | [optional]
|
||||
**PhaseReference** | Pointer to **String** | A reference to another object on the RequestedItemStatus that contains more details about the phase. Note that for the Provisioning phase, this will be empty if there are no manual work items. | [optional]
|
||||
**Started** | **System.DateTime** | The time that this phase started. | [optional]
|
||||
**Finished** | **System.DateTime** | The time that this phase finished. | [optional]
|
||||
**Name** | **String** | The name of this phase. | [optional]
|
||||
**State** | **Enum** [ "PENDING", "EXECUTING", "COMPLETED", "CANCELLED", "NOT_EXECUTED" ] | The state of this phase. | [optional]
|
||||
**Result** | **Enum** [ "SUCCESSFUL", "FAILED" ] | The state of this phase. | [optional]
|
||||
**PhaseReference** | **String** | A reference to another object on the RequestedItemStatus that contains more details about the phase. Note that for the Provisioning phase, this will be empty if there are no manual work items. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,10 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApproval', 'BetaAcce
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**AccessRequestId** | **String** | The unique ID of the access request. | [required]
|
||||
**RequestedFor** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | [required]
|
||||
**RequestedItemsStatus** | [**[]AccessRequestPostApprovalRequestedItemsStatusInner**](access-request-post-approval-requested-items-status-inner) | Details on the outcome of each access item. | [required]
|
||||
**RequestedBy** | [**AccessItemRequesterDto**](access-item-requester-dto) | | [required]
|
||||
**AccessRequestId** | **String** | The unique ID of the access request. | [required]
|
||||
**RequestedFor** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | [required]
|
||||
**RequestedItemsStatus** | [**[]AccessRequestPostApprovalRequestedItemsStatusInner**](access-request-post-approval-requested-items-status-inner) | Details on the outcome of each access item. | [required]
|
||||
**RequestedBy** | [**AccessItemRequesterDto**](access-item-requester-dto) | | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,14 +16,14 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApprovalRequestedIte
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | The unique ID of the access item being requested. | [required]
|
||||
**Name** | **String** | The human friendly name of the access item. | [required]
|
||||
**Description** | Pointer to **String** | Detailed description of the access item. | [optional]
|
||||
**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | The type of access item. | [required]
|
||||
**Operation** | **Enum** [ "Add", "Remove" ] | The action to perform on the access item. | [required]
|
||||
**Comment** | Pointer to **String** | A comment from the identity requesting the access. | [optional]
|
||||
**ClientMetadata** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Additional customer defined metadata about the access item. | [optional]
|
||||
**ApprovalInfo** | [**[]AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner**](access-request-post-approval-requested-items-status-inner-approval-info-inner) | A list of one or more approvers for the access request. | [required]
|
||||
**Id** | **String** | The unique ID of the access item being requested. | [required]
|
||||
**Name** | **String** | The human friendly name of the access item. | [required]
|
||||
**Description** | **String** | Detailed description of the access item. | [optional]
|
||||
**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | The type of access item. | [required]
|
||||
**Operation** | **Enum** [ "Add", "Remove" ] | The action to perform on the access item. | [required]
|
||||
**Comment** | **String** | A comment from the identity requesting the access. | [optional]
|
||||
**ClientMetadata** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Additional customer defined metadata about the access item. | [optional]
|
||||
**ApprovalInfo** | [**[]AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner**](access-request-post-approval-requested-items-status-inner-approval-info-inner) | A list of one or more approvers for the access request. | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,10 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApprovalRequestedIte
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**ApprovalComment** | Pointer to **String** | A comment left by the approver. | [optional]
|
||||
**ApprovalDecision** | **Enum** [ "APPROVED", "DENIED" ] | The final decision of the approver. | [required]
|
||||
**ApproverName** | **String** | The name of the approver | [required]
|
||||
**Approver** | [**AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover**](access-request-post-approval-requested-items-status-inner-approval-info-inner-approver) | | [required]
|
||||
**ApprovalComment** | **String** | A comment left by the approver. | [optional]
|
||||
**ApprovalDecision** | **Enum** [ "APPROVED", "DENIED" ] | The final decision of the approver. | [required]
|
||||
**ApproverName** | **String** | The name of the approver | [required]
|
||||
**Approver** | [**AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover**](access-request-post-approval-requested-items-status-inner-approval-info-inner-approver) | | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApprovalRequestedIte
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | **Enum** [ "IDENTITY" ] | The type of object that is referenced | [required]
|
||||
**Id** | **String** | ID of identity who approved the access item request. | [required]
|
||||
**Name** | **String** | Human-readable display name of identity who approved the access item request. | [required]
|
||||
**Type** | **Enum** [ "IDENTITY" ] | The type of object that is referenced | [required]
|
||||
**Id** | **String** | ID of identity who approved the access item request. | [required]
|
||||
**Name** | **String** | Human-readable display name of identity who approved the access item request. | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,10 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestPreApproval', 'BetaAcces
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**AccessRequestId** | **String** | The unique ID of the access request. | [required]
|
||||
**RequestedFor** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | [required]
|
||||
**RequestedItems** | [**[]AccessRequestPreApprovalRequestedItemsInner**](access-request-pre-approval-requested-items-inner) | Details of the access items being requested. | [required]
|
||||
**RequestedBy** | [**AccessItemRequesterDto**](access-item-requester-dto) | | [required]
|
||||
**AccessRequestId** | **String** | The unique ID of the access request. | [required]
|
||||
**RequestedFor** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | [required]
|
||||
**RequestedItems** | [**[]AccessRequestPreApprovalRequestedItemsInner**](access-request-pre-approval-requested-items-inner) | Details of the access items being requested. | [required]
|
||||
**RequestedBy** | [**AccessItemRequesterDto**](access-item-requester-dto) | | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestPreApproval1', 'BetaAcce
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Approved** | **Boolean** | Whether or not to approve the access request. | [required]
|
||||
**Comment** | **String** | A comment about the decision to approve or deny the request. | [required]
|
||||
**Approver** | **String** | The name of the entity that approved or denied the request. | [required]
|
||||
**Approved** | **Boolean** | Whether or not to approve the access request. | [required]
|
||||
**Comment** | **String** | A comment about the decision to approve or deny the request. | [required]
|
||||
**Approver** | **String** | The name of the entity that approved or denied the request. | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,12 +16,12 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestPreApprovalRequestedItem
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | The unique ID of the access item being requested. | [required]
|
||||
**Name** | **String** | The human friendly name of the access item. | [required]
|
||||
**Description** | Pointer to **String** | Detailed description of the access item. | [optional]
|
||||
**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | The type of access item. | [required]
|
||||
**Operation** | **Enum** [ "Add", "Remove" ] | The action to perform on the access item. | [required]
|
||||
**Comment** | Pointer to **String** | A comment from the identity requesting the access. | [optional]
|
||||
**Id** | **String** | The unique ID of the access item being requested. | [required]
|
||||
**Name** | **String** | The human friendly name of the access item. | [required]
|
||||
**Description** | **String** | Detailed description of the access item. | [optional]
|
||||
**Type** | **Enum** [ "ACCESS_PROFILE", "ROLE", "ENTITLEMENT" ] | The type of access item. | [required]
|
||||
**Operation** | **Enum** [ "Add", "Remove" ] | The action to perform on the access item. | [required]
|
||||
**Comment** | **String** | A comment from the identity requesting the access. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationActionItem
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**IdentityId** | **String** | The identity ID taking the action. | [required]
|
||||
**Access** | [**AccessRequestRecommendationItem**](access-request-recommendation-item) | | [required]
|
||||
**IdentityId** | **String** | The identity ID taking the action. | [required]
|
||||
**Access** | [**AccessRequestRecommendationItem**](access-request-recommendation-item) | | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationActionItem
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**IdentityId** | Pointer to **String** | The identity ID taking the action. | [optional]
|
||||
**Access** | Pointer to [**AccessRequestRecommendationItem**](access-request-recommendation-item) | | [optional]
|
||||
**Timestamp** | Pointer to **System.DateTime** | | [optional]
|
||||
**IdentityId** | **String** | The identity ID taking the action. | [optional]
|
||||
**Access** | [**AccessRequestRecommendationItem**](access-request-recommendation-item) | | [optional]
|
||||
**Timestamp** | **System.DateTime** | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItem', 'Be
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | Pointer to **String** | ID of access item being recommended. | [optional]
|
||||
**Type** | Pointer to [**AccessRequestRecommendationItemType**](access-request-recommendation-item-type) | | [optional]
|
||||
**Id** | **String** | ID of access item being recommended. | [optional]
|
||||
**Type** | [**AccessRequestRecommendationItemType**](access-request-recommendation-item-type) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,13 +16,13 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItemDetail
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**IdentityId** | Pointer to **String** | Identity ID for the recommendation | [optional]
|
||||
**Access** | Pointer to [**AccessRequestRecommendationItemDetailAccess**](access-request-recommendation-item-detail-access) | | [optional]
|
||||
**Ignored** | Pointer to **Boolean** | Whether or not the identity has already chosen to ignore this recommendation. | [optional]
|
||||
**Requested** | Pointer to **Boolean** | Whether or not the identity has already chosen to request this recommendation. | [optional]
|
||||
**Viewed** | Pointer to **Boolean** | Whether or not the identity reportedly viewed this recommendation. | [optional]
|
||||
**Messages** | Pointer to [**[]AccessRecommendationMessage**](access-recommendation-message) | | [optional]
|
||||
**TranslationMessages** | Pointer to [**[]TranslationMessage**](translation-message) | The list of translation messages | [optional]
|
||||
**IdentityId** | **String** | Identity ID for the recommendation | [optional]
|
||||
**Access** | [**AccessRequestRecommendationItemDetailAccess**](access-request-recommendation-item-detail-access) | | [optional]
|
||||
**Ignored** | **Boolean** | Whether or not the identity has already chosen to ignore this recommendation. | [optional]
|
||||
**Requested** | **Boolean** | Whether or not the identity has already chosen to request this recommendation. | [optional]
|
||||
**Viewed** | **Boolean** | Whether or not the identity reportedly viewed this recommendation. | [optional]
|
||||
**Messages** | [**[]AccessRecommendationMessage**](access-recommendation-message) | | [optional]
|
||||
**TranslationMessages** | [**[]TranslationMessage**](translation-message) | The list of translation messages | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,10 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationItemDetail
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | Pointer to **String** | ID of access item being recommended. | [optional]
|
||||
**Type** | Pointer to [**AccessRequestRecommendationItemType**](access-request-recommendation-item-type) | | [optional]
|
||||
**Name** | Pointer to **String** | Name of the access item | [optional]
|
||||
**Description** | Pointer to **String** | Description of the access item | [optional]
|
||||
**Id** | **String** | ID of access item being recommended. | [optional]
|
||||
**Type** | [**AccessRequestRecommendationItemType**](access-request-recommendation-item-type) | | [optional]
|
||||
**Name** | **String** | Name of the access item | [optional]
|
||||
**Description** | **String** | Description of the access item | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestResponse', 'BetaAccessRe
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**NewRequests** | Pointer to [**[]AccessRequestTracking**](access-request-tracking) | A list of new access request tracking data mapped to the values requested. | [optional]
|
||||
**ExistingRequests** | Pointer to [**[]AccessRequestTracking**](access-request-tracking) | A list of existing access request tracking data mapped to the values requested. This indicates access has already been requested for this item. | [optional]
|
||||
**NewRequests** | [**[]AccessRequestTracking**](access-request-tracking) | A list of new access request tracking data mapped to the values requested. | [optional]
|
||||
**ExistingRequests** | [**[]AccessRequestTracking**](access-request-tracking) | A list of existing access request tracking data mapped to the values requested. This indicates access has already been requested for this item. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestResponse1', 'BetaAccessR
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**RequesterId** | Pointer to **String** | the requester Id | [optional]
|
||||
**RequesterName** | Pointer to **String** | the requesterName | [optional]
|
||||
**Items** | Pointer to [**[]AccessRequestItemResponse**](access-request-item-response) | | [optional]
|
||||
**RequesterId** | **String** | the requester Id | [optional]
|
||||
**RequesterName** | **String** | the requesterName | [optional]
|
||||
**Items** | [**[]AccessRequestItemResponse**](access-request-item-response) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,10 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestTracking', 'BetaAccessRe
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**RequestedFor** | Pointer to **String** | The identity id in which the access request is for. | [optional]
|
||||
**RequestedItemsDetails** | Pointer to [**[]RequestedItemDetails**](requested-item-details) | The details of the item requested. | [optional]
|
||||
**AttributesHash** | Pointer to **String** | a hash representation of the access requested, useful for longer term tracking client side. | [optional]
|
||||
**AccessRequestIds** | Pointer to **[]String** | a list of access request identifiers, generally only one will be populated, but high volume requested may result in multiple ids. | [optional]
|
||||
**RequestedFor** | **String** | The identity id in which the access request is for. | [optional]
|
||||
**RequestedItemsDetails** | [**[]RequestedItemDetails**](requested-item-details) | The details of the item requested. | [optional]
|
||||
**AttributesHash** | **String** | a hash representation of the access requested, useful for longer term tracking client side. | [optional]
|
||||
**AccessRequestIds** | **[]String** | a list of access request identifiers, generally only one will be populated, but high volume requested may result in multiple ids. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,10 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequested', 'BetaAccessRequeste
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**AccessRequest** | Pointer to [**AccessRequestResponse1**](access-request-response1) | | [optional]
|
||||
**IdentityId** | Pointer to **String** | the identity id | [optional]
|
||||
**EventType** | Pointer to **String** | the event type | [optional]
|
||||
**Dt** | Pointer to **String** | the date of event | [optional]
|
||||
**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]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,34 +16,34 @@ tags: ['SDK', 'Software Development Kit', 'Account', 'BetaAccount']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | Pointer to **String** | System-generated unique ID of the Object | [optional] [readonly]
|
||||
**Name** | **String** | Name of the Object | [required]
|
||||
**Created** | Pointer to **System.DateTime** | Creation date of the Object | [optional] [readonly]
|
||||
**Modified** | Pointer to **System.DateTime** | Last modification date of the Object | [optional] [readonly]
|
||||
**SourceId** | **String** | The unique ID of the source this account belongs to | [required]
|
||||
**SourceName** | **String** | The display name of the source this account belongs to | [required]
|
||||
**IdentityId** | Pointer to **String** | The unique ID of the identity this account is correlated to | [optional]
|
||||
**CloudLifecycleState** | Pointer to **String** | The lifecycle state of the identity this account is correlated to | [optional]
|
||||
**IdentityState** | Pointer to **String** | The identity state of the identity this account is correlated to | [optional]
|
||||
**ConnectionType** | Pointer to **String** | The connection type of the source this account is from | [optional]
|
||||
**IsMachine** | Pointer to **Boolean** | Indicates if the account is of machine type | [optional] [default to $false]
|
||||
**Recommendation** | Pointer to [**Recommendation**](recommendation) | | [optional]
|
||||
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The account attributes that are aggregated | [required]
|
||||
**Authoritative** | **Boolean** | Indicates if this account is from an authoritative source | [required]
|
||||
**Description** | Pointer to **String** | A description of the account | [optional]
|
||||
**Disabled** | **Boolean** | Indicates if the account is currently disabled | [required]
|
||||
**Locked** | **Boolean** | Indicates if the account is currently locked | [required]
|
||||
**NativeIdentity** | **String** | The unique ID of the account generated by the source system | [required]
|
||||
**SystemAccount** | **Boolean** | If true, this is a user account within IdentityNow. If false, this is an account from a source system. | [required]
|
||||
**Uncorrelated** | **Boolean** | Indicates if this account is not correlated to an identity | [required]
|
||||
**Uuid** | Pointer to **String** | The unique ID of the account as determined by the account schema | [optional]
|
||||
**ManuallyCorrelated** | **Boolean** | Indicates if the account has been manually correlated to an identity | [required]
|
||||
**HasEntitlements** | **Boolean** | Indicates if the account has entitlements | [required]
|
||||
**Identity** | Pointer to [**BaseReferenceDto**](base-reference-dto) | | [optional]
|
||||
**SourceOwner** | Pointer to [**BaseReferenceDto**](base-reference-dto) | | [optional]
|
||||
**Features** | Pointer to **String** | A string list containing the owning source's features | [optional]
|
||||
**Origin** | Pointer to **Enum** [ "AGGREGATED", "PROVISIONED" ] | The origin of the account either aggregated or provisioned | [optional]
|
||||
**OwnerIdentity** | Pointer to [**BaseReferenceDto**](base-reference-dto) | | [optional]
|
||||
**Id** | **String** | System-generated unique ID of the Object | [optional] [readonly]
|
||||
**Name** | **String** | Name of the Object | [required]
|
||||
**Created** | **System.DateTime** | Creation date of the Object | [optional] [readonly]
|
||||
**Modified** | **System.DateTime** | Last modification date of the Object | [optional] [readonly]
|
||||
**SourceId** | **String** | The unique ID of the source this account belongs to | [required]
|
||||
**SourceName** | **String** | The display name of the source this account belongs to | [required]
|
||||
**IdentityId** | **String** | The unique ID of the identity this account is correlated to | [optional]
|
||||
**CloudLifecycleState** | **String** | The lifecycle state of the identity this account is correlated to | [optional]
|
||||
**IdentityState** | **String** | The identity state of the identity this account is correlated to | [optional]
|
||||
**ConnectionType** | **String** | The connection type of the source this account is from | [optional]
|
||||
**IsMachine** | **Boolean** | Indicates if the account is of machine type | [optional] [default to $false]
|
||||
**Recommendation** | [**Recommendation**](recommendation) | | [optional]
|
||||
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The account attributes that are aggregated | [required]
|
||||
**Authoritative** | **Boolean** | Indicates if this account is from an authoritative source | [required]
|
||||
**Description** | **String** | A description of the account | [optional]
|
||||
**Disabled** | **Boolean** | Indicates if the account is currently disabled | [required]
|
||||
**Locked** | **Boolean** | Indicates if the account is currently locked | [required]
|
||||
**NativeIdentity** | **String** | The unique ID of the account generated by the source system | [required]
|
||||
**SystemAccount** | **Boolean** | If true, this is a user account within IdentityNow. If false, this is an account from a source system. | [required]
|
||||
**Uncorrelated** | **Boolean** | Indicates if this account is not correlated to an identity | [required]
|
||||
**Uuid** | **String** | The unique ID of the account as determined by the account schema | [optional]
|
||||
**ManuallyCorrelated** | **Boolean** | Indicates if the account has been manually correlated to an identity | [required]
|
||||
**HasEntitlements** | **Boolean** | Indicates if the account has entitlements | [required]
|
||||
**Identity** | [**BaseReferenceDto**](base-reference-dto) | | [optional]
|
||||
**SourceOwner** | [**BaseReferenceDto**](base-reference-dto) | | [optional]
|
||||
**Features** | **String** | A string list containing the owning source's features | [optional]
|
||||
**Origin** | **Enum** [ "AGGREGATED", "PROVISIONED" ] | The origin of the account either aggregated or provisioned | [optional]
|
||||
**OwnerIdentity** | [**BaseReferenceDto**](base-reference-dto) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccountAction', 'BetaAccountAction']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Action** | Pointer to **Enum** [ "ENABLE", "DISABLE" ] | Describes if action will be enabled or disabled | [optional]
|
||||
**SourceIds** | Pointer to **[]String** | List of source IDs. The sources must have the ENABLE feature or flat file source. See ""/sources"" endpoint for source features. | [optional]
|
||||
**Action** | **Enum** [ "ENABLE", "DISABLE" ] | Describes if action will be enabled or disabled | [optional]
|
||||
**SourceIds** | **[]String** | List of source IDs. The sources must have the ENABLE feature or flat file source. See ""/sources"" endpoint for source features. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,22 +16,22 @@ tags: ['SDK', 'Software Development Kit', 'AccountActivityItem', 'BetaAccountAct
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | Pointer to **String** | Item id | [optional]
|
||||
**Name** | Pointer to **String** | Human-readable display name of item | [optional]
|
||||
**Requested** | Pointer to **System.DateTime** | Date and time item was requested | [optional]
|
||||
**ApprovalStatus** | Pointer to [**AccountActivityApprovalStatus**](account-activity-approval-status) | | [optional]
|
||||
**ProvisioningStatus** | Pointer to [**ProvisioningState**](provisioning-state) | | [optional]
|
||||
**RequesterComment** | Pointer to [**Comment**](comment) | | [optional]
|
||||
**ReviewerIdentitySummary** | Pointer to [**IdentitySummary**](identity-summary) | | [optional]
|
||||
**ReviewerComment** | Pointer to [**Comment**](comment) | | [optional]
|
||||
**Operation** | Pointer to [**AccountActivityItemOperation**](account-activity-item-operation) | | [optional]
|
||||
**Attribute** | Pointer to **String** | Attribute to which account activity applies | [optional]
|
||||
**Value** | Pointer to **String** | Value of attribute | [optional]
|
||||
**NativeIdentity** | Pointer to **String** | Native identity in the target system to which the account activity applies | [optional]
|
||||
**SourceId** | Pointer to **String** | Id of Source to which account activity applies | [optional]
|
||||
**AccountRequestInfo** | Pointer to [**AccountRequestInfo**](account-request-info) | | [optional]
|
||||
**ClientMetadata** | Pointer to **map[string]String** | Arbitrary key-value pairs, if any were included in the corresponding access request item | [optional]
|
||||
**RemoveDate** | Pointer to **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional]
|
||||
**Id** | **String** | Item id | [optional]
|
||||
**Name** | **String** | Human-readable display name of item | [optional]
|
||||
**Requested** | **System.DateTime** | Date and time item was requested | [optional]
|
||||
**ApprovalStatus** | [**AccountActivityApprovalStatus**](account-activity-approval-status) | | [optional]
|
||||
**ProvisioningStatus** | [**ProvisioningState**](provisioning-state) | | [optional]
|
||||
**RequesterComment** | [**Comment**](comment) | | [optional]
|
||||
**ReviewerIdentitySummary** | [**IdentitySummary**](identity-summary) | | [optional]
|
||||
**ReviewerComment** | [**Comment**](comment) | | [optional]
|
||||
**Operation** | [**AccountActivityItemOperation**](account-activity-item-operation) | | [optional]
|
||||
**Attribute** | **String** | Attribute to which account activity applies | [optional]
|
||||
**Value** | **String** | Value of attribute | [optional]
|
||||
**NativeIdentity** | **String** | Native identity in the target system to which the account activity applies | [optional]
|
||||
**SourceId** | **String** | Id of Source to which account activity applies | [optional]
|
||||
**AccountRequestInfo** | [**AccountRequestInfo**](account-request-info) | | [optional]
|
||||
**ClientMetadata** | **map[string]String** | Arbitrary key-value pairs, if any were included in the corresponding access request item | [optional]
|
||||
**RemoveDate** | **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,10 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'AccountAggregation', 'BetaAccountAggr
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Start** | Pointer to **System.DateTime** | When the aggregation started. | [optional]
|
||||
**Status** | Pointer to **Enum** [ "STARTED", "ACCOUNTS_COLLECTED", "COMPLETED", "CANCELLED", "RETRIED", "TERMINATED" ] | STARTED - Aggregation started, but source account iteration has not completed. ACCOUNTS_COLLECTED - Source account iteration completed, but all accounts have not yet been processed. COMPLETED - Aggregation completed (*possibly with errors*). CANCELLED - Aggregation cancelled by user. RETRIED - Aggregation retried because of connectivity issues with the Virtual Appliance. TERMINATED - Aggregation marked as failed after 3 tries after connectivity issues with the Virtual Appliance. | [optional]
|
||||
**TotalAccounts** | Pointer to **Int32** | The total number of *NEW, CHANGED and DELETED* accounts that need to be processed for this aggregation. This does not include accounts that were unchanged since the previous aggregation. This can be zero if there were no new, changed or deleted accounts since the previous aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional]
|
||||
**ProcessedAccounts** | Pointer to **Int32** | The number of *NEW, CHANGED and DELETED* accounts that have been processed so far. This reflects the number of accounts that have been processed at the time of the API call, and may increase on subsequent API calls while the status is ACCOUNTS_COLLECTED. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional]
|
||||
**Start** | **System.DateTime** | When the aggregation started. | [optional]
|
||||
**Status** | **Enum** [ "STARTED", "ACCOUNTS_COLLECTED", "COMPLETED", "CANCELLED", "RETRIED", "TERMINATED" ] | STARTED - Aggregation started, but source account iteration has not completed. ACCOUNTS_COLLECTED - Source account iteration completed, but all accounts have not yet been processed. COMPLETED - Aggregation completed (*possibly with errors*). CANCELLED - Aggregation cancelled by user. RETRIED - Aggregation retried because of connectivity issues with the Virtual Appliance. TERMINATED - Aggregation marked as failed after 3 tries after connectivity issues with the Virtual Appliance. | [optional]
|
||||
**TotalAccounts** | **Int32** | The total number of *NEW, CHANGED and DELETED* accounts that need to be processed for this aggregation. This does not include accounts that were unchanged since the previous aggregation. This can be zero if there were no new, changed or deleted accounts since the previous aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional]
|
||||
**ProcessedAccounts** | **Int32** | The number of *NEW, CHANGED and DELETED* accounts that have been processed so far. This reflects the number of accounts that have been processed at the time of the API call, and may increase on subsequent API calls while the status is ACCOUNTS_COLLECTED. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,13 +16,13 @@ tags: ['SDK', 'Software Development Kit', 'AccountAggregationCompleted', 'BetaAc
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Source** | [**AccountAggregationCompletedSource**](account-aggregation-completed-source) | | [required]
|
||||
**Status** | **Enum** [ "Success", "Failed", "Terminated" ] | The overall status of the aggregation. | [required]
|
||||
**Started** | **System.DateTime** | The date and time when the account aggregation started. | [required]
|
||||
**Completed** | **System.DateTime** | The date and time when the account aggregation finished. | [required]
|
||||
**Errors** | **[]String** | A list of errors that occurred during the aggregation. | [required]
|
||||
**Warnings** | **[]String** | A list of warnings that occurred during the aggregation. | [required]
|
||||
**Stats** | [**AccountAggregationCompletedStats**](account-aggregation-completed-stats) | | [required]
|
||||
**Source** | [**AccountAggregationCompletedSource**](account-aggregation-completed-source) | | [required]
|
||||
**Status** | **Enum** [ "Success", "Failed", "Terminated" ] | The overall status of the aggregation. | [required]
|
||||
**Started** | **System.DateTime** | The date and time when the account aggregation started. | [required]
|
||||
**Completed** | **System.DateTime** | The date and time when the account aggregation finished. | [required]
|
||||
**Errors** | **[]String** | A list of errors that occurred during the aggregation. | [required]
|
||||
**Warnings** | **[]String** | A list of warnings that occurred during the aggregation. | [required]
|
||||
**Stats** | [**AccountAggregationCompletedStats**](account-aggregation-completed-stats) | | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccountAggregationCompletedSource', '
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | **Enum** [ "SOURCE" ] | The DTO type of the source the accounts are being aggregated from. | [required]
|
||||
**Id** | **String** | The ID of the source the accounts are being aggregated from. | [required]
|
||||
**Name** | **String** | Display name of the source the accounts are being aggregated from. | [required]
|
||||
**Type** | **Enum** [ "SOURCE" ] | The DTO type of the source the accounts are being aggregated from. | [required]
|
||||
**Id** | **String** | The ID of the source the accounts are being aggregated from. | [required]
|
||||
**Name** | **String** | Display name of the source the accounts are being aggregated from. | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,11 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'AccountAggregationCompletedStats', 'B
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Scanned** | **Int32** | The number of accounts which were scanned / iterated over. | [required]
|
||||
**Unchanged** | **Int32** | The number of accounts which existed before, but had no changes. | [required]
|
||||
**Changed** | **Int32** | The number of accounts which existed before, but had changes. | [required]
|
||||
**Added** | **Int32** | The number of accounts which are new - have not existed before. | [required]
|
||||
**Removed** | **Int32** | The number accounts which existed before, but no longer exist (thus getting removed). | [required]
|
||||
**Scanned** | **Int32** | The number of accounts which were scanned / iterated over. | [required]
|
||||
**Unchanged** | **Int32** | The number of accounts which existed before, but had no changes. | [required]
|
||||
**Changed** | **Int32** | The number of accounts which existed before, but had changes. | [required]
|
||||
**Added** | **Int32** | The number of accounts which are new - have not existed before. | [required]
|
||||
**Removed** | **Int32** | The number accounts which existed before, but no longer exist (thus getting removed). | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,10 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'AccountAggregationStatus', 'BetaAccou
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Start** | Pointer to **System.DateTime** | When the aggregation started. | [optional]
|
||||
**Status** | Pointer to **Enum** [ "STARTED", "ACCOUNTS_COLLECTED", "COMPLETED", "CANCELLED", "RETRIED", "TERMINATED" ] | STARTED - Aggregation started, but source account iteration has not completed. ACCOUNTS_COLLECTED - Source account iteration completed, but all accounts have not yet been processed. COMPLETED - Aggregation completed (*possibly with errors*). CANCELLED - Aggregation cancelled by user. RETRIED - Aggregation retried because of connectivity issues with the Virtual Appliance. TERMINATED - Aggregation marked as failed after 3 tries after connectivity issues with the Virtual Appliance. | [optional]
|
||||
**TotalAccounts** | Pointer to **Int32** | The total number of *NEW, CHANGED and DELETED* accounts that need to be processed for this aggregation. This does not include accounts that were unchanged since the previous aggregation. This can be zero if there were no new, changed or deleted accounts since the previous aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional]
|
||||
**ProcessedAccounts** | Pointer to **Int32** | The number of *NEW, CHANGED and DELETED* accounts that have been processed so far. This reflects the number of accounts that have been processed at the time of the API call, and may increase on subsequent API calls while the status is ACCOUNTS_COLLECTED. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional]
|
||||
**Start** | **System.DateTime** | When the aggregation started. | [optional]
|
||||
**Status** | **Enum** [ "STARTED", "ACCOUNTS_COLLECTED", "COMPLETED", "CANCELLED", "RETRIED", "TERMINATED" ] | STARTED - Aggregation started, but source account iteration has not completed. ACCOUNTS_COLLECTED - Source account iteration completed, but all accounts have not yet been processed. COMPLETED - Aggregation completed (*possibly with errors*). CANCELLED - Aggregation cancelled by user. RETRIED - Aggregation retried because of connectivity issues with the Virtual Appliance. TERMINATED - Aggregation marked as failed after 3 tries after connectivity issues with the Virtual Appliance. | [optional]
|
||||
**TotalAccounts** | **Int32** | The total number of *NEW, CHANGED and DELETED* accounts that need to be processed for this aggregation. This does not include accounts that were unchanged since the previous aggregation. This can be zero if there were no new, changed or deleted accounts since the previous aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional]
|
||||
**ProcessedAccounts** | **Int32** | The number of *NEW, CHANGED and DELETED* accounts that have been processed so far. This reflects the number of accounts that have been processed at the time of the API call, and may increase on subsequent API calls while the status is ACCOUNTS_COLLECTED. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,15 +16,15 @@ tags: ['SDK', 'Software Development Kit', 'AccountAttribute', 'BetaAccountAttrib
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**SourceName** | **String** | A reference to the source to search for the account | [required]
|
||||
**AttributeName** | **String** | The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema. | [required]
|
||||
**AccountSortAttribute** | Pointer to **String** | The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries | [optional] [default to "created"]
|
||||
**AccountSortDescending** | Pointer to **Boolean** | The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order) | [optional] [default to $false]
|
||||
**AccountReturnFirstLink** | Pointer to **Boolean** | The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false | [optional] [default to $false]
|
||||
**AccountFilter** | Pointer to **String** | This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements | [optional]
|
||||
**AccountPropertyFilter** | Pointer to **String** | This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. All account attributes are available for filtering as this operation is performed in memory. | [optional]
|
||||
**RequiresPeriodicRefresh** | Pointer to **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] [default to $false]
|
||||
**VarInput** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. | [optional]
|
||||
**SourceName** | **String** | A reference to the source to search for the account | [required]
|
||||
**AttributeName** | **String** | The name of the attribute on the account to return. This should match the name of the account attribute name visible in the user interface, or on the source schema. | [required]
|
||||
**AccountSortAttribute** | **String** | The value of this configuration is a string name of the attribute to use when determining the ordering of returned accounts when there are multiple entries | [optional] [default to "created"]
|
||||
**AccountSortDescending** | **Boolean** | The value of this configuration is a boolean (true/false). Controls the order of the sort when there are multiple accounts. If not defined, the transform will default to false (ascending order) | [optional] [default to $false]
|
||||
**AccountReturnFirstLink** | **Boolean** | The value of this configuration is a boolean (true/false). Controls which account to source a value from for an attribute. If this flag is set to true, the transform returns the value from the first account in the list, even if it is null. If it is set to false, the transform returns the first non-null value. If not defined, the transform will default to false | [optional] [default to $false]
|
||||
**AccountFilter** | **String** | This expression queries the database to narrow search results. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the database. The default filter will always include the source and identity, and any subsequent expressions will be combined in an AND operation to the existing search criteria. Only certain searchable attributes are available: - `nativeIdentity` - the Account ID - `displayName` - the Account Name - `entitlements` - a boolean value to determine if the account has entitlements | [optional]
|
||||
**AccountPropertyFilter** | **String** | This expression is used to search and filter accounts in memory. The value of this configuration is a sailpoint.object.Filter expression and used when searching against the returned resultset. All account attributes are available for filtering as this operation is performed in memory. | [optional]
|
||||
**RequiresPeriodicRefresh** | **Boolean** | A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process | [optional] [default to $false]
|
||||
**VarInput** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | This is an optional attribute that can explicitly define the input data which will be fed into the transform logic. If input is not provided, the transform will take its input from the source and attribute combination configured via the UI. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'AccountAttributes', 'BetaAccountAttri
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Attributes** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The schema attribute values for the account | [required]
|
||||
**Attributes** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The schema attribute values for the account | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,10 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'AccountAttributesChanged', 'BetaAccou
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Identity** | [**AccountAttributesChangedIdentity**](account-attributes-changed-identity) | | [required]
|
||||
**Source** | [**AccountAttributesChangedSource**](account-attributes-changed-source) | | [required]
|
||||
**Account** | [**AccountAttributesChangedAccount**](account-attributes-changed-account) | | [required]
|
||||
**Changes** | [**[]AccountAttributesChangedChangesInner**](account-attributes-changed-changes-inner) | A list of attributes that changed. | [required]
|
||||
**Identity** | [**AccountAttributesChangedIdentity**](account-attributes-changed-identity) | | [required]
|
||||
**Source** | [**AccountAttributesChangedSource**](account-attributes-changed-source) | | [required]
|
||||
**Account** | [**AccountAttributesChangedAccount**](account-attributes-changed-account) | | [required]
|
||||
**Changes** | [**[]AccountAttributesChangedChangesInner**](account-attributes-changed-changes-inner) | A list of attributes that changed. | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,11 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedAccount', 'Be
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | SailPoint generated unique identifier. | [required]
|
||||
**Uuid** | **String** | The source's unique identifier for the account. UUID is generated by the source system. | [required]
|
||||
**Name** | **String** | Name of the account. | [required]
|
||||
**NativeIdentity** | **String** | Unique ID of the account on the source. | [required]
|
||||
**Type** | **Enum** [ "ACCOUNT" ] | The type of the account | [required]
|
||||
**Id** | **String** | SailPoint generated unique identifier. | [required]
|
||||
**Uuid** | **String** | The source's unique identifier for the account. UUID is generated by the source system. | [required]
|
||||
**Name** | **String** | Name of the account. | [required]
|
||||
**NativeIdentity** | **String** | Unique ID of the account on the source. | [required]
|
||||
**Type** | **Enum** [ "ACCOUNT" ] | The type of the account | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedChangesInner'
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Attribute** | **String** | The name of the attribute. | [required]
|
||||
**OldValue** | [**AccountAttributesChangedChangesInnerOldValue**](account-attributes-changed-changes-inner-old-value) | | [required]
|
||||
**NewValue** | [**AccountAttributesChangedChangesInnerNewValue**](account-attributes-changed-changes-inner-new-value) | | [required]
|
||||
**Attribute** | **String** | The name of the attribute. | [required]
|
||||
**OldValue** | [**AccountAttributesChangedChangesInnerOldValue**](account-attributes-changed-changes-inner-old-value) | | [required]
|
||||
**NewValue** | [**AccountAttributesChangedChangesInnerNewValue**](account-attributes-changed-changes-inner-new-value) | | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedIdentity', 'B
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | **Enum** [ "IDENTITY" ] | DTO type of the identity whose account attributes were updated. | [required]
|
||||
**Id** | **String** | ID of the identity whose account attributes were updated. | [required]
|
||||
**Name** | **String** | Display name of the identity whose account attributes were updated. | [required]
|
||||
**Type** | **Enum** [ "IDENTITY" ] | DTO type of the identity whose account attributes were updated. | [required]
|
||||
**Id** | **String** | ID of the identity whose account attributes were updated. | [required]
|
||||
**Name** | **String** | Display name of the identity whose account attributes were updated. | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccountAttributesChangedSource', 'Bet
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | ID of the object to which this reference applies | [required]
|
||||
**Type** | **Enum** [ "SOURCE" ] | The type of object that is referenced | [required]
|
||||
**Name** | **String** | Human-readable display name of the object to which this reference applies | [required]
|
||||
**Id** | **String** | ID of the object to which this reference applies | [required]
|
||||
**Type** | **Enum** [ "SOURCE" ] | The type of object that is referenced | [required]
|
||||
**Name** | **String** | Human-readable display name of the object to which this reference applies | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'AccountAttributesCreate', 'BetaAccoun
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Attributes** | [**AccountAttributesCreateAttributes**](account-attributes-create-attributes) | | [required]
|
||||
**Attributes** | [**AccountAttributesCreateAttributes**](account-attributes-create-attributes) | | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'AccountAttributesCreateAttributes', '
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**SourceId** | **String** | Target source to create an account | [required]
|
||||
**SourceId** | **String** | Target source to create an account | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,11 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'AccountCorrelated', 'BetaAccountCorre
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Identity** | [**AccountCorrelatedIdentity**](account-correlated-identity) | | [required]
|
||||
**Source** | [**AccountCorrelatedSource**](account-correlated-source) | | [required]
|
||||
**Account** | [**AccountCorrelatedAccount**](account-correlated-account) | | [required]
|
||||
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The attributes associated with the account. Attributes are unique per source. | [required]
|
||||
**EntitlementCount** | Pointer to **Int32** | The number of entitlements associated with this account. | [optional]
|
||||
**Identity** | [**AccountCorrelatedIdentity**](account-correlated-identity) | | [required]
|
||||
**Source** | [**AccountCorrelatedSource**](account-correlated-source) | | [required]
|
||||
**Account** | [**AccountCorrelatedAccount**](account-correlated-account) | | [required]
|
||||
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The attributes associated with the account. Attributes are unique per source. | [required]
|
||||
**EntitlementCount** | **Int32** | The number of entitlements associated with this account. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,11 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'AccountCorrelatedAccount', 'BetaAccou
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | **Enum** [ "ACCOUNT" ] | The correlated account's DTO type. | [required]
|
||||
**Id** | **String** | The correlated account's ID. | [required]
|
||||
**Name** | **String** | The correlated account's display name. | [required]
|
||||
**NativeIdentity** | **String** | Unique ID of the account on the source. | [required]
|
||||
**Uuid** | Pointer to **String** | The source's unique identifier for the account. UUID is generated by the source system. | [optional]
|
||||
**Type** | **Enum** [ "ACCOUNT" ] | The correlated account's DTO type. | [required]
|
||||
**Id** | **String** | The correlated account's ID. | [required]
|
||||
**Name** | **String** | The correlated account's display name. | [required]
|
||||
**NativeIdentity** | **String** | Unique ID of the account on the source. | [required]
|
||||
**Uuid** | **String** | The source's unique identifier for the account. UUID is generated by the source system. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccountCorrelatedIdentity', 'BetaAcco
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | **Enum** [ "IDENTITY" ] | DTO type of the identity the account is correlated with. | [required]
|
||||
**Id** | **String** | ID of the identity the account is correlated with. | [required]
|
||||
**Name** | **String** | Display name of the identity the account is correlated with. | [required]
|
||||
**Type** | **Enum** [ "IDENTITY" ] | DTO type of the identity the account is correlated with. | [required]
|
||||
**Id** | **String** | ID of the identity the account is correlated with. | [required]
|
||||
**Name** | **String** | Display name of the identity the account is correlated with. | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccountCorrelatedSource', 'BetaAccoun
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | **Enum** [ "SOURCE" ] | The DTO type of the source the accounts are being correlated from. | [required]
|
||||
**Id** | **String** | The ID of the source the accounts are being correlated from. | [required]
|
||||
**Name** | **String** | Display name of the source the accounts are being correlated from. | [required]
|
||||
**Type** | **Enum** [ "SOURCE" ] | The DTO type of the source the accounts are being correlated from. | [required]
|
||||
**Id** | **String** | The ID of the source the accounts are being correlated from. | [required]
|
||||
**Name** | **String** | Display name of the source the accounts are being correlated from. | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccountInfoDto', 'BetaAccountInfoDto'
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**NativeIdentity** | Pointer to **String** | The unique ID of the account generated by the source system | [optional]
|
||||
**DisplayName** | Pointer to **String** | Display name for this account | [optional]
|
||||
**Uuid** | Pointer to **String** | UUID associated with this account | [optional]
|
||||
**NativeIdentity** | **String** | The unique ID of the account generated by the source system | [optional]
|
||||
**DisplayName** | **String** | Display name for this account | [optional]
|
||||
**Uuid** | **String** | UUID associated with this account | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccountRequestInfo', 'BetaAccountRequ
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**RequestedObjectId** | Pointer to **String** | Id of requested object | [optional]
|
||||
**RequestedObjectName** | Pointer to **String** | Human-readable name of requested object | [optional]
|
||||
**RequestedObjectType** | Pointer to [**RequestableObjectType**](requestable-object-type) | | [optional]
|
||||
**RequestedObjectId** | **String** | Id of requested object | [optional]
|
||||
**RequestedObjectName** | **String** | Human-readable name of requested object | [optional]
|
||||
**RequestedObjectType** | [**RequestableObjectType**](requestable-object-type) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,11 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'AccountStatusChanged', 'BetaAccountSt
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**EventType** | Pointer to **String** | the event type | [optional]
|
||||
**IdentityId** | Pointer to **String** | the identity id | [optional]
|
||||
**Dt** | Pointer to **String** | the date of event | [optional]
|
||||
**Account** | Pointer to [**AccountStatusChangedAccount**](account-status-changed-account) | | [optional]
|
||||
**StatusChange** | Pointer to [**AccountStatusChangedStatusChange**](account-status-changed-status-change) | | [optional]
|
||||
**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]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,13 +16,13 @@ tags: ['SDK', 'Software Development Kit', 'AccountStatusChangedAccount', 'BetaAc
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | Pointer to **String** | the ID of the account in the database | [optional]
|
||||
**NativeIdentity** | Pointer to **String** | the native identifier of the account | [optional]
|
||||
**DisplayName** | Pointer to **String** | the display name of the account | [optional]
|
||||
**SourceId** | Pointer to **String** | the ID of the source for this account | [optional]
|
||||
**SourceName** | Pointer to **String** | the name of the source for this account | [optional]
|
||||
**EntitlementCount** | Pointer to **Int32** | the number of entitlements on this account | [optional]
|
||||
**AccessType** | Pointer to **String** | this value is always ""account"" | [optional]
|
||||
**Id** | **String** | the ID of the account in the database | [optional]
|
||||
**NativeIdentity** | **String** | the native identifier of the account | [optional]
|
||||
**DisplayName** | **String** | the display name of the account | [optional]
|
||||
**SourceId** | **String** | the ID of the source for this account | [optional]
|
||||
**SourceName** | **String** | the name of the source for this account | [optional]
|
||||
**EntitlementCount** | **Int32** | the number of entitlements on this account | [optional]
|
||||
**AccessType** | **String** | this value is always ""account"" | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccountStatusChangedStatusChange', 'B
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**PreviousStatus** | Pointer to **Enum** [ "enabled", "disabled", "locked" ] | the previous status of the account | [optional]
|
||||
**NewStatus** | Pointer to **Enum** [ "enabled", "disabled", "locked" ] | the new status of the account | [optional]
|
||||
**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
|
||||
|
||||
|
||||
@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccountToggleRequest', 'BetaAccountTo
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**ExternalVerificationId** | Pointer to **String** | If set, an external process validates that the user wants to proceed with this request. | [optional]
|
||||
**ForceProvisioning** | Pointer to **Boolean** | If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. | [optional]
|
||||
**ExternalVerificationId** | **String** | If set, an external process validates that the user wants to proceed with this request. | [optional]
|
||||
**ForceProvisioning** | **Boolean** | If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,10 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'AccountUncorrelated', 'BetaAccountUnc
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Identity** | [**AccountUncorrelatedIdentity**](account-uncorrelated-identity) | | [required]
|
||||
**Source** | [**AccountUncorrelatedSource**](account-uncorrelated-source) | | [required]
|
||||
**Account** | [**AccountUncorrelatedAccount**](account-uncorrelated-account) | | [required]
|
||||
**EntitlementCount** | Pointer to **Int32** | The number of entitlements associated with this account. | [optional]
|
||||
**Identity** | [**AccountUncorrelatedIdentity**](account-uncorrelated-identity) | | [required]
|
||||
**Source** | [**AccountUncorrelatedSource**](account-uncorrelated-source) | | [required]
|
||||
**Account** | [**AccountUncorrelatedAccount**](account-uncorrelated-account) | | [required]
|
||||
**EntitlementCount** | **Int32** | The number of entitlements associated with this account. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,11 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'AccountUncorrelatedAccount', 'BetaAcc
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | **Enum** [ "ACCOUNT" ] | Uncorrelated account's DTO type. | [required]
|
||||
**Id** | **String** | Uncorrelated account's ID. | [required]
|
||||
**Name** | **String** | Uncorrelated account's display name. | [required]
|
||||
**NativeIdentity** | **String** | Unique ID of the account on the source. | [required]
|
||||
**Uuid** | Pointer to **String** | The source's unique identifier for the account. UUID is generated by the source system. | [optional]
|
||||
**Type** | **Enum** [ "ACCOUNT" ] | Uncorrelated account's DTO type. | [required]
|
||||
**Id** | **String** | Uncorrelated account's ID. | [required]
|
||||
**Name** | **String** | Uncorrelated account's display name. | [required]
|
||||
**NativeIdentity** | **String** | Unique ID of the account on the source. | [required]
|
||||
**Uuid** | **String** | The source's unique identifier for the account. UUID is generated by the source system. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccountUncorrelatedIdentity', 'BetaAc
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | **Enum** [ "IDENTITY" ] | DTO type of the identity the account is uncorrelated with. | [required]
|
||||
**Id** | **String** | ID of the identity the account is uncorrelated with. | [required]
|
||||
**Name** | **String** | Display name of the identity the account is uncorrelated with. | [required]
|
||||
**Type** | **Enum** [ "IDENTITY" ] | DTO type of the identity the account is uncorrelated with. | [required]
|
||||
**Id** | **String** | ID of the identity the account is uncorrelated with. | [required]
|
||||
**Name** | **String** | Display name of the identity the account is uncorrelated with. | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccountUncorrelatedSource', 'BetaAcco
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | **Enum** [ "SOURCE" ] | The DTO type of the source the accounts are uncorrelated from. | [required]
|
||||
**Id** | **String** | The ID of the source the accounts are uncorrelated from. | [required]
|
||||
**Name** | **String** | Display name of the source the accounts are uncorrelated from. | [required]
|
||||
**Type** | **Enum** [ "SOURCE" ] | The DTO type of the source the accounts are uncorrelated from. | [required]
|
||||
**Id** | **String** | The ID of the source the accounts are uncorrelated from. | [required]
|
||||
**Name** | **String** | Display name of the source the accounts are uncorrelated from. | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccountUnlockRequest', 'BetaAccountUn
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**ExternalVerificationId** | Pointer to **String** | If set, an external process validates that the user wants to proceed with this request. | [optional]
|
||||
**UnlockIDNAccount** | Pointer to **Boolean** | If set, the IDN account is unlocked after the workflow completes. | [optional]
|
||||
**ForceProvisioning** | Pointer to **Boolean** | If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. | [optional]
|
||||
**ExternalVerificationId** | **String** | If set, an external process validates that the user wants to proceed with this request. | [optional]
|
||||
**UnlockIDNAccount** | **Boolean** | If set, the IDN account is unlocked after the workflow completes. | [optional]
|
||||
**ForceProvisioning** | **Boolean** | If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccountUsage', 'BetaAccountUsage']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Date** | Pointer to **System.DateTime** | The first day of the month for which activity is aggregated. | [optional]
|
||||
**Count** | Pointer to **Int64** | The number of days within the month that the account was active in a source. | [optional]
|
||||
**Date** | **System.DateTime** | The first day of the month for which activity is aggregated. | [optional]
|
||||
**Count** | **Int64** | The number of days within the month that the account was active in a source. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'AccountsAsyncResult', 'BetaAccountsAs
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | id of the task | [required]
|
||||
**Id** | **String** | id of the task | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,13 +16,13 @@ tags: ['SDK', 'Software Development Kit', 'AccountsCollectedForAggregation', 'Be
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Source** | [**AccountsCollectedForAggregationSource**](accounts-collected-for-aggregation-source) | | [required]
|
||||
**Status** | **Enum** [ "Success", "Failed", "Terminated" ] | The overall status of the collection. | [required]
|
||||
**Started** | **System.DateTime** | The date and time when the account collection started. | [required]
|
||||
**Completed** | **System.DateTime** | The date and time when the account collection finished. | [required]
|
||||
**Errors** | **[]String** | A list of errors that occurred during the collection. | [required]
|
||||
**Warnings** | **[]String** | A list of warnings that occurred during the collection. | [required]
|
||||
**Stats** | [**AccountsCollectedForAggregationStats**](accounts-collected-for-aggregation-stats) | | [required]
|
||||
**Source** | [**AccountsCollectedForAggregationSource**](accounts-collected-for-aggregation-source) | | [required]
|
||||
**Status** | **Enum** [ "Success", "Failed", "Terminated" ] | The overall status of the collection. | [required]
|
||||
**Started** | **System.DateTime** | The date and time when the account collection started. | [required]
|
||||
**Completed** | **System.DateTime** | The date and time when the account collection finished. | [required]
|
||||
**Errors** | **[]String** | A list of errors that occurred during the collection. | [required]
|
||||
**Warnings** | **[]String** | A list of warnings that occurred during the collection. | [required]
|
||||
**Stats** | [**AccountsCollectedForAggregationStats**](accounts-collected-for-aggregation-stats) | | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccountsCollectedForAggregationSource
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | ID of the object to which this reference applies | [required]
|
||||
**Type** | **Enum** [ "SOURCE" ] | The type of object that is referenced | [required]
|
||||
**Name** | **String** | Human-readable display name of the object to which this reference applies | [required]
|
||||
**Id** | **String** | ID of the object to which this reference applies | [required]
|
||||
**Type** | **Enum** [ "SOURCE" ] | The type of object that is referenced | [required]
|
||||
**Name** | **String** | Human-readable display name of the object to which this reference applies | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,11 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'AccountsCollectedForAggregationStats'
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Scanned** | **Int32** | The number of accounts which were scanned / iterated over. | [required]
|
||||
**Unchanged** | **Int32** | The number of accounts which existed before, but had no changes. | [required]
|
||||
**Changed** | **Int32** | The number of accounts which existed before, but had changes. | [required]
|
||||
**Added** | **Int32** | The number of accounts which are new - have not existed before. | [required]
|
||||
**Removed** | **Int32** | The number accounts which existed before, but no longer exist (thus getting removed). | [required]
|
||||
**Scanned** | **Int32** | The number of accounts which were scanned / iterated over. | [required]
|
||||
**Unchanged** | **Int32** | The number of accounts which existed before, but had no changes. | [required]
|
||||
**Changed** | **Int32** | The number of accounts which existed before, but had changes. | [required]
|
||||
**Added** | **Int32** | The number of accounts which are new - have not existed before. | [required]
|
||||
**Removed** | **Int32** | The number accounts which existed before, but no longer exist (thus getting removed). | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'ActivateCampaignOptions', 'BetaActiva
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**TimeZone** | Pointer to **String** | The timezone must be in a valid ISO 8601 format. Timezones in ISO 8601 are represented as UTC (represented as 'Z') or as an offset from UTC. The offset format can be +/-hh:mm, +/-hhmm, or +/-hh. | [optional] [default to "Z"]
|
||||
**TimeZone** | **String** | The timezone must be in a valid ISO 8601 format. Timezones in ISO 8601 are represented as UTC (represented as 'Z') or as an offset from UTC. The offset format can be +/-hh:mm, +/-hhmm, or +/-hh. | [optional] [default to "Z"]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AdminReviewReassign', 'BetaAdminRevie
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**CertificationIds** | Pointer to **[]String** | List of certification IDs to reassign | [optional]
|
||||
**ReassignTo** | Pointer to [**AdminReviewReassignReassignTo**](admin-review-reassign-reassign-to) | | [optional]
|
||||
**Reason** | Pointer to **String** | Comment to explain why the certification was reassigned | [optional]
|
||||
**CertificationIds** | **[]String** | List of certification IDs to reassign | [optional]
|
||||
**ReassignTo** | [**AdminReviewReassignReassignTo**](admin-review-reassign-reassign-to) | | [optional]
|
||||
**Reason** | **String** | Comment to explain why the certification was reassigned | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AdminReviewReassignReassignTo', 'Beta
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | Pointer to **String** | The identity ID to which the review is being assigned. | [optional]
|
||||
**Type** | Pointer to **Enum** [ "IDENTITY" ] | The type of the ID provided. | [optional]
|
||||
**Id** | **String** | The identity ID to which the review is being assigned. | [optional]
|
||||
**Type** | **Enum** [ "IDENTITY" ] | The type of the ID provided. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AppAccountDetails', 'BetaAppAccountDe
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**AppId** | Pointer to **String** | The source app ID | [optional]
|
||||
**AppDisplayName** | Pointer to **String** | The source app display name | [optional]
|
||||
**SourceAccount** | Pointer to [**AppAccountDetailsSourceAccount**](app-account-details-source-account) | | [optional]
|
||||
**AppId** | **String** | The source app ID | [optional]
|
||||
**AppDisplayName** | **String** | The source app display name | [optional]
|
||||
**SourceAccount** | [**AppAccountDetailsSourceAccount**](app-account-details-source-account) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,11 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'AppAccountDetailsSourceAccount', 'Bet
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | Pointer to **String** | The account ID | [optional]
|
||||
**NativeIdentity** | Pointer to **String** | The native identity of account | [optional]
|
||||
**DisplayName** | Pointer to **String** | The display name of account | [optional]
|
||||
**SourceId** | Pointer to **String** | The source ID of account | [optional]
|
||||
**SourceDisplayName** | Pointer to **String** | The source name of account | [optional]
|
||||
**Id** | **String** | The account ID | [optional]
|
||||
**NativeIdentity** | **String** | The native identity of account | [optional]
|
||||
**DisplayName** | **String** | The display name of account | [optional]
|
||||
**SourceId** | **String** | The source ID of account | [optional]
|
||||
**SourceDisplayName** | **String** | The source name of account | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,23 +16,23 @@ tags: ['SDK', 'Software Development Kit', 'Approval', 'BetaApproval']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**ApprovalId** | Pointer to **String** | The Approval ID | [optional]
|
||||
**Approvers** | Pointer to [**[]ApprovalIdentity**](approval-identity) | Object representation of an approver of an approval | [optional]
|
||||
**CreatedDate** | Pointer to **String** | Date the approval was created | [optional]
|
||||
**Type** | Pointer to **String** | Type of approval | [optional]
|
||||
**Name** | Pointer to [**[]ApprovalName**](approval-name) | The name of the approval for a given locale | [optional]
|
||||
**BatchRequest** | Pointer to [**ApprovalBatch**](approval-batch) | The name of the approval for a given locale | [optional]
|
||||
**Description** | Pointer to [**[]ApprovalDescription**](approval-description) | The description of the approval for a given locale | [optional]
|
||||
**Priority** | Pointer to **Enum** [ "HIGH", "MEDIUM", "LOW" ] | The priority of the approval | [optional]
|
||||
**Requester** | Pointer to [**ApprovalIdentity**](approval-identity) | Object representation of the requester of the approval | [optional]
|
||||
**Comments** | Pointer to [**[]ApprovalComment**](approval-comment) | Object representation of a comment on the approval | [optional]
|
||||
**ApprovedBy** | Pointer to [**[]ApprovalIdentity**](approval-identity) | Array of approvers who have approved the approval | [optional]
|
||||
**RejectedBy** | Pointer to [**[]ApprovalIdentity**](approval-identity) | Array of approvers who have rejected the approval | [optional]
|
||||
**CompletedDate** | Pointer to **String** | Date the approval was completed | [optional]
|
||||
**ApprovalCriteria** | Pointer to **Enum** [ "SINGLE", "DOUBLE", "TRIPLE", "QUARTER", "HALF", "ALL" ] | Criteria that needs to be met for an approval to be marked as approved | [optional]
|
||||
**Status** | Pointer to **Enum** [ "PENDING", "APPROVED", "REJECTED" ] | The current status of the approval | [optional]
|
||||
**AdditionalAttributes** | Pointer to **String** | Json string representing additional attributes known about the object to be approved. | [optional]
|
||||
**ReferenceData** | Pointer to [**[]ApprovalReference**](approval-reference) | Reference data related to the approval | [optional]
|
||||
**ApprovalId** | **String** | The Approval ID | [optional]
|
||||
**Approvers** | [**[]ApprovalIdentity**](approval-identity) | Object representation of an approver of an approval | [optional]
|
||||
**CreatedDate** | **String** | Date the approval was created | [optional]
|
||||
**Type** | **String** | Type of approval | [optional]
|
||||
**Name** | [**[]ApprovalName**](approval-name) | The name of the approval for a given locale | [optional]
|
||||
**BatchRequest** | [**ApprovalBatch**](approval-batch) | The name of the approval for a given locale | [optional]
|
||||
**Description** | [**[]ApprovalDescription**](approval-description) | The description of the approval for a given locale | [optional]
|
||||
**Priority** | **Enum** [ "HIGH", "MEDIUM", "LOW" ] | The priority of the approval | [optional]
|
||||
**Requester** | [**ApprovalIdentity**](approval-identity) | Object representation of the requester of the approval | [optional]
|
||||
**Comments** | [**[]ApprovalComment**](approval-comment) | Object representation of a comment on the approval | [optional]
|
||||
**ApprovedBy** | [**[]ApprovalIdentity**](approval-identity) | Array of approvers who have approved the approval | [optional]
|
||||
**RejectedBy** | [**[]ApprovalIdentity**](approval-identity) | Array of approvers who have rejected the approval | [optional]
|
||||
**CompletedDate** | **String** | Date the approval was completed | [optional]
|
||||
**ApprovalCriteria** | **Enum** [ "SINGLE", "DOUBLE", "TRIPLE", "QUARTER", "HALF", "ALL" ] | Criteria that needs to be met for an approval to be marked as approved | [optional]
|
||||
**Status** | **Enum** [ "PENDING", "APPROVED", "REJECTED" ] | The current status of the approval | [optional]
|
||||
**AdditionalAttributes** | **String** | Json string representing additional attributes known about the object to be approved. | [optional]
|
||||
**ReferenceData** | [**[]ApprovalReference**](approval-reference) | Reference data related to the approval | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user