mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-10 04:19:42 +00:00
Update to powershell SDK docs: 13123805130
This commit is contained in:
developer-relations-sp
@@ -16,11 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'Access', 'Access']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | Pointer to **String** | The unique ID of the referenced object. | [optional]
|
||||
**Name** | Pointer to **String** | The human readable name of the referenced object. | [optional]
|
||||
**DisplayName** | Pointer to **String** | | [optional]
|
||||
**Type** | Pointer to [**DtoType**](dto-type) | | [optional]
|
||||
**Description** | Pointer to **String** | | [optional]
|
||||
**Id** | **String** | The unique ID of the referenced object. | [optional]
|
||||
**Name** | **String** | The human readable name of the referenced object. | [optional]
|
||||
**DisplayName** | **String** | | [optional]
|
||||
**Type** | [**DtoType**](dto-type) | | [optional]
|
||||
**Description** | **String** | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessConstraint', 'AccessConstraint'
|
||||
|
||||
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', 'AccessCriteria']
|
||||
|
||||
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', 'Ac
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | Pointer to **Enum** [ "ENTITLEMENT" ] | Type of the propery to which this reference applies to | [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" ] | Type of the propery to which this reference applies to | [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,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemRequestedFor', 'AccessItemR
|
||||
|
||||
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', 'AccessItemRequ
|
||||
|
||||
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', 'AccessItemRev
|
||||
|
||||
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,20 +16,20 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfile', 'AccessProfile']
|
||||
|
||||
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', 'Access
|
||||
|
||||
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', 'Acc
|
||||
|
||||
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', 'Ac
|
||||
|
||||
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,21 +16,21 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileDocument', 'AccessProfil
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | Access profile's ID. | [required]
|
||||
**Name** | **String** | Access profile's name. | [required]
|
||||
**Description** | Pointer to **String** | Access item's description. | [optional]
|
||||
**Created** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
|
||||
**Modified** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional]
|
||||
**Synced** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional]
|
||||
**Enabled** | Pointer to **Boolean** | Indicates whether the access item is currently enabled. | [optional] [default to $false]
|
||||
**Requestable** | Pointer to **Boolean** | Indicates whether the access item can be requested. | [optional] [default to $true]
|
||||
**RequestCommentsRequired** | Pointer to **Boolean** | Indicates whether comments are required for requests to access the item. | [optional] [default to $false]
|
||||
**Owner** | Pointer to [**BaseAccessAllOfOwner**](base-access-all-of-owner) | | [optional]
|
||||
**Type** | **Enum** [ "accessprofile", "accountactivity", "account", "aggregation", "entitlement", "event", "identity", "role" ] | Access profile's document type. This enum represents the currently supported document types. Additional values may be added in the future without notice. | [required]
|
||||
**Source** | Pointer to [**AccessProfileDocumentAllOfSource**](access-profile-document-all-of-source) | | [optional]
|
||||
**Entitlements** | Pointer to [**[]BaseEntitlement**](base-entitlement) | Entitlements the access profile has access to. | [optional]
|
||||
**EntitlementCount** | Pointer to **Int32** | Number of entitlements. | [optional]
|
||||
**Tags** | Pointer to **[]String** | Tags that have been applied to the object. | [optional]
|
||||
**Id** | **String** | Access profile's ID. | [required]
|
||||
**Name** | **String** | Access profile's name. | [required]
|
||||
**Description** | **String** | Access item's description. | [optional]
|
||||
**Created** | **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
|
||||
**Modified** | **System.DateTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional]
|
||||
**Synced** | **System.DateTime** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional]
|
||||
**Enabled** | **Boolean** | Indicates whether the access item is currently enabled. | [optional] [default to $false]
|
||||
**Requestable** | **Boolean** | Indicates whether the access item can be requested. | [optional] [default to $true]
|
||||
**RequestCommentsRequired** | **Boolean** | Indicates whether comments are required for requests to access the item. | [optional] [default to $false]
|
||||
**Owner** | [**BaseAccessAllOfOwner**](base-access-all-of-owner) | | [optional]
|
||||
**Type** | **Enum** [ "accessprofile", "accountactivity", "account", "aggregation", "entitlement", "event", "identity", "role" ] | Access profile's document type. This enum represents the currently supported document types. Additional values may be added in the future without notice. | [required]
|
||||
**Source** | [**AccessProfileDocumentAllOfSource**](access-profile-document-all-of-source) | | [optional]
|
||||
**Entitlements** | [**[]BaseEntitlement**](base-entitlement) | Entitlements the access profile has access to. | [optional]
|
||||
**EntitlementCount** | **Int32** | Number of entitlements. | [optional]
|
||||
**Tags** | **[]String** | Tags that have been applied to the object. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileDocumentAllOfSource', 'A
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | Pointer to **String** | Source's ID. | [optional]
|
||||
**Name** | Pointer to **String** | Source's name. | [optional]
|
||||
**Id** | **String** | Source's ID. | [optional]
|
||||
**Name** | **String** | Source's name. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,16 +16,16 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileEntitlement', 'AccessPro
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | Pointer to **String** | The unique ID of the referenced object. | [optional]
|
||||
**Name** | Pointer to **String** | The human readable name of the referenced object. | [optional]
|
||||
**DisplayName** | Pointer to **String** | | [optional]
|
||||
**Type** | Pointer to [**DtoType**](dto-type) | | [optional]
|
||||
**Description** | Pointer to **String** | | [optional]
|
||||
**Source** | Pointer to [**Reference1**](reference1) | | [optional]
|
||||
**Privileged** | Pointer to **Boolean** | | [optional]
|
||||
**Attribute** | Pointer to **String** | | [optional]
|
||||
**Value** | Pointer to **String** | | [optional]
|
||||
**Standalone** | Pointer to **Boolean** | | [optional]
|
||||
**Id** | **String** | The unique ID of the referenced object. | [optional]
|
||||
**Name** | **String** | The human readable name of the referenced object. | [optional]
|
||||
**DisplayName** | **String** | | [optional]
|
||||
**Type** | [**DtoType**](dto-type) | | [optional]
|
||||
**Description** | **String** | | [optional]
|
||||
**Source** | [**Reference1**](reference1) | | [optional]
|
||||
**Privileged** | **Boolean** | | [optional]
|
||||
**Attribute** | **String** | | [optional]
|
||||
**Value** | **String** | | [optional]
|
||||
**Standalone** | **Boolean** | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileRef', 'AccessProfileRef'
|
||||
|
||||
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,14 +16,14 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileRole', 'AccessProfileRol
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | Pointer to **String** | The unique ID of the referenced object. | [optional]
|
||||
**Name** | Pointer to **String** | The human readable name of the referenced object. | [optional]
|
||||
**DisplayName** | Pointer to **String** | | [optional]
|
||||
**Type** | Pointer to [**DtoType**](dto-type) | | [optional]
|
||||
**Description** | Pointer to **String** | | [optional]
|
||||
**Owner** | Pointer to [**DisplayReference**](display-reference) | | [optional]
|
||||
**Disabled** | Pointer to **Boolean** | | [optional]
|
||||
**Revocable** | Pointer to **Boolean** | | [optional]
|
||||
**Id** | **String** | The unique ID of the referenced object. | [optional]
|
||||
**Name** | **String** | The human readable name of the referenced object. | [optional]
|
||||
**DisplayName** | **String** | | [optional]
|
||||
**Type** | [**DtoType**](dto-type) | | [optional]
|
||||
**Description** | **String** | | [optional]
|
||||
**Owner** | [**DisplayReference**](display-reference) | | [optional]
|
||||
**Disabled** | **Boolean** | | [optional]
|
||||
**Revocable** | **Boolean** | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileSourceRef', 'AccessProfi
|
||||
|
||||
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,14 +16,14 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileSummary', 'AccessProfile
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | Pointer to **String** | The unique ID of the referenced object. | [optional]
|
||||
**Name** | Pointer to **String** | The human readable name of the referenced object. | [optional]
|
||||
**DisplayName** | Pointer to **String** | | [optional]
|
||||
**Type** | Pointer to [**DtoType**](dto-type) | | [optional]
|
||||
**Description** | Pointer to **String** | | [optional]
|
||||
**Source** | Pointer to [**Reference1**](reference1) | | [optional]
|
||||
**Owner** | Pointer to [**DisplayReference**](display-reference) | | [optional]
|
||||
**Revocable** | Pointer to **Boolean** | | [optional]
|
||||
**Id** | **String** | The unique ID of the referenced object. | [optional]
|
||||
**Name** | **String** | The human readable name of the referenced object. | [optional]
|
||||
**DisplayName** | **String** | | [optional]
|
||||
**Type** | [**DtoType**](dto-type) | | [optional]
|
||||
**Description** | **String** | | [optional]
|
||||
**Source** | [**Reference1**](reference1) | | [optional]
|
||||
**Owner** | [**DisplayReference**](display-reference) | | [optional]
|
||||
**Revocable** | **Boolean** | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileUsage', 'AccessProfileUs
|
||||
|
||||
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', 'Acce
|
||||
|
||||
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,10 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequest', 'AccessRequest']
|
||||
|
||||
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', 'AccessRequestC
|
||||
|
||||
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 [**EntitlementRequestConfig**](entitlement-request-config) | | [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** | [**EntitlementRequestConfig**](entitlement-request-config) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,11 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestItem', 'AccessRequestIte
|
||||
|
||||
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,12 +16,12 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestPhases', 'AccessRequestP
|
||||
|
||||
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,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestResponse', 'AccessReques
|
||||
|
||||
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,10 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestTracking', 'AccessReques
|
||||
|
||||
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,13 +16,13 @@ tags: ['SDK', 'Software Development Kit', 'AccessReviewItem', 'AccessReviewItem'
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**AccessSummary** | Pointer to [**AccessSummary**](access-summary) | | [optional]
|
||||
**IdentitySummary** | Pointer to [**CertificationIdentitySummary**](certification-identity-summary) | | [optional]
|
||||
**Id** | Pointer to **String** | The review item's id | [optional]
|
||||
**Completed** | Pointer to **Boolean** | Whether the review item is complete | [optional]
|
||||
**NewAccess** | Pointer to **Boolean** | Indicates whether the review item is for new access to a source | [optional]
|
||||
**Decision** | Pointer to [**CertificationDecision**](certification-decision) | | [optional]
|
||||
**Comments** | Pointer to **String** | Comments for this review item | [optional]
|
||||
**AccessSummary** | [**AccessSummary**](access-summary) | | [optional]
|
||||
**IdentitySummary** | [**CertificationIdentitySummary**](certification-identity-summary) | | [optional]
|
||||
**Id** | **String** | The review item's id | [optional]
|
||||
**Completed** | **Boolean** | Whether the review item is complete | [optional]
|
||||
**NewAccess** | **Boolean** | Indicates whether the review item is for new access to a source | [optional]
|
||||
**Decision** | [**CertificationDecision**](certification-decision) | | [optional]
|
||||
**Comments** | **String** | Comments for this review item | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessReviewReassignment', 'AccessRev
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Reassign** | [**[]ReassignReference**](reassign-reference) | | [required]
|
||||
**ReassignTo** | **String** | The ID of the identity to which the certification is reassigned | [required]
|
||||
**Reason** | **String** | The reason comment for why the reassign was made | [required]
|
||||
**Reassign** | [**[]ReassignReference**](reassign-reference) | | [required]
|
||||
**ReassignTo** | **String** | The ID of the identity to which the certification is reassigned | [required]
|
||||
**Reason** | **String** | The reason comment for why the reassign was made | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,10 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'AccessSummary', 'AccessSummary']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Access** | Pointer to [**AccessSummaryAccess**](access-summary-access) | | [optional]
|
||||
**Entitlement** | Pointer to [**ReviewableEntitlement**](reviewable-entitlement) | | [optional]
|
||||
**AccessProfile** | Pointer to [**ReviewableAccessProfile**](reviewable-access-profile) | | [optional]
|
||||
**Role** | Pointer to [**ReviewableRole**](reviewable-role) | | [optional]
|
||||
**Access** | [**AccessSummaryAccess**](access-summary-access) | | [optional]
|
||||
**Entitlement** | [**ReviewableEntitlement**](reviewable-entitlement) | | [optional]
|
||||
**AccessProfile** | [**ReviewableAccessProfile**](reviewable-access-profile) | | [optional]
|
||||
**Role** | [**ReviewableRole**](reviewable-role) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccessSummaryAccess', 'AccessSummaryA
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | Pointer to [**DtoType**](dto-type) | | [optional]
|
||||
**Id** | Pointer to **String** | The ID of the item being certified | [optional]
|
||||
**Name** | Pointer to **String** | The name of the item being certified | [optional]
|
||||
**Type** | [**DtoType**](dto-type) | | [optional]
|
||||
**Id** | **String** | The ID of the item being certified | [optional]
|
||||
**Name** | **String** | The name of the item being certified | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,34 +16,34 @@ tags: ['SDK', 'Software Development Kit', 'Account', 'Account']
|
||||
|
||||
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', 'AccountAction']
|
||||
|
||||
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 unique 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 unique source IDs. The sources must have the ENABLE feature or flat file source. See ""/sources"" endpoint for source features. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,20 +16,20 @@ tags: ['SDK', 'Software Development Kit', 'AccountActivity', 'AccountActivity']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | Pointer to **String** | Id of the account activity | [optional]
|
||||
**Name** | Pointer to **String** | The name of the activity | [optional]
|
||||
**Created** | Pointer to **System.DateTime** | When the activity was first created | [optional]
|
||||
**Modified** | Pointer to **System.DateTime** | When the activity was last modified | [optional]
|
||||
**Completed** | Pointer to **System.DateTime** | When the activity was completed | [optional]
|
||||
**CompletionStatus** | Pointer to [**CompletionStatus**](completion-status) | | [optional]
|
||||
**Type** | Pointer to **String** | The type of action the activity performed. Please see the following list of types. This list may grow over time. - CloudAutomated - IdentityAttributeUpdate - appRequest - LifecycleStateChange - AccountStateUpdate - AccountAttributeUpdate - CloudPasswordRequest - Attribute Synchronization Refresh - Certification - Identity Refresh - Lifecycle Change Refresh [Learn more here](https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data). | [optional]
|
||||
**RequesterIdentitySummary** | Pointer to [**IdentitySummary**](identity-summary) | | [optional]
|
||||
**TargetIdentitySummary** | Pointer to [**IdentitySummary**](identity-summary) | | [optional]
|
||||
**Errors** | Pointer to **[]String** | A list of error messages, if any, that were encountered. | [optional]
|
||||
**Warnings** | Pointer to **[]String** | A list of warning messages, if any, that were encountered. | [optional]
|
||||
**Items** | Pointer to [**[]AccountActivityItem**](account-activity-item) | Individual actions performed as part of this account activity | [optional]
|
||||
**ExecutionStatus** | Pointer to [**ExecutionStatus**](execution-status) | | [optional]
|
||||
**ClientMetadata** | Pointer to **map[string]String** | Arbitrary key-value pairs, if any were included in the corresponding access request | [optional]
|
||||
**Id** | **String** | Id of the account activity | [optional]
|
||||
**Name** | **String** | The name of the activity | [optional]
|
||||
**Created** | **System.DateTime** | When the activity was first created | [optional]
|
||||
**Modified** | **System.DateTime** | When the activity was last modified | [optional]
|
||||
**Completed** | **System.DateTime** | When the activity was completed | [optional]
|
||||
**CompletionStatus** | [**CompletionStatus**](completion-status) | | [optional]
|
||||
**Type** | **String** | The type of action the activity performed. Please see the following list of types. This list may grow over time. - CloudAutomated - IdentityAttributeUpdate - appRequest - LifecycleStateChange - AccountStateUpdate - AccountAttributeUpdate - CloudPasswordRequest - Attribute Synchronization Refresh - Certification - Identity Refresh - Lifecycle Change Refresh [Learn more here](https://documentation.sailpoint.com/saas/help/search/searchable-fields.html#searching-account-activity-data). | [optional]
|
||||
**RequesterIdentitySummary** | [**IdentitySummary**](identity-summary) | | [optional]
|
||||
**TargetIdentitySummary** | [**IdentitySummary**](identity-summary) | | [optional]
|
||||
**Errors** | **[]String** | A list of error messages, if any, that were encountered. | [optional]
|
||||
**Warnings** | **[]String** | A list of warning messages, if any, that were encountered. | [optional]
|
||||
**Items** | [**[]AccountActivityItem**](account-activity-item) | Individual actions performed as part of this account activity | [optional]
|
||||
**ExecutionStatus** | [**ExecutionStatus**](execution-status) | | [optional]
|
||||
**ClientMetadata** | **map[string]String** | Arbitrary key-value pairs, if any were included in the corresponding access request | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,25 +16,25 @@ tags: ['SDK', 'Software Development Kit', 'AccountActivityDocument', 'AccountAct
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | | [required]
|
||||
**Name** | **String** | | [required]
|
||||
**Type** | [**DocumentType**](document-type) | | [required]
|
||||
**Action** | Pointer to **String** | Type of action performed in the activity. | [optional]
|
||||
**Created** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
|
||||
**Modified** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional]
|
||||
**Stage** | Pointer to **String** | Activity's current stage. | [optional]
|
||||
**Origin** | Pointer to **String** | Activity's origin. | [optional]
|
||||
**Status** | Pointer to **String** | Activity's current status. | [optional]
|
||||
**Requester** | Pointer to [**AccountSource**](account-source) | | [optional]
|
||||
**Recipient** | Pointer to [**AccountSource**](account-source) | | [optional]
|
||||
**TrackingNumber** | Pointer to **String** | Account activity's tracking number. | [optional]
|
||||
**Errors** | Pointer to **[]String** | Errors provided by the source while completing account actions. | [optional]
|
||||
**Warnings** | Pointer to **[]String** | Warnings provided by the source while completing account actions. | [optional]
|
||||
**Approvals** | Pointer to [**[]Approval**](approval) | Approvals performed on an item during activity. | [optional]
|
||||
**OriginalRequests** | Pointer to [**[]OriginalRequest**](original-request) | Original actions that triggered all individual source actions related to the account action. | [optional]
|
||||
**ExpansionItems** | Pointer to [**[]ExpansionItem**](expansion-item) | Controls that translated the attribute requests into actual provisioning actions on the source. | [optional]
|
||||
**AccountRequests** | Pointer to [**[]AccountRequest**](account-request) | Account data for each individual source action triggered by the original requests. | [optional]
|
||||
**Sources** | Pointer to **String** | Sources involved in the account activity. | [optional]
|
||||
**Id** | **String** | | [required]
|
||||
**Name** | **String** | | [required]
|
||||
**Type** | [**DocumentType**](document-type) | | [required]
|
||||
**Action** | **String** | Type of action performed in the activity. | [optional]
|
||||
**Created** | **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
|
||||
**Modified** | **System.DateTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional]
|
||||
**Stage** | **String** | Activity's current stage. | [optional]
|
||||
**Origin** | **String** | Activity's origin. | [optional]
|
||||
**Status** | **String** | Activity's current status. | [optional]
|
||||
**Requester** | [**AccountSource**](account-source) | | [optional]
|
||||
**Recipient** | [**AccountSource**](account-source) | | [optional]
|
||||
**TrackingNumber** | **String** | Account activity's tracking number. | [optional]
|
||||
**Errors** | **[]String** | Errors provided by the source while completing account actions. | [optional]
|
||||
**Warnings** | **[]String** | Warnings provided by the source while completing account actions. | [optional]
|
||||
**Approvals** | [**[]Approval**](approval) | Approvals performed on an item during activity. | [optional]
|
||||
**OriginalRequests** | [**[]OriginalRequest**](original-request) | Original actions that triggered all individual source actions related to the account action. | [optional]
|
||||
**ExpansionItems** | [**[]ExpansionItem**](expansion-item) | Controls that translated the attribute requests into actual provisioning actions on the source. | [optional]
|
||||
**AccountRequests** | [**[]AccountRequest**](account-request) | Account data for each individual source action triggered by the original requests. | [optional]
|
||||
**Sources** | **String** | Sources involved in the account activity. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,22 +16,22 @@ tags: ['SDK', 'Software Development Kit', 'AccountActivityItem', 'AccountActivit
|
||||
|
||||
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,25 +16,25 @@ tags: ['SDK', 'Software Development Kit', 'AccountActivitySearchedItem', 'Accoun
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | | [required]
|
||||
**Name** | **String** | | [required]
|
||||
**Type** | [**DocumentType**](document-type) | | [required]
|
||||
**Action** | Pointer to **String** | Type of action performed in the activity. | [optional]
|
||||
**Created** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
|
||||
**Modified** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional]
|
||||
**Stage** | Pointer to **String** | Activity's current stage. | [optional]
|
||||
**Origin** | Pointer to **String** | Activity's origin. | [optional]
|
||||
**Status** | Pointer to **String** | Activity's current status. | [optional]
|
||||
**Requester** | Pointer to [**AccountSource**](account-source) | | [optional]
|
||||
**Recipient** | Pointer to [**AccountSource**](account-source) | | [optional]
|
||||
**TrackingNumber** | Pointer to **String** | Account activity's tracking number. | [optional]
|
||||
**Errors** | Pointer to **[]String** | Errors provided by the source while completing account actions. | [optional]
|
||||
**Warnings** | Pointer to **[]String** | Warnings provided by the source while completing account actions. | [optional]
|
||||
**Approvals** | Pointer to [**[]Approval**](approval) | Approvals performed on an item during activity. | [optional]
|
||||
**OriginalRequests** | Pointer to [**[]OriginalRequest**](original-request) | Original actions that triggered all individual source actions related to the account action. | [optional]
|
||||
**ExpansionItems** | Pointer to [**[]ExpansionItem**](expansion-item) | Controls that translated the attribute requests into actual provisioning actions on the source. | [optional]
|
||||
**AccountRequests** | Pointer to [**[]AccountRequest**](account-request) | Account data for each individual source action triggered by the original requests. | [optional]
|
||||
**Sources** | Pointer to **String** | Sources involved in the account activity. | [optional]
|
||||
**Id** | **String** | | [required]
|
||||
**Name** | **String** | | [required]
|
||||
**Type** | [**DocumentType**](document-type) | | [required]
|
||||
**Action** | **String** | Type of action performed in the activity. | [optional]
|
||||
**Created** | **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
|
||||
**Modified** | **System.DateTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional]
|
||||
**Stage** | **String** | Activity's current stage. | [optional]
|
||||
**Origin** | **String** | Activity's origin. | [optional]
|
||||
**Status** | **String** | Activity's current status. | [optional]
|
||||
**Requester** | [**AccountSource**](account-source) | | [optional]
|
||||
**Recipient** | [**AccountSource**](account-source) | | [optional]
|
||||
**TrackingNumber** | **String** | Account activity's tracking number. | [optional]
|
||||
**Errors** | **[]String** | Errors provided by the source while completing account actions. | [optional]
|
||||
**Warnings** | **[]String** | Warnings provided by the source while completing account actions. | [optional]
|
||||
**Approvals** | [**[]Approval**](approval) | Approvals performed on an item during activity. | [optional]
|
||||
**OriginalRequests** | [**[]OriginalRequest**](original-request) | Original actions that triggered all individual source actions related to the account action. | [optional]
|
||||
**ExpansionItems** | [**[]ExpansionItem**](expansion-item) | Controls that translated the attribute requests into actual provisioning actions on the source. | [optional]
|
||||
**AccountRequests** | [**[]AccountRequest**](account-request) | Account data for each individual source action triggered by the original requests. | [optional]
|
||||
**Sources** | **String** | Sources involved in the account activity. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,15 +16,15 @@ tags: ['SDK', 'Software Development Kit', 'AccountAttribute', 'AccountAttribute'
|
||||
|
||||
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', 'AccountAttribute
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The schema attribute values for the account | [required]
|
||||
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | The schema attribute values for the account | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'AccountAttributesCreate', 'AccountAtt
|
||||
|
||||
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,12 +16,12 @@ tags: ['SDK', 'Software Development Kit', 'AccountRequest', 'AccountRequest']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**AccountId** | Pointer to **String** | Unique ID of the account | [optional]
|
||||
**AttributeRequests** | Pointer to [**[]AttributeRequest**](attribute-request) | | [optional]
|
||||
**Op** | Pointer to **String** | The operation that was performed | [optional]
|
||||
**ProvisioningTarget** | Pointer to [**AccountSource**](account-source) | | [optional]
|
||||
**Result** | Pointer to [**AccountRequestResult**](account-request-result) | | [optional]
|
||||
**Source** | Pointer to [**AccountSource**](account-source) | | [optional]
|
||||
**AccountId** | **String** | Unique ID of the account | [optional]
|
||||
**AttributeRequests** | [**[]AttributeRequest**](attribute-request) | | [optional]
|
||||
**Op** | **String** | The operation that was performed | [optional]
|
||||
**ProvisioningTarget** | [**AccountSource**](account-source) | | [optional]
|
||||
**Result** | [**AccountRequestResult**](account-request-result) | | [optional]
|
||||
**Source** | [**AccountSource**](account-source) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccountRequestInfo', 'AccountRequestI
|
||||
|
||||
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,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccountRequestResult', 'AccountReques
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Errors** | Pointer to **[]String** | | [optional]
|
||||
**Status** | Pointer to **String** | The status of the account request | [optional]
|
||||
**TicketId** | Pointer to **String** | | [optional]
|
||||
**Errors** | **[]String** | | [optional]
|
||||
**Status** | **String** | The status of the account request | [optional]
|
||||
**TicketId** | **String** | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccountSource', 'AccountSource']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | Pointer to **String** | The unique ID of the referenced object. | [optional]
|
||||
**Name** | Pointer to **String** | The human readable name of the referenced object. | [optional]
|
||||
**Type** | Pointer to **String** | Type of source returned. | [optional]
|
||||
**Id** | **String** | The unique ID of the referenced object. | [optional]
|
||||
**Name** | **String** | The human readable name of the referenced object. | [optional]
|
||||
**Type** | **String** | Type of source returned. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccountToggleRequest', 'AccountToggle
|
||||
|
||||
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. Providing 'true' for an unlocked account will add and process 'Unlock' operation by the workflow. | [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. Providing 'true' for an unlocked account will add and process 'Unlock' operation by the workflow. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccountUnlockRequest', 'AccountUnlock
|
||||
|
||||
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', 'AccountUsage']
|
||||
|
||||
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', 'AccountsAsyncR
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | id of the task | [required]
|
||||
**Id** | **String** | id of the task | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AccountsExportReportArguments', 'Acco
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Application** | **String** | Source ID. | [required]
|
||||
**SourceName** | **String** | Source name. | [required]
|
||||
**Application** | **String** | Source ID. | [required]
|
||||
**SourceName** | **String** | Source name. | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'ActivateCampaignOptions', 'ActivateCa
|
||||
|
||||
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', 'ActivityInsights', 'ActivityInsights'
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**AccountID** | Pointer to **String** | UUID of the account | [optional]
|
||||
**UsageDays** | Pointer to **Int32** | The number of days of activity | [optional]
|
||||
**UsageDaysState** | Pointer to **Enum** [ "COMPLETE", "UNKNOWN" ] | Status indicating if the activity is complete or unknown | [optional]
|
||||
**AccountID** | **String** | UUID of the account | [optional]
|
||||
**UsageDays** | **Int32** | The number of days of activity | [optional]
|
||||
**UsageDaysState** | **Enum** [ "COMPLETE", "UNKNOWN" ] | Status indicating if the activity is complete or unknown | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AdminReviewReassign', 'AdminReviewRea
|
||||
|
||||
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', 'Admi
|
||||
|
||||
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,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AggregationResult', 'AggregationResul
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Aggregations** | Pointer to [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The document containing the results of the aggregation. This document is controlled by Elasticsearch and depends on the type of aggregation query that is run. See Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) documentation for information. | [optional]
|
||||
**Hits** | Pointer to [**[]SearchDocument**](search-document) | The results of the aggregation search query. | [optional]
|
||||
**Aggregations** | [**SystemCollectionsHashtable**]https://learn.microsoft.com/en-us/dotnet/api/system.collections.hashtable?view=net-9.0 | The document containing the results of the aggregation. This document is controlled by Elasticsearch and depends on the type of aggregation query that is run. See Elasticsearch [Aggregations](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/search-aggregations.html) documentation for information. | [optional]
|
||||
**Hits** | [**[]SearchDocument**](search-document) | The results of the aggregation search query. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,10 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'Aggregations', 'Aggregations']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Nested** | Pointer to [**NestedAggregation**](nested-aggregation) | | [optional]
|
||||
**Metric** | Pointer to [**MetricAggregation**](metric-aggregation) | | [optional]
|
||||
**VarFilter** | Pointer to [**FilterAggregation**](filter-aggregation) | | [optional]
|
||||
**Bucket** | Pointer to [**BucketAggregation**](bucket-aggregation) | | [optional]
|
||||
**Nested** | [**NestedAggregation**](nested-aggregation) | | [optional]
|
||||
**Metric** | [**MetricAggregation**](metric-aggregation) | | [optional]
|
||||
**VarFilter** | [**FilterAggregation**](filter-aggregation) | | [optional]
|
||||
**Bucket** | [**BucketAggregation**](bucket-aggregation) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,10 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'App', 'App']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | Pointer to **String** | The unique ID of the referenced object. | [optional]
|
||||
**Name** | Pointer to **String** | The human readable name of the referenced object. | [optional]
|
||||
**Source** | Pointer to [**Reference1**](reference1) | | [optional]
|
||||
**Account** | Pointer to [**AppAllOfAccount**](app-all-of-account) | | [optional]
|
||||
**Id** | **String** | The unique ID of the referenced object. | [optional]
|
||||
**Name** | **String** | The human readable name of the referenced object. | [optional]
|
||||
**Source** | [**Reference1**](reference1) | | [optional]
|
||||
**Account** | [**AppAllOfAccount**](app-all-of-account) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'AppAllOfAccount', 'AppAllOfAccount']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | Pointer to **String** | The SailPoint generated unique ID | [optional]
|
||||
**AccountId** | Pointer to **String** | The account ID generated by the source | [optional]
|
||||
**Id** | **String** | The SailPoint generated unique ID | [optional]
|
||||
**AccountId** | **String** | The account ID generated by the source | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,12 +16,12 @@ tags: ['SDK', 'Software Development Kit', 'Approval', 'Approval']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Comments** | Pointer to [**[]ApprovalComment**](approval-comment) | | [optional]
|
||||
**Created** | Pointer to **System.DateTime** | A date-time in ISO-8601 format | [optional]
|
||||
**Modified** | Pointer to **System.DateTime** | A date-time in ISO-8601 format | [optional]
|
||||
**Owner** | Pointer to [**AccountSource**](account-source) | | [optional]
|
||||
**Result** | Pointer to **String** | The result of the approval | [optional]
|
||||
**Type** | Pointer to **String** | | [optional]
|
||||
**Comments** | [**[]ApprovalComment**](approval-comment) | | [optional]
|
||||
**Created** | **System.DateTime** | A date-time in ISO-8601 format | [optional]
|
||||
**Modified** | **System.DateTime** | A date-time in ISO-8601 format | [optional]
|
||||
**Owner** | [**AccountSource**](account-source) | | [optional]
|
||||
**Result** | **String** | The result of the approval | [optional]
|
||||
**Type** | **String** | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'ApprovalComment', 'ApprovalComment']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Comment** | Pointer to **String** | The comment text | [optional]
|
||||
**Commenter** | Pointer to **String** | The name of the commenter | [optional]
|
||||
**Date** | Pointer to **System.DateTime** | A date-time in ISO-8601 format | [optional]
|
||||
**Comment** | **String** | The comment text | [optional]
|
||||
**Commenter** | **String** | The name of the commenter | [optional]
|
||||
**Date** | **System.DateTime** | A date-time in ISO-8601 format | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,12 +16,12 @@ tags: ['SDK', 'Software Development Kit', 'ApprovalForwardHistory', 'ApprovalFor
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**OldApproverName** | Pointer to **String** | Display name of approver from whom the approval was forwarded. | [optional]
|
||||
**NewApproverName** | Pointer to **String** | Display name of approver to whom the approval was forwarded. | [optional]
|
||||
**Comment** | Pointer to **String** | Comment made while forwarding. | [optional]
|
||||
**Modified** | Pointer to **System.DateTime** | Time at which approval was forwarded. | [optional]
|
||||
**ForwarderName** | Pointer to **String** | Display name of forwarder who forwarded the approval. | [optional]
|
||||
**ReassignmentType** | Pointer to [**ReassignmentType**](reassignment-type) | | [optional]
|
||||
**OldApproverName** | **String** | Display name of approver from whom the approval was forwarded. | [optional]
|
||||
**NewApproverName** | **String** | Display name of approver to whom the approval was forwarded. | [optional]
|
||||
**Comment** | **String** | Comment made while forwarding. | [optional]
|
||||
**Modified** | **System.DateTime** | Time at which approval was forwarded. | [optional]
|
||||
**ForwarderName** | **String** | Display name of forwarder who forwarded the approval. | [optional]
|
||||
**ReassignmentType** | [**ReassignmentType**](reassignment-type) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,13 +16,13 @@ tags: ['SDK', 'Software Development Kit', 'ApprovalItemDetails', 'ApprovalItemDe
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | Pointer to **String** | The approval item's ID | [optional]
|
||||
**Account** | Pointer to **String** | The account referenced by the approval item | [optional]
|
||||
**Application** | Pointer to **String** | The name of the application/source | [optional]
|
||||
**Name** | Pointer to **String** | The attribute's name | [optional]
|
||||
**Operation** | Pointer to **String** | The attribute's operation | [optional]
|
||||
**Value** | Pointer to **String** | The attribute's value | [optional]
|
||||
**State** | Pointer to [**WorkItemState**](work-item-state) | | [optional]
|
||||
**Id** | **String** | The approval item's ID | [optional]
|
||||
**Account** | **String** | The account referenced by the approval item | [optional]
|
||||
**Application** | **String** | The name of the application/source | [optional]
|
||||
**Name** | **String** | The attribute's name | [optional]
|
||||
**Operation** | **String** | The attribute's operation | [optional]
|
||||
**Value** | **String** | The attribute's value | [optional]
|
||||
**State** | [**WorkItemState**](work-item-state) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,13 +16,13 @@ tags: ['SDK', 'Software Development Kit', 'ApprovalItems', 'ApprovalItems']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | Pointer to **String** | The approval item's ID | [optional]
|
||||
**Account** | Pointer to **String** | The account referenced by the approval item | [optional]
|
||||
**Application** | Pointer to **String** | The name of the application/source | [optional]
|
||||
**Name** | Pointer to **String** | The attribute's name | [optional]
|
||||
**Operation** | Pointer to **String** | The attribute's operation | [optional]
|
||||
**Value** | Pointer to **String** | The attribute's value | [optional]
|
||||
**State** | Pointer to [**WorkItemState**](work-item-state) | | [optional]
|
||||
**Id** | **String** | The approval item's ID | [optional]
|
||||
**Account** | **String** | The account referenced by the approval item | [optional]
|
||||
**Application** | **String** | The name of the application/source | [optional]
|
||||
**Name** | **String** | The attribute's name | [optional]
|
||||
**Operation** | **String** | The attribute's operation | [optional]
|
||||
**Value** | **String** | The attribute's value | [optional]
|
||||
**State** | [**WorkItemState**](work-item-state) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,10 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'ApprovalReminderAndEscalationConfig',
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**DaysUntilEscalation** | Pointer to **Int32** | Number of days to wait before the first reminder. If no reminders are configured, then this is the number of days to wait before escalation. | [optional]
|
||||
**DaysBetweenReminders** | Pointer to **Int32** | Number of days to wait between reminder notifications. | [optional]
|
||||
**MaxReminders** | Pointer to **Int32** | Maximum number of reminder notification to send to the reviewer before approval escalation. | [optional]
|
||||
**FallbackApproverRef** | Pointer to [**IdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional]
|
||||
**DaysUntilEscalation** | **Int32** | Number of days to wait before the first reminder. If no reminders are configured, then this is the number of days to wait before escalation. | [optional]
|
||||
**DaysBetweenReminders** | **Int32** | Number of days to wait between reminder notifications. | [optional]
|
||||
**MaxReminders** | **Int32** | Maximum number of reminder notification to send to the reviewer before approval escalation. | [optional]
|
||||
**FallbackApproverRef** | [**IdentityReferenceWithNameAndEmail**](identity-reference-with-name-and-email) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'ApprovalSchemeForRole', 'ApprovalSche
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**ApproverType** | Pointer to **Enum** [ "OWNER", "MANAGER", "GOVERNANCE_GROUP" ] | Describes the individual or group that is responsible for an approval step. Values are as follows. **OWNER**: Owner of the associated Role **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** [ "OWNER", "MANAGER", "GOVERNANCE_GROUP" ] | Describes the individual or group that is responsible for an approval step. Values are as follows. **OWNER**: Owner of the associated Role **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,16 +16,16 @@ tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDto', 'ApprovalStatusDt
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**ApprovalId** | Pointer to **String** | Unique identifier for the approval. | [optional]
|
||||
**Forwarded** | Pointer to **Boolean** | True if the request for this item was forwarded from one owner to another. | [optional] [default to $false]
|
||||
**OriginalOwner** | Pointer to [**ApprovalStatusDtoOriginalOwner**](approval-status-dto-original-owner) | | [optional]
|
||||
**CurrentOwner** | Pointer to [**ApprovalStatusDtoCurrentOwner**](approval-status-dto-current-owner) | | [optional]
|
||||
**Modified** | Pointer to **System.DateTime** | Time at which item was modified. | [optional]
|
||||
**Status** | Pointer to [**ManualWorkItemState**](manual-work-item-state) | | [optional]
|
||||
**Scheme** | Pointer to [**ApprovalScheme**](approval-scheme) | | [optional]
|
||||
**ErrorMessages** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | If the request failed, includes any error messages that were generated. | [optional]
|
||||
**Comment** | Pointer to **String** | Comment, if any, provided by the approver. | [optional]
|
||||
**RemoveDate** | Pointer to **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional]
|
||||
**ApprovalId** | **String** | Unique identifier for the approval. | [optional]
|
||||
**Forwarded** | **Boolean** | True if the request for this item was forwarded from one owner to another. | [optional] [default to $false]
|
||||
**OriginalOwner** | [**ApprovalStatusDtoOriginalOwner**](approval-status-dto-original-owner) | | [optional]
|
||||
**CurrentOwner** | [**ApprovalStatusDtoCurrentOwner**](approval-status-dto-current-owner) | | [optional]
|
||||
**Modified** | **System.DateTime** | Time at which item was modified. | [optional]
|
||||
**Status** | [**ManualWorkItemState**](manual-work-item-state) | | [optional]
|
||||
**Scheme** | [**ApprovalScheme**](approval-scheme) | | [optional]
|
||||
**ErrorMessages** | [**[]ErrorMessageDto**](error-message-dto) | If the request failed, includes any error messages that were generated. | [optional]
|
||||
**Comment** | **String** | Comment, if any, provided by the approver. | [optional]
|
||||
**RemoveDate** | **System.DateTime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDtoCurrentOwner', 'Appr
|
||||
|
||||
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,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDtoOriginalOwner', 'App
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | Pointer to **Enum** [ "GOVERNANCE_GROUP", "IDENTITY" ] | DTO type of original approval owner's identity. | [optional]
|
||||
**Id** | Pointer to **String** | ID of original approval owner's identity. | [optional]
|
||||
**Name** | Pointer to **String** | Display name of original approval owner. | [optional]
|
||||
**Type** | **Enum** [ "GOVERNANCE_GROUP", "IDENTITY" ] | DTO type of original approval owner's identity. | [optional]
|
||||
**Id** | **String** | ID of original approval owner's identity. | [optional]
|
||||
**Name** | **String** | Display name of original approval owner. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'ApprovalSummary', 'ApprovalSummary']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Pending** | Pointer to **Int32** | The number of pending access requests approvals. | [optional]
|
||||
**Approved** | Pointer to **Int32** | The number of approved access requests approvals. | [optional]
|
||||
**Rejected** | Pointer to **Int32** | The number of rejected access requests approvals. | [optional]
|
||||
**Pending** | **Int32** | The number of pending access requests approvals. | [optional]
|
||||
**Approved** | **Int32** | The number of approved access requests approvals. | [optional]
|
||||
**Rejected** | **Int32** | The number of rejected access requests approvals. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,14 +16,14 @@ tags: ['SDK', 'Software Development Kit', 'AttributeDTO', 'AttributeDTO']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Key** | Pointer to **String** | Technical name of the Attribute. This is unique and cannot be changed after creation. | [optional]
|
||||
**Name** | Pointer to **String** | The display name of the key. | [optional]
|
||||
**Multiselect** | Pointer to **Boolean** | Indicates whether the attribute can have multiple values. | [optional] [default to $false]
|
||||
**Status** | Pointer to **String** | The status of the Attribute. | [optional]
|
||||
**Type** | Pointer to **String** | The type of the Attribute. This can be either ""custom"" or ""governance"". | [optional]
|
||||
**ObjectTypes** | Pointer to **[]String** | An array of object types this attributes values can be applied to. Possible values are ""all"" or ""entitlement"". Value ""all"" means this attribute can be used with all object types that are supported. | [optional]
|
||||
**Description** | Pointer to **String** | The description of the Attribute. | [optional]
|
||||
**Values** | Pointer to [**[]AttributeValueDTO**](attribute-value-dto) | | [optional]
|
||||
**Key** | **String** | Technical name of the Attribute. This is unique and cannot be changed after creation. | [optional]
|
||||
**Name** | **String** | The display name of the key. | [optional]
|
||||
**Multiselect** | **Boolean** | Indicates whether the attribute can have multiple values. | [optional] [default to $false]
|
||||
**Status** | **String** | The status of the Attribute. | [optional]
|
||||
**Type** | **String** | The type of the Attribute. This can be either ""custom"" or ""governance"". | [optional]
|
||||
**ObjectTypes** | **[]String** | An array of object types this attributes values can be applied to. Possible values are ""all"" or ""entitlement"". Value ""all"" means this attribute can be used with all object types that are supported. | [optional]
|
||||
**Description** | **String** | The description of the Attribute. | [optional]
|
||||
**Values** | [**[]AttributeValueDTO**](attribute-value-dto) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'AttributeDTOList', 'AttributeDTOList'
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Attributes** | Pointer to [**[]AttributeDTO**](attribute-dto) | | [optional]
|
||||
**Attributes** | [**[]AttributeDTO**](attribute-dto) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,13 +16,13 @@ tags: ['SDK', 'Software Development Kit', 'AttributeDefinition', 'AttributeDefin
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Name** | Pointer to **String** | The name of the attribute. | [optional]
|
||||
**Type** | Pointer to [**AttributeDefinitionType**](attribute-definition-type) | | [optional]
|
||||
**Schema** | Pointer to [**AttributeDefinitionSchema**](attribute-definition-schema) | | [optional]
|
||||
**Description** | Pointer to **String** | A human-readable description of the attribute. | [optional]
|
||||
**IsMulti** | Pointer to **Boolean** | Flag indicating whether or not the attribute is multi-valued. | [optional] [default to $false]
|
||||
**IsEntitlement** | Pointer to **Boolean** | Flag indicating whether or not the attribute is an entitlement. | [optional] [default to $false]
|
||||
**IsGroup** | Pointer to **Boolean** | Flag indicating whether or not the attribute represents a group. This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute.. | [optional] [default to $false]
|
||||
**Name** | **String** | The name of the attribute. | [optional]
|
||||
**Type** | [**AttributeDefinitionType**](attribute-definition-type) | | [optional]
|
||||
**Schema** | [**AttributeDefinitionSchema**](attribute-definition-schema) | | [optional]
|
||||
**Description** | **String** | A human-readable description of the attribute. | [optional]
|
||||
**IsMulti** | **Boolean** | Flag indicating whether or not the attribute is multi-valued. | [optional] [default to $false]
|
||||
**IsEntitlement** | **Boolean** | Flag indicating whether or not the attribute is an entitlement. | [optional] [default to $false]
|
||||
**IsGroup** | **Boolean** | Flag indicating whether or not the attribute represents a group. This can only be `true` if `isEntitlement` is also `true` **and** there is a schema defined for the attribute.. | [optional] [default to $false]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AttributeDefinitionSchema', 'Attribut
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | Pointer to **Enum** [ "CONNECTOR_SCHEMA" ] | The type of object being referenced | [optional]
|
||||
**Id** | Pointer to **String** | The object ID this reference applies to. | [optional]
|
||||
**Name** | Pointer to **String** | The human-readable display name of the object. | [optional]
|
||||
**Type** | **Enum** [ "CONNECTOR_SCHEMA" ] | The type of object being referenced | [optional]
|
||||
**Id** | **String** | The object ID this reference applies to. | [optional]
|
||||
**Name** | **String** | The human-readable display name of the object. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AttributeRequest', 'AttributeRequest'
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Name** | Pointer to **String** | Attribute name. | [optional]
|
||||
**Op** | Pointer to **String** | Operation to perform on attribute. | [optional]
|
||||
**Value** | Pointer to **String** | Value of attribute. | [optional]
|
||||
**Name** | **String** | Attribute name. | [optional]
|
||||
**Op** | **String** | Operation to perform on attribute. | [optional]
|
||||
**Value** | **String** | Value of attribute. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AttributeValueDTO', 'AttributeValueDT
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Value** | Pointer to **String** | Technical name of the Attribute value. This is unique and cannot be changed after creation. | [optional]
|
||||
**Name** | Pointer to **String** | The display name of the Attribute value. | [optional]
|
||||
**Status** | Pointer to **String** | The status of the Attribute value. | [optional]
|
||||
**Value** | **String** | Technical name of the Attribute value. This is unique and cannot be changed after creation. | [optional]
|
||||
**Name** | **String** | The display name of the Attribute value. | [optional]
|
||||
**Status** | **String** | The status of the Attribute value. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,23 +16,23 @@ tags: ['SDK', 'Software Development Kit', 'AuthUser', 'AuthUser']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Tenant** | Pointer to **String** | Tenant name. | [optional]
|
||||
**Id** | Pointer to **String** | Identity ID. | [optional]
|
||||
**Uid** | Pointer to **String** | Identity's unique identitifier. | [optional]
|
||||
**VarProfile** | Pointer to **String** | ID of the auth profile associated with the auth user. | [optional]
|
||||
**IdentificationNumber** | Pointer to **String** | Auth user's employee number. | [optional]
|
||||
**Email** | Pointer to **String** | Auth user's email. | [optional]
|
||||
**Phone** | Pointer to **String** | Auth user's phone number. | [optional]
|
||||
**WorkPhone** | Pointer to **String** | Auth user's work phone number. | [optional]
|
||||
**PersonalEmail** | Pointer to **String** | Auth user's personal email. | [optional]
|
||||
**Firstname** | Pointer to **String** | Auth user's first name. | [optional]
|
||||
**Lastname** | Pointer to **String** | Auth user's last name. | [optional]
|
||||
**DisplayName** | Pointer to **String** | Auth user's name in displayed format. | [optional]
|
||||
**Alias** | Pointer to **String** | Auth user's alias. | [optional]
|
||||
**LastPasswordChangeDate** | Pointer to **String** | Date of last password change. | [optional]
|
||||
**LastLoginTimestamp** | Pointer to **Int64** | Timestamp of the last login (long type value). | [optional]
|
||||
**CurrentLoginTimestamp** | Pointer to **Int64** | Timestamp of the current login (long type value). | [optional]
|
||||
**Capabilities** | Pointer to **[]String** | Array of the auth user's capabilities. | [optional]
|
||||
**Tenant** | **String** | Tenant name. | [optional]
|
||||
**Id** | **String** | Identity ID. | [optional]
|
||||
**Uid** | **String** | Identity's unique identitifier. | [optional]
|
||||
**VarProfile** | **String** | ID of the auth profile associated with the auth user. | [optional]
|
||||
**IdentificationNumber** | **String** | Auth user's employee number. | [optional]
|
||||
**Email** | **String** | Auth user's email. | [optional]
|
||||
**Phone** | **String** | Auth user's phone number. | [optional]
|
||||
**WorkPhone** | **String** | Auth user's work phone number. | [optional]
|
||||
**PersonalEmail** | **String** | Auth user's personal email. | [optional]
|
||||
**Firstname** | **String** | Auth user's first name. | [optional]
|
||||
**Lastname** | **String** | Auth user's last name. | [optional]
|
||||
**DisplayName** | **String** | Auth user's name in displayed format. | [optional]
|
||||
**Alias** | **String** | Auth user's alias. | [optional]
|
||||
**LastPasswordChangeDate** | **String** | Date of last password change. | [optional]
|
||||
**LastLoginTimestamp** | **Int64** | Timestamp of the last login (long type value). | [optional]
|
||||
**CurrentLoginTimestamp** | **Int64** | Timestamp of the current login (long type value). | [optional]
|
||||
**Capabilities** | **[]String** | Array of the auth user's capabilities. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'BackupOptions', 'BackupOptions']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**IncludeTypes** | Pointer to **[]String** | Object type names to be included in a Configuration Hub backup command. | [optional]
|
||||
**ObjectOptions** | Pointer to [**map[string]ObjectExportImportNames**](object-export-import-names) | Additional options targeting specific objects related to each item in the includeTypes field. | [optional]
|
||||
**IncludeTypes** | **[]String** | Object type names to be included in a Configuration Hub backup command. | [optional]
|
||||
**ObjectOptions** | [**map[string]ObjectExportImportNames**](object-export-import-names) | Additional options targeting specific objects related to each item in the includeTypes field. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,23 +16,23 @@ tags: ['SDK', 'Software Development Kit', 'BackupResponse', 'BackupResponse']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**JobId** | Pointer to **String** | Unique id assigned to this backup. | [optional]
|
||||
**Status** | Pointer to **Enum** [ "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "CANCELLED", "FAILED" ] | Status of the backup. | [optional]
|
||||
**Type** | Pointer to **Enum** [ "BACKUP" ] | Type of the job, will always be BACKUP for this type of job. | [optional]
|
||||
**Tenant** | Pointer to **String** | The name of the tenant performing the upload | [optional]
|
||||
**RequesterName** | Pointer to **String** | The name of the requester. | [optional]
|
||||
**FileExists** | Pointer to **Boolean** | Whether or not a file was created and stored for this backup. | [optional] [default to $true]
|
||||
**Created** | Pointer to **System.DateTime** | The time the job was started. | [optional]
|
||||
**Modified** | Pointer to **System.DateTime** | The time of the last update to the job. | [optional]
|
||||
**Completed** | Pointer to **System.DateTime** | The time the job was completed. | [optional]
|
||||
**Name** | Pointer to **String** | The name assigned to the upload file in the request body. | [optional]
|
||||
**UserCanDelete** | Pointer to **Boolean** | Whether this backup can be deleted by a regular user. | [optional] [default to $true]
|
||||
**IsPartial** | Pointer to **Boolean** | Whether this backup contains all supported object types or only some of them. | [optional] [default to $false]
|
||||
**BackupType** | Pointer to **Enum** [ "UPLOADED", "AUTOMATED", "MANUAL" ] | Denotes how this backup was created. - MANUAL - The backup was created by a user. - AUTOMATED - The backup was created by devops. - AUTOMATED_DRAFT - The backup was created during a draft process. - UPLOADED - The backup was created by uploading an existing configuration file. | [optional]
|
||||
**Options** | Pointer to [**BackupOptions**](backup-options) | | [optional]
|
||||
**HydrationStatus** | Pointer to **Enum** [ "HYDRATED", "NOT_HYDRATED" ] | Whether the object details of this backup are ready. | [optional]
|
||||
**TotalObjectCount** | Pointer to **Int64** | Number of objects contained in this backup. | [optional]
|
||||
**CloudStorageStatus** | Pointer to **Enum** [ "SYNCED", "NOT_SYNCED", "SYNC_FAILED" ] | Whether this backup has been transferred to a customer storage location. | [optional]
|
||||
**JobId** | **String** | Unique id assigned to this backup. | [optional]
|
||||
**Status** | **Enum** [ "NOT_STARTED", "IN_PROGRESS", "COMPLETE", "CANCELLED", "FAILED" ] | Status of the backup. | [optional]
|
||||
**Type** | **Enum** [ "BACKUP" ] | Type of the job, will always be BACKUP for this type of job. | [optional]
|
||||
**Tenant** | **String** | The name of the tenant performing the upload | [optional]
|
||||
**RequesterName** | **String** | The name of the requester. | [optional]
|
||||
**FileExists** | **Boolean** | Whether or not a file was created and stored for this backup. | [optional] [default to $true]
|
||||
**Created** | **System.DateTime** | The time the job was started. | [optional]
|
||||
**Modified** | **System.DateTime** | The time of the last update to the job. | [optional]
|
||||
**Completed** | **System.DateTime** | The time the job was completed. | [optional]
|
||||
**Name** | **String** | The name assigned to the upload file in the request body. | [optional]
|
||||
**UserCanDelete** | **Boolean** | Whether this backup can be deleted by a regular user. | [optional] [default to $true]
|
||||
**IsPartial** | **Boolean** | Whether this backup contains all supported object types or only some of them. | [optional] [default to $false]
|
||||
**BackupType** | **Enum** [ "UPLOADED", "AUTOMATED", "MANUAL" ] | Denotes how this backup was created. - MANUAL - The backup was created by a user. - AUTOMATED - The backup was created by devops. - AUTOMATED_DRAFT - The backup was created during a draft process. - UPLOADED - The backup was created by uploading an existing configuration file. | [optional]
|
||||
**Options** | [**BackupOptions**](backup-options) | | [optional]
|
||||
**HydrationStatus** | **Enum** [ "HYDRATED", "NOT_HYDRATED" ] | Whether the object details of this backup are ready. | [optional]
|
||||
**TotalObjectCount** | **Int64** | Number of objects contained in this backup. | [optional]
|
||||
**CloudStorageStatus** | **Enum** [ "SYNCED", "NOT_SYNCED", "SYNC_FAILED" ] | Whether this backup has been transferred to a customer storage location. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'Base64Decode', 'Base64Decode']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**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]
|
||||
**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,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'Base64Encode', 'Base64Encode']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**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]
|
||||
**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,16 +16,16 @@ tags: ['SDK', 'Software Development Kit', 'BaseAccess', 'BaseAccess']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | Pointer to **String** | The unique ID of the referenced object. | [optional]
|
||||
**Name** | Pointer to **String** | The human readable name of the referenced object. | [optional]
|
||||
**Description** | Pointer to **String** | Access item's description. | [optional]
|
||||
**Created** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
|
||||
**Modified** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional]
|
||||
**Synced** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional]
|
||||
**Enabled** | Pointer to **Boolean** | Indicates whether the access item is currently enabled. | [optional] [default to $false]
|
||||
**Requestable** | Pointer to **Boolean** | Indicates whether the access item can be requested. | [optional] [default to $true]
|
||||
**RequestCommentsRequired** | Pointer to **Boolean** | Indicates whether comments are required for requests to access the item. | [optional] [default to $false]
|
||||
**Owner** | Pointer to [**BaseAccessAllOfOwner**](base-access-all-of-owner) | | [optional]
|
||||
**Id** | **String** | The unique ID of the referenced object. | [optional]
|
||||
**Name** | **String** | The human readable name of the referenced object. | [optional]
|
||||
**Description** | **String** | Access item's description. | [optional]
|
||||
**Created** | **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
|
||||
**Modified** | **System.DateTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional]
|
||||
**Synced** | **System.DateTime** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional]
|
||||
**Enabled** | **Boolean** | Indicates whether the access item is currently enabled. | [optional] [default to $false]
|
||||
**Requestable** | **Boolean** | Indicates whether the access item can be requested. | [optional] [default to $true]
|
||||
**RequestCommentsRequired** | **Boolean** | Indicates whether comments are required for requests to access the item. | [optional] [default to $false]
|
||||
**Owner** | [**BaseAccessAllOfOwner**](base-access-all-of-owner) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,10 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'BaseAccessAllOfOwner', 'BaseAccessAll
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | Pointer to **Enum** [ "IDENTITY" ] | Owner's DTO type. | [optional]
|
||||
**Id** | Pointer to **String** | Owner's identity ID. | [optional]
|
||||
**Name** | Pointer to **String** | Owner's display name. | [optional]
|
||||
**Email** | Pointer to **String** | Owner's email. | [optional]
|
||||
**Type** | **Enum** [ "IDENTITY" ] | Owner's DTO type. | [optional]
|
||||
**Id** | **String** | Owner's identity ID. | [optional]
|
||||
**Name** | **String** | Owner's display name. | [optional]
|
||||
**Email** | **String** | Owner's email. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'BaseAccessProfile', 'BaseAccessProfil
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | Pointer to **String** | Access profile's unique ID. | [optional]
|
||||
**Name** | Pointer to **String** | Access profile's display name. | [optional]
|
||||
**Id** | **String** | Access profile's unique ID. | [optional]
|
||||
**Name** | **String** | Access profile's display name. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,17 +16,17 @@ tags: ['SDK', 'Software Development Kit', 'BaseAccount', 'BaseAccount']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | Pointer to **String** | The unique ID of the referenced object. | [optional]
|
||||
**Name** | Pointer to **String** | The human readable name of the referenced object. | [optional]
|
||||
**AccountId** | Pointer to **String** | Account ID. | [optional]
|
||||
**Source** | Pointer to [**AccountSource**](account-source) | | [optional]
|
||||
**Disabled** | Pointer to **Boolean** | Indicates whether the account is disabled. | [optional] [default to $false]
|
||||
**Locked** | Pointer to **Boolean** | Indicates whether the account is locked. | [optional] [default to $false]
|
||||
**Privileged** | Pointer to **Boolean** | Indicates whether the account is privileged. | [optional] [default to $false]
|
||||
**ManuallyCorrelated** | Pointer to **Boolean** | Indicates whether the account has been manually correlated to an identity. | [optional] [default to $false]
|
||||
**PasswordLastSet** | Pointer to **System.DateTime** | A date-time in ISO-8601 format | [optional]
|
||||
**EntitlementAttributes** | Pointer to [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Map or dictionary of key/value pairs. | [optional]
|
||||
**Created** | Pointer to **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
|
||||
**Id** | **String** | The unique ID of the referenced object. | [optional]
|
||||
**Name** | **String** | The human readable name of the referenced object. | [optional]
|
||||
**AccountId** | **String** | Account ID. | [optional]
|
||||
**Source** | [**AccountSource**](account-source) | | [optional]
|
||||
**Disabled** | **Boolean** | Indicates whether the account is disabled. | [optional] [default to $false]
|
||||
**Locked** | **Boolean** | Indicates whether the account is locked. | [optional] [default to $false]
|
||||
**Privileged** | **Boolean** | Indicates whether the account is privileged. | [optional] [default to $false]
|
||||
**ManuallyCorrelated** | **Boolean** | Indicates whether the account has been manually correlated to an identity. | [optional] [default to $false]
|
||||
**PasswordLastSet** | **System.DateTime** | A date-time in ISO-8601 format | [optional]
|
||||
**EntitlementAttributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Map or dictionary of key/value pairs. | [optional]
|
||||
**Created** | **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,10 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'BaseCommonDto', 'BaseCommonDto']
|
||||
|
||||
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]
|
||||
**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]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'BaseDocument', 'BaseDocument']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | | [required]
|
||||
**Name** | **String** | | [required]
|
||||
**Type** | [**DocumentType**](document-type) | | [required]
|
||||
**Id** | **String** | | [required]
|
||||
**Name** | **String** | | [required]
|
||||
**Type** | [**DocumentType**](document-type) | | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,14 +16,14 @@ tags: ['SDK', 'Software Development Kit', 'BaseEntitlement', 'BaseEntitlement']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**HasPermissions** | Pointer to **Boolean** | Indicates whether the entitlement has permissions. | [optional] [default to $false]
|
||||
**Description** | Pointer to **String** | Entitlement's description. | [optional]
|
||||
**Attribute** | Pointer to **String** | Entitlement attribute's name. | [optional]
|
||||
**Value** | Pointer to **String** | Entitlement's value. | [optional]
|
||||
**Schema** | Pointer to **String** | Entitlement's schema. | [optional]
|
||||
**Privileged** | Pointer to **Boolean** | Indicates whether the entitlement is privileged. | [optional] [default to $false]
|
||||
**Id** | Pointer to **String** | Entitlement's ID. | [optional]
|
||||
**Name** | Pointer to **String** | Entitlement's name. | [optional]
|
||||
**HasPermissions** | **Boolean** | Indicates whether the entitlement has permissions. | [optional] [default to $false]
|
||||
**Description** | **String** | Entitlement's description. | [optional]
|
||||
**Attribute** | **String** | Entitlement attribute's name. | [optional]
|
||||
**Value** | **String** | Entitlement's value. | [optional]
|
||||
**Schema** | **String** | Entitlement's schema. | [optional]
|
||||
**Privileged** | **Boolean** | Indicates whether the entitlement is privileged. | [optional] [default to $false]
|
||||
**Id** | **String** | Entitlement's ID. | [optional]
|
||||
**Name** | **String** | Entitlement's name. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'BaseReferenceDto', 'BaseReferenceDto'
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | Pointer to [**DtoType**](dto-type) | | [optional]
|
||||
**Id** | Pointer to **String** | ID of the object to which this reference applies | [optional]
|
||||
**Name** | Pointer to **String** | Human-readable display name of the object to which this reference applies | [optional]
|
||||
**Type** | [**DtoType**](dto-type) | | [optional]
|
||||
**Id** | **String** | ID of the object to which this reference applies | [optional]
|
||||
**Name** | **String** | Human-readable display name of the object to which this reference applies | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'BaseSegment', 'BaseSegment']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | Pointer to **String** | Segment's unique ID. | [optional]
|
||||
**Name** | Pointer to **String** | Segment's display name. | [optional]
|
||||
**Id** | **String** | Segment's unique ID. | [optional]
|
||||
**Name** | **String** | Segment's display name. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'BeforeProvisioningRuleDto', 'BeforePr
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Type** | Pointer to **Enum** [ "RULE" ] | Before Provisioning Rule DTO type. | [optional]
|
||||
**Id** | Pointer to **String** | Before Provisioning Rule ID. | [optional]
|
||||
**Name** | Pointer to **String** | Rule display name. | [optional]
|
||||
**Type** | **Enum** [ "RULE" ] | Before Provisioning Rule DTO type. | [optional]
|
||||
**Id** | **String** | Before Provisioning Rule ID. | [optional]
|
||||
**Name** | **String** | Rule display name. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'Bound', 'Bound']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Value** | **String** | The value of the range's endpoint. | [required]
|
||||
**Inclusive** | Pointer to **Boolean** | Indicates if the endpoint is included in the range. | [optional] [default to $false]
|
||||
**Value** | **String** | The value of the range's endpoint. | [required]
|
||||
**Inclusive** | **Boolean** | Indicates if the endpoint is included in the range. | [optional] [default to $false]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,14 +16,14 @@ tags: ['SDK', 'Software Development Kit', 'BrandingItem', 'BrandingItem']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Name** | Pointer to **String** | name of branding item | [optional]
|
||||
**ProductName** | Pointer to **String** | product name | [optional]
|
||||
**ActionButtonColor** | Pointer to **String** | hex value of color for action button | [optional]
|
||||
**ActiveLinkColor** | Pointer to **String** | hex value of color for link | [optional]
|
||||
**NavigationColor** | Pointer to **String** | hex value of color for navigation bar | [optional]
|
||||
**EmailFromAddress** | Pointer to **String** | email from address | [optional]
|
||||
**StandardLogoURL** | Pointer to **String** | url to standard logo | [optional]
|
||||
**LoginInformationalMessage** | Pointer to **String** | login information message | [optional]
|
||||
**Name** | **String** | name of branding item | [optional]
|
||||
**ProductName** | **String** | product name | [optional]
|
||||
**ActionButtonColor** | **String** | hex value of color for action button | [optional]
|
||||
**ActiveLinkColor** | **String** | hex value of color for link | [optional]
|
||||
**NavigationColor** | **String** | hex value of color for navigation bar | [optional]
|
||||
**EmailFromAddress** | **String** | email from address | [optional]
|
||||
**StandardLogoURL** | **String** | url to standard logo | [optional]
|
||||
**LoginInformationalMessage** | **String** | login information message | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,14 +16,14 @@ tags: ['SDK', 'Software Development Kit', 'BrandingItemCreate', 'BrandingItemCre
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Name** | **String** | name of branding item | [required]
|
||||
**ProductName** | **String** | product name | [required]
|
||||
**ActionButtonColor** | Pointer to **String** | hex value of color for action button | [optional]
|
||||
**ActiveLinkColor** | Pointer to **String** | hex value of color for link | [optional]
|
||||
**NavigationColor** | Pointer to **String** | hex value of color for navigation bar | [optional]
|
||||
**EmailFromAddress** | Pointer to **String** | email from address | [optional]
|
||||
**LoginInformationalMessage** | Pointer to **String** | login information message | [optional]
|
||||
**FileStandard** | Pointer to **System.IO.FileInfo** | png file with logo | [optional]
|
||||
**Name** | **String** | name of branding item | [required]
|
||||
**ProductName** | **String** | product name | [required]
|
||||
**ActionButtonColor** | **String** | hex value of color for action button | [optional]
|
||||
**ActiveLinkColor** | **String** | hex value of color for link | [optional]
|
||||
**NavigationColor** | **String** | hex value of color for navigation bar | [optional]
|
||||
**EmailFromAddress** | **String** | email from address | [optional]
|
||||
**LoginInformationalMessage** | **String** | login information message | [optional]
|
||||
**FileStandard** | **System.IO.FileInfo** | png file with logo | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,11 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'BucketAggregation', 'BucketAggregatio
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Name** | **String** | The name of the bucket aggregate to be included in the result. | [required]
|
||||
**Type** | Pointer to [**BucketType**](bucket-type) | | [optional]
|
||||
**Field** | **String** | The field to bucket on. Prefix the field name with '@' to reference a nested object. | [required]
|
||||
**Size** | Pointer to **Int32** | Maximum number of buckets to include. | [optional]
|
||||
**MinDocCount** | Pointer to **Int32** | Minimum number of documents a bucket should have. | [optional]
|
||||
**Name** | **String** | The name of the bucket aggregate to be included in the result. | [required]
|
||||
**Type** | [**BucketType**](bucket-type) | | [optional]
|
||||
**Field** | **String** | The field to bucket on. Prefix the field name with '@' to reference a nested object. | [required]
|
||||
**Size** | **Int32** | Maximum number of buckets to include. | [optional]
|
||||
**MinDocCount** | **Int32** | Minimum number of documents a bucket should have. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'BulkAddTaggedObject', 'BulkAddTaggedO
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**ObjectRefs** | Pointer to [**[]TaggedObjectDto**](tagged-object-dto) | | [optional]
|
||||
**Tags** | Pointer to **[]String** | Label to be applied to an Object | [optional]
|
||||
**Operation** | Pointer to **Enum** [ "APPEND", "MERGE" ] | If APPEND, tags are appended to the list of tags for the object. A 400 error is returned if this would add duplicate tags to the object. If MERGE, tags are merged with the existing tags. Duplicate tags are silently ignored. | [optional] [default to "APPEND"]
|
||||
**ObjectRefs** | [**[]TaggedObjectDto**](tagged-object-dto) | | [optional]
|
||||
**Tags** | **[]String** | Label to be applied to an Object | [optional]
|
||||
**Operation** | **Enum** [ "APPEND", "MERGE" ] | If APPEND, tags are appended to the list of tags for the object. A 400 error is returned if this would add duplicate tags to the object. If MERGE, tags are merged with the existing tags. Duplicate tags are silently ignored. | [optional] [default to "APPEND"]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'BulkRemoveTaggedObject', 'BulkRemoveT
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**ObjectRefs** | Pointer to [**[]TaggedObjectDto**](tagged-object-dto) | | [optional]
|
||||
**Tags** | Pointer to **[]String** | Label to be applied to an Object | [optional]
|
||||
**ObjectRefs** | [**[]TaggedObjectDto**](tagged-object-dto) | | [optional]
|
||||
**Tags** | **[]String** | Label to be applied to an Object | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'BulkTaggedObjectResponse', 'BulkTagge
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**ObjectRefs** | Pointer to [**[]TaggedObjectDto**](tagged-object-dto) | | [optional]
|
||||
**Tags** | Pointer to **[]String** | Label to be applied to an Object | [optional]
|
||||
**ObjectRefs** | [**[]TaggedObjectDto**](tagged-object-dto) | | [optional]
|
||||
**Tags** | **[]String** | Label to be applied to an Object | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,29 +16,29 @@ tags: ['SDK', 'Software Development Kit', 'Campaign', 'Campaign']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | Pointer to **String** | Id of the campaign | [optional] [readonly]
|
||||
**Name** | **String** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required]
|
||||
**Description** | **String** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required]
|
||||
**Deadline** | Pointer to **System.DateTime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional]
|
||||
**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION", "MACHINE_ACCOUNT" ] | The type of campaign. Could be extended in the future. | [required]
|
||||
**EmailNotificationEnabled** | Pointer to **Boolean** | Enables email notification for this campaign | [optional] [default to $false]
|
||||
**AutoRevokeAllowed** | Pointer to **Boolean** | Allows auto revoke for this campaign | [optional] [default to $false]
|
||||
**RecommendationsEnabled** | Pointer to **Boolean** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to $false]
|
||||
**Status** | Pointer to **Enum** [ "PENDING", "STAGED", "CANCELING", "ACTIVATING", "ACTIVE", "COMPLETING", "COMPLETED", "ERROR", "ARCHIVED" ] | The campaign's current status. | [optional] [readonly]
|
||||
**CorrelatedStatus** | Pointer to **Enum** [ "CORRELATED", "UNCORRELATED" ] | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional]
|
||||
**Created** | Pointer to **System.DateTime** | Created time of the campaign | [optional] [readonly]
|
||||
**TotalCertifications** | Pointer to **Int32** | The total number of certifications in this campaign. | [optional] [readonly]
|
||||
**CompletedCertifications** | Pointer to **Int32** | The number of completed certifications in this campaign. | [optional] [readonly]
|
||||
**Alerts** | Pointer to [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly]
|
||||
**Modified** | Pointer to **System.DateTime** | Modified time of the campaign | [optional] [readonly]
|
||||
**VarFilter** | Pointer to [**CampaignAllOfFilter**](campaign-all-of-filter) | | [optional]
|
||||
**SunsetCommentsRequired** | Pointer to **Boolean** | Determines if comments on sunset date changes are required. | [optional] [default to $true]
|
||||
**SourceOwnerCampaignInfo** | Pointer to [**CampaignAllOfSourceOwnerCampaignInfo**](campaign-all-of-source-owner-campaign-info) | | [optional]
|
||||
**SearchCampaignInfo** | Pointer to [**CampaignAllOfSearchCampaignInfo**](campaign-all-of-search-campaign-info) | | [optional]
|
||||
**RoleCompositionCampaignInfo** | Pointer to [**CampaignAllOfRoleCompositionCampaignInfo**](campaign-all-of-role-composition-campaign-info) | | [optional]
|
||||
**MachineAccountCampaignInfo** | Pointer to [**CampaignAllOfMachineAccountCampaignInfo**](campaign-all-of-machine-account-campaign-info) | | [optional]
|
||||
**SourcesWithOrphanEntitlements** | Pointer to [**[]CampaignAllOfSourcesWithOrphanEntitlements**](campaign-all-of-sources-with-orphan-entitlements) | A list of sources in the campaign that contain \""orphan entitlements\"" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). | [optional] [readonly]
|
||||
**MandatoryCommentRequirement** | Pointer to **Enum** [ "ALL_DECISIONS", "REVOKE_ONLY_DECISIONS", "NO_DECISIONS" ] | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [optional]
|
||||
**Id** | **String** | Id of the campaign | [optional] [readonly]
|
||||
**Name** | **String** | The campaign name. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required]
|
||||
**Description** | **String** | The campaign description. If this object is part of a template, special formatting applies; see the `/campaign-templates/{id}/generate` endpoint documentation for details. | [required]
|
||||
**Deadline** | **System.DateTime** | The campaign's completion deadline. This date must be in the future in order to activate the campaign. If you try to activate a campaign with a deadline of today or in the past, you will receive a 400 error response. | [optional]
|
||||
**Type** | **Enum** [ "MANAGER", "SOURCE_OWNER", "SEARCH", "ROLE_COMPOSITION", "MACHINE_ACCOUNT" ] | The type of campaign. Could be extended in the future. | [required]
|
||||
**EmailNotificationEnabled** | **Boolean** | Enables email notification for this campaign | [optional] [default to $false]
|
||||
**AutoRevokeAllowed** | **Boolean** | Allows auto revoke for this campaign | [optional] [default to $false]
|
||||
**RecommendationsEnabled** | **Boolean** | Enables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future. | [optional] [default to $false]
|
||||
**Status** | **Enum** [ "PENDING", "STAGED", "CANCELING", "ACTIVATING", "ACTIVE", "COMPLETING", "COMPLETED", "ERROR", "ARCHIVED" ] | The campaign's current status. | [optional] [readonly]
|
||||
**CorrelatedStatus** | **Enum** [ "CORRELATED", "UNCORRELATED" ] | The correlatedStatus of the campaign. Only SOURCE_OWNER campaigns can be Uncorrelated. An Uncorrelated certification campaign only includes Uncorrelated identities (An identity is uncorrelated if it has no accounts on an authoritative source). | [optional]
|
||||
**Created** | **System.DateTime** | Created time of the campaign | [optional] [readonly]
|
||||
**TotalCertifications** | **Int32** | The total number of certifications in this campaign. | [optional] [readonly]
|
||||
**CompletedCertifications** | **Int32** | The number of completed certifications in this campaign. | [optional] [readonly]
|
||||
**Alerts** | [**[]CampaignAlert**](campaign-alert) | A list of errors and warnings that have accumulated. | [optional] [readonly]
|
||||
**Modified** | **System.DateTime** | Modified time of the campaign | [optional] [readonly]
|
||||
**VarFilter** | [**CampaignAllOfFilter**](campaign-all-of-filter) | | [optional]
|
||||
**SunsetCommentsRequired** | **Boolean** | Determines if comments on sunset date changes are required. | [optional] [default to $true]
|
||||
**SourceOwnerCampaignInfo** | [**CampaignAllOfSourceOwnerCampaignInfo**](campaign-all-of-source-owner-campaign-info) | | [optional]
|
||||
**SearchCampaignInfo** | [**CampaignAllOfSearchCampaignInfo**](campaign-all-of-search-campaign-info) | | [optional]
|
||||
**RoleCompositionCampaignInfo** | [**CampaignAllOfRoleCompositionCampaignInfo**](campaign-all-of-role-composition-campaign-info) | | [optional]
|
||||
**MachineAccountCampaignInfo** | [**CampaignAllOfMachineAccountCampaignInfo**](campaign-all-of-machine-account-campaign-info) | | [optional]
|
||||
**SourcesWithOrphanEntitlements** | [**[]CampaignAllOfSourcesWithOrphanEntitlements**](campaign-all-of-sources-with-orphan-entitlements) | A list of sources in the campaign that contain \""orphan entitlements\"" (entitlements without a corresponding Managed Attribute). An empty list indicates the campaign has no orphan entitlements. Null indicates there may be unknown orphan entitlements in the campaign (the campaign was created before this feature was implemented). | [optional] [readonly]
|
||||
**MandatoryCommentRequirement** | **Enum** [ "ALL_DECISIONS", "REVOKE_ONLY_DECISIONS", "NO_DECISIONS" ] | Determines whether comments are required for decisions during certification reviews. You can require comments for all decisions, revoke-only decisions, or no decisions. By default, comments are not required for decisions. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'CampaignAlert', 'CampaignAlert']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Level** | Pointer to **Enum** [ "ERROR", "WARN", "INFO" ] | Denotes the level of the message | [optional]
|
||||
**Localizations** | Pointer to [**[]ErrorMessageDto**](error-message-dto) | | [optional]
|
||||
**Level** | **Enum** [ "ERROR", "WARN", "INFO" ] | Denotes the level of the message | [optional]
|
||||
**Localizations** | [**[]ErrorMessageDto**](error-message-dto) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'CampaignAllOfFilter', 'CampaignAllOfF
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | Pointer to **String** | The ID of whatever type of filter is being used. | [optional]
|
||||
**Type** | Pointer to **Enum** [ "CAMPAIGN_FILTER", "RULE" ] | Type of the filter | [optional]
|
||||
**Name** | Pointer to **String** | Name of the filter | [optional]
|
||||
**Id** | **String** | The ID of whatever type of filter is being used. | [optional]
|
||||
**Type** | **Enum** [ "CAMPAIGN_FILTER", "RULE" ] | Type of the filter | [optional]
|
||||
**Name** | **String** | Name of the filter | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'CampaignAllOfMachineAccountCampaignIn
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**SourceIds** | Pointer to **[]String** | The list of sources to be included in the campaign. | [optional]
|
||||
**ReviewerType** | Pointer to **Enum** [ "ACCOUNT_OWNER" ] | The reviewer's type. | [optional]
|
||||
**SourceIds** | **[]String** | The list of sources to be included in the campaign. | [optional]
|
||||
**ReviewerType** | **Enum** [ "ACCOUNT_OWNER" ] | The reviewer's type. | [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