mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-07 12:27:47 +00:00
Update to powershell SDK docs: 13400083192
This commit is contained in:
@@ -19,8 +19,7 @@ Name | Type | Description | Notes
|
||||
**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]
|
||||
**Description** | **String** | Description of access item. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
@@ -29,7 +28,6 @@ Name | Type | Description | Notes
|
||||
$Access = Initialize-PSSailpoint.V2024Access -Id 2c91808568c529c60168cca6f90c1313 `
|
||||
-Name John Doe `
|
||||
-DisplayName John Q. Doe `
|
||||
-Type null `
|
||||
-Description null
|
||||
```
|
||||
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
---
|
||||
id: v2024-access-apps
|
||||
title: AccessApps
|
||||
pagination_label: AccessApps
|
||||
sidebar_label: AccessApps
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessApps', 'V2024AccessApps']
|
||||
slug: /tools/sdk/powershell/v2024/models/access-apps
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessApps', 'V2024AccessApps']
|
||||
---
|
||||
|
||||
|
||||
# AccessApps
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | The unique ID of the referenced object. | [optional]
|
||||
**Name** | **String** | Name of application | [optional]
|
||||
**Description** | **String** | Description of application. | [optional]
|
||||
**Owner** | [**AccessAppsOwner**](access-apps-owner) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AccessApps = Initialize-PSSailpoint.V2024AccessApps -Id 2c91808568c529c60168cca6f90c1313 `
|
||||
-Name Travel and Expense `
|
||||
-Description Travel and Expense Application `
|
||||
-Owner null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$AccessApps | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
---
|
||||
id: v2024-access-apps-owner
|
||||
title: AccessAppsOwner
|
||||
pagination_label: AccessAppsOwner
|
||||
sidebar_label: AccessAppsOwner
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessAppsOwner', 'V2024AccessAppsOwner']
|
||||
slug: /tools/sdk/powershell/v2024/models/access-apps-owner
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessAppsOwner', 'V2024AccessAppsOwner']
|
||||
---
|
||||
|
||||
|
||||
# AccessAppsOwner
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**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
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AccessAppsOwner = Initialize-PSSailpoint.V2024AccessAppsOwner -Type IDENTITY `
|
||||
-Id 2c9180a46faadee4016fb4e018c20639 `
|
||||
-Name John Doe `
|
||||
-Email john.doe@sailpoint.com
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$AccessAppsOwner | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -16,8 +16,6 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileDocument', 'V2024AccessP
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**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]
|
||||
@@ -25,20 +23,22 @@ Name | Type | Description | Notes
|
||||
**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]
|
||||
**Owner** | [**BaseAccessOwner**](base-access-owner) | | [optional]
|
||||
**Id** | **String** | Access profile's ID. | [required]
|
||||
**Name** | **String** | Access profile's name. | [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]
|
||||
**Segments** | [**[]BaseSegment**](base-segment) | Segments with the access profile. | [optional]
|
||||
**SegmentCount** | **Int32** | Number of segments with the access profile. | [optional]
|
||||
**Tags** | **[]String** | Tags that have been applied to the object. | [optional]
|
||||
**Apps** | [**[]AccessApps**](access-apps) | Applications with the access profile | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AccessProfileDocument = Initialize-PSSailpoint.V2024AccessProfileDocument -Id 2c9180825a6c1adc015a71c9023f0818 `
|
||||
-Name Cloud Eng `
|
||||
-Description The admin role `
|
||||
$AccessProfileDocument = Initialize-PSSailpoint.V2024AccessProfileDocument -Description Admin access `
|
||||
-Created 2018-06-25T20:22:28.104Z `
|
||||
-Modified 2018-06-25T20:22:28.104Z `
|
||||
-Synced 2018-06-25T20:22:33.104Z `
|
||||
@@ -46,11 +46,15 @@ $AccessProfileDocument = Initialize-PSSailpoint.V2024AccessProfileDocument -Id
|
||||
-Requestable true `
|
||||
-RequestCommentsRequired false `
|
||||
-Owner null `
|
||||
-Type accessprofile `
|
||||
-Id 2c9180825a6c1adc015a71c9023f0818 `
|
||||
-Name Cloud Eng `
|
||||
-Source null `
|
||||
-Entitlements null `
|
||||
-EntitlementCount 5 `
|
||||
-Tags [TAG_1, TAG_2]
|
||||
-Segments null `
|
||||
-SegmentCount 1 `
|
||||
-Tags [TAG_1, TAG_2] `
|
||||
-Apps null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
|
||||
@@ -19,9 +19,9 @@ Name | Type | Description | Notes
|
||||
**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]
|
||||
**Description** | **String** | Description of access item. | [optional]
|
||||
**Source** | [**Reference1**](reference1) | | [optional]
|
||||
**Type** | **String** | Type of the access item. | [optional]
|
||||
**Privileged** | **Boolean** | | [optional]
|
||||
**Attribute** | **String** | | [optional]
|
||||
**Value** | **String** | | [optional]
|
||||
@@ -34,9 +34,9 @@ Name | Type | Description | Notes
|
||||
$AccessProfileEntitlement = Initialize-PSSailpoint.V2024AccessProfileEntitlement -Id 2c91808568c529c60168cca6f90c1313 `
|
||||
-Name John Doe `
|
||||
-DisplayName John Q. Doe `
|
||||
-Type null `
|
||||
-Description null `
|
||||
-Source null `
|
||||
-Type ENTITLEMENT `
|
||||
-Privileged false `
|
||||
-Attribute memberOf `
|
||||
-Value CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com `
|
||||
|
||||
@@ -19,8 +19,8 @@ Name | Type | Description | Notes
|
||||
**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]
|
||||
**Description** | **String** | Description of access item. | [optional]
|
||||
**Type** | **String** | Type of the access item. | [optional]
|
||||
**Owner** | [**DisplayReference**](display-reference) | | [optional]
|
||||
**Disabled** | **Boolean** | | [optional]
|
||||
**Revocable** | **Boolean** | | [optional]
|
||||
@@ -32,8 +32,8 @@ Name | Type | Description | Notes
|
||||
$AccessProfileRole = Initialize-PSSailpoint.V2024AccessProfileRole -Id 2c91808568c529c60168cca6f90c1313 `
|
||||
-Name John Doe `
|
||||
-DisplayName John Q. Doe `
|
||||
-Type null `
|
||||
-Description null `
|
||||
-Type ROLE `
|
||||
-Owner null `
|
||||
-Disabled null `
|
||||
-Revocable null
|
||||
|
||||
@@ -19,8 +19,8 @@ Name | Type | Description | Notes
|
||||
**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]
|
||||
**Description** | **String** | Description of access item. | [optional]
|
||||
**Type** | **String** | Type of the access item. | [optional]
|
||||
**Source** | [**Reference1**](reference1) | | [optional]
|
||||
**Owner** | [**DisplayReference**](display-reference) | | [optional]
|
||||
**Revocable** | **Boolean** | | [optional]
|
||||
@@ -32,8 +32,8 @@ Name | Type | Description | Notes
|
||||
$AccessProfileSummary = Initialize-PSSailpoint.V2024AccessProfileSummary -Id 2c91808568c529c60168cca6f90c1313 `
|
||||
-Name John Doe `
|
||||
-DisplayName John Q. Doe `
|
||||
-Type null `
|
||||
-Description null `
|
||||
-Type ACCESS_PROFILE `
|
||||
-Source null `
|
||||
-Owner null `
|
||||
-Revocable true
|
||||
|
||||
@@ -16,17 +16,15 @@ tags: ['SDK', 'Software Development Kit', 'AccountActivityDocument', 'V2024Accou
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | | [required]
|
||||
**Name** | **String** | | [required]
|
||||
**Type** | [**DocumentType**](document-type) | | [required]
|
||||
**Id** | **String** | ID of account activity. | [optional]
|
||||
**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]
|
||||
**Synced** | **String** | 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]
|
||||
**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]
|
||||
**Requester** | [**ActivityIdentity**](activity-identity) | | [optional]
|
||||
**Recipient** | [**ActivityIdentity**](activity-identity) | | [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]
|
||||
@@ -41,13 +39,11 @@ Name | Type | Description | Notes
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AccountActivityDocument = Initialize-PSSailpoint.V2024AccountActivityDocument -Id 2c91808375d8e80a0175e1f88a575222 `
|
||||
-Name john.doe `
|
||||
-Type null `
|
||||
-Action Identity Refresh. `
|
||||
-Created 2018-06-25T20:22:28.104Z `
|
||||
-Modified 2018-06-25T20:22:28.104Z `
|
||||
-Synced 2018-06-25T20:22:28.104Z `
|
||||
-Stage Completed `
|
||||
-Origin null `
|
||||
-Status Complete `
|
||||
-Requester null `
|
||||
-Recipient null `
|
||||
|
||||
@@ -16,17 +16,15 @@ tags: ['SDK', 'Software Development Kit', 'AccountActivitySearchedItem', 'V2024A
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | | [required]
|
||||
**Name** | **String** | | [required]
|
||||
**Type** | [**DocumentType**](document-type) | | [required]
|
||||
**Id** | **String** | ID of account activity. | [optional]
|
||||
**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]
|
||||
**Synced** | **String** | 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]
|
||||
**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]
|
||||
**Requester** | [**ActivityIdentity**](activity-identity) | | [optional]
|
||||
**Recipient** | [**ActivityIdentity**](activity-identity) | | [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]
|
||||
@@ -41,13 +39,11 @@ Name | Type | Description | Notes
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AccountActivitySearchedItem = Initialize-PSSailpoint.V2024AccountActivitySearchedItem -Id 2c91808375d8e80a0175e1f88a575222 `
|
||||
-Name john.doe `
|
||||
-Type null `
|
||||
-Action Identity Refresh. `
|
||||
-Created 2018-06-25T20:22:28.104Z `
|
||||
-Modified 2018-06-25T20:22:28.104Z `
|
||||
-Synced 2018-06-25T20:22:28.104Z `
|
||||
-Stage Completed `
|
||||
-Origin null `
|
||||
-Status Complete `
|
||||
-Requester null `
|
||||
-Recipient null `
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccountRequestResult', 'V2024AccountR
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Errors** | **[]String** | | [optional]
|
||||
**Errors** | **[]String** | Error message. | [optional]
|
||||
**Status** | **String** | The status of the account request | [optional]
|
||||
**TicketId** | **String** | | [optional]
|
||||
**TicketId** | **String** | ID of associated ticket. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: v2024-activity-identity
|
||||
title: ActivityIdentity
|
||||
pagination_label: ActivityIdentity
|
||||
sidebar_label: ActivityIdentity
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ActivityIdentity', 'V2024ActivityIdentity']
|
||||
slug: /tools/sdk/powershell/v2024/models/activity-identity
|
||||
tags: ['SDK', 'Software Development Kit', 'ActivityIdentity', 'V2024ActivityIdentity']
|
||||
---
|
||||
|
||||
|
||||
# ActivityIdentity
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**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 object | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ActivityIdentity = Initialize-PSSailpoint.V2024ActivityIdentity -Id 2c91808568c529c60168cca6f90c1313 `
|
||||
-Name John Doe `
|
||||
-Type Identity
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ActivityIdentity | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -17,22 +17,22 @@ tags: ['SDK', 'Software Development Kit', 'Approval1', 'V2024Approval1']
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Comments** | [**[]ApprovalComment2**](approval-comment2) | | [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]
|
||||
**Owner** | [**ActivityIdentity**](activity-identity) | | [optional]
|
||||
**Result** | **String** | The result of the approval | [optional]
|
||||
**Type** | **String** | | [optional]
|
||||
**AttributeRequest** | [**AttributeRequest**](attribute-request) | | [optional]
|
||||
**Source** | [**AccountSource**](account-source) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$Approval1 = Initialize-PSSailpoint.V2024Approval1 -Comments null `
|
||||
-Created 2018-06-25T20:22:28.104Z `
|
||||
-Modified 2018-06-25T20:22:28.104Z `
|
||||
-Owner null `
|
||||
-Result Finished `
|
||||
-Type null
|
||||
-AttributeRequest null `
|
||||
-Source null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
|
||||
@@ -18,7 +18,7 @@ Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Name** | **String** | Attribute name. | [optional]
|
||||
**Op** | **String** | Operation to perform on attribute. | [optional]
|
||||
**Value** | **String** | Value of attribute. | [optional]
|
||||
**Value** | [**AttributeRequestValue**](attribute-request-value) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
@@ -26,7 +26,7 @@ Name | Type | Description | Notes
|
||||
```powershell
|
||||
$AttributeRequest = Initialize-PSSailpoint.V2024AttributeRequest -Name groups `
|
||||
-Op Add `
|
||||
-Value 3203537556531076
|
||||
-Value null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
|
||||
@@ -0,0 +1,34 @@
|
||||
---
|
||||
id: v2024-attribute-request-value
|
||||
title: AttributeRequestValue
|
||||
pagination_label: AttributeRequestValue
|
||||
sidebar_label: AttributeRequestValue
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeRequestValue', 'V2024AttributeRequestValue']
|
||||
slug: /tools/sdk/powershell/v2024/models/attribute-request-value
|
||||
tags: ['SDK', 'Software Development Kit', 'AttributeRequestValue', 'V2024AttributeRequestValue']
|
||||
---
|
||||
|
||||
|
||||
# AttributeRequestValue
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AttributeRequestValue = Initialize-PSSailpoint.V2024AttributeRequestValue
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$AttributeRequestValue | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -16,8 +16,6 @@ tags: ['SDK', 'Software Development Kit', 'BaseAccess', 'V2024BaseAccess']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**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]
|
||||
@@ -25,15 +23,13 @@ Name | Type | Description | Notes
|
||||
**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]
|
||||
**Owner** | [**BaseAccessOwner**](base-access-owner) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$BaseAccess = Initialize-PSSailpoint.V2024BaseAccess -Id 2c91808568c529c60168cca6f90c1313 `
|
||||
-Name John Doe `
|
||||
-Description The admin role `
|
||||
$BaseAccess = Initialize-PSSailpoint.V2024BaseAccess -Description Admin access `
|
||||
-Created 2018-06-25T20:22:28.104Z `
|
||||
-Modified 2018-06-25T20:22:28.104Z `
|
||||
-Synced 2018-06-25T20:22:33.104Z `
|
||||
|
||||
@@ -1,16 +1,16 @@
|
||||
---
|
||||
id: base-access-all-of-owner
|
||||
title: BaseAccessAllOfOwner
|
||||
pagination_label: BaseAccessAllOfOwner
|
||||
sidebar_label: BaseAccessAllOfOwner
|
||||
id: v2024-base-access-owner
|
||||
title: BaseAccessOwner
|
||||
pagination_label: BaseAccessOwner
|
||||
sidebar_label: BaseAccessOwner
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'BaseAccessAllOfOwner', 'BaseAccessAllOfOwner']
|
||||
slug: /tools/sdk/powershell/v3/models/base-access-all-of-owner
|
||||
tags: ['SDK', 'Software Development Kit', 'BaseAccessAllOfOwner', 'BaseAccessAllOfOwner']
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'BaseAccessOwner', 'V2024BaseAccessOwner']
|
||||
slug: /tools/sdk/powershell/v2024/models/base-access-owner
|
||||
tags: ['SDK', 'Software Development Kit', 'BaseAccessOwner', 'V2024BaseAccessOwner']
|
||||
---
|
||||
|
||||
|
||||
# BaseAccessAllOfOwner
|
||||
# BaseAccessOwner
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -25,7 +25,7 @@ Name | Type | Description | Notes
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$BaseAccessAllOfOwner = Initialize-PSSailpoint.V3BaseAccessAllOfOwner -Type IDENTITY `
|
||||
$BaseAccessOwner = Initialize-PSSailpoint.V2024BaseAccessOwner -Type IDENTITY `
|
||||
-Id 2c9180a46faadee4016fb4e018c20639 `
|
||||
-Name Support `
|
||||
-Email cloud-support@sailpoint.com
|
||||
@@ -33,7 +33,7 @@ $BaseAccessAllOfOwner = Initialize-PSSailpoint.V3BaseAccessAllOfOwner -Type IDE
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$BaseAccessAllOfOwner | ConvertTo-JSON
|
||||
$BaseAccessOwner | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
@@ -27,6 +27,8 @@ Name | Type | Description | Notes
|
||||
**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]
|
||||
**SupportsPasswordChange** | **Boolean** | Indicates whether the account supports password change. | [optional] [default to $false]
|
||||
**AccountAttributes** | [**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]
|
||||
|
||||
## Examples
|
||||
|
||||
@@ -42,7 +44,9 @@ $BaseAccount = Initialize-PSSailpoint.V2024BaseAccount -Id 2c91808568c529c60168
|
||||
-ManuallyCorrelated false `
|
||||
-PasswordLastSet 2018-06-25T20:22:28.104Z `
|
||||
-EntitlementAttributes {moderator=true, admin=true, trust_level=4} `
|
||||
-Created 2018-06-25T20:22:28.104Z
|
||||
-Created 2018-06-25T20:22:28.104Z `
|
||||
-SupportsPasswordChange false `
|
||||
-AccountAttributes {type=global, admin=true, trust_level=4}
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
|
||||
@@ -16,17 +16,15 @@ tags: ['SDK', 'Software Development Kit', 'BaseDocument', 'V2024BaseDocument']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | | [required]
|
||||
**Name** | **String** | | [required]
|
||||
**Type** | [**DocumentType**](document-type) | | [required]
|
||||
**Id** | **String** | ID of the referenced object. | [required]
|
||||
**Name** | **String** | The human readable name of the referenced object. | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$BaseDocument = Initialize-PSSailpoint.V2024BaseDocument -Id 2c91808375d8e80a0175e1f88a575222 `
|
||||
-Name john.doe `
|
||||
-Type null
|
||||
-Name john.doe
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
|
||||
@@ -1,36 +0,0 @@
|
||||
---
|
||||
id: v2024-document-type
|
||||
title: DocumentType
|
||||
pagination_label: DocumentType
|
||||
sidebar_label: DocumentType
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'DocumentType', 'V2024DocumentType']
|
||||
slug: /tools/sdk/powershell/v2024/models/document-type
|
||||
tags: ['SDK', 'Software Development Kit', 'DocumentType', 'V2024DocumentType']
|
||||
---
|
||||
|
||||
|
||||
# DocumentType
|
||||
|
||||
## Enum
|
||||
|
||||
|
||||
* `accessprofile` (value: `"accessprofile"`)
|
||||
|
||||
* `accountactivity` (value: `"accountactivity"`)
|
||||
|
||||
* `account` (value: `"account"`)
|
||||
|
||||
* `aggregation` (value: `"aggregation"`)
|
||||
|
||||
* `entitlement` (value: `"entitlement"`)
|
||||
|
||||
* `event` (value: `"event"`)
|
||||
|
||||
* `identity` (value: `"identity"`)
|
||||
|
||||
* `role` (value: `"role"`)
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -16,21 +16,29 @@ tags: ['SDK', 'Software Development Kit', 'EntitlementDocument', 'V2024Entitleme
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | | [required]
|
||||
**Name** | **String** | | [required]
|
||||
**Type** | [**DocumentType**](document-type) | | [required]
|
||||
**Id** | **String** | ID of the referenced object. | [required]
|
||||
**Name** | **String** | The human readable name of the referenced object. | [required]
|
||||
**Modified** | **System.DateTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional]
|
||||
**Synced** | **String** | 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]
|
||||
**DisplayName** | **String** | Entitlement's display name. | [optional]
|
||||
**Source** | [**EntitlementDocumentAllOfSource**](entitlement-document-all-of-source) | | [optional]
|
||||
**Segments** | [**[]BaseSegment**](base-segment) | Segments with the role. | [optional]
|
||||
**Segments** | [**[]BaseSegment**](base-segment) | Segments with the entitlement. | [optional]
|
||||
**SegmentCount** | **Int32** | Number of segments with the role. | [optional]
|
||||
**Requestable** | **Boolean** | Indicates whether the entitlement is requestable. | [optional] [default to $false]
|
||||
**CloudGoverned** | **Boolean** | Indicates whether the entitlement is cloud governed. | [optional] [default to $false]
|
||||
**Created** | **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
|
||||
**Privileged** | **Boolean** | Indicates whether the entitlement is privileged. | [optional] [default to $false]
|
||||
**IdentityCount** | **Int32** | Number of identities who have access to the entitlement. | [optional]
|
||||
**Tags** | **[]String** | Tags that have been applied to the object. | [optional]
|
||||
**Attribute** | **String** | Attribute information for the entitlement. | [optional]
|
||||
**Value** | **String** | Value of the entitlement. | [optional]
|
||||
**SourceSchemaObjectType** | **String** | Source schema object type of the entitlement. | [optional]
|
||||
**Schema** | **String** | Schema type of the entitlement. | [optional]
|
||||
**Hash** | **String** | Read-only calculated hash value of an entitlement. | [optional]
|
||||
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Attributes of the entitlement. | [optional]
|
||||
**TruncatedAttributes** | **[]String** | Truncated attributes of the entitlement. | [optional]
|
||||
**ContainsDataAccess** | **Boolean** | Indicates whether the entitlement contains data access. | [optional] [default to $false]
|
||||
**ManuallyUpdatedFields** | [**EntitlementDocumentAllOfManuallyUpdatedFields**](entitlement-document-all-of-manually-updated-fields) | | [optional]
|
||||
**Permissions** | [**[]EntitlementDocumentAllOfPermissions**](entitlement-document-all-of-permissions) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
@@ -38,7 +46,6 @@ Name | Type | Description | Notes
|
||||
```powershell
|
||||
$EntitlementDocument = Initialize-PSSailpoint.V2024EntitlementDocument -Id 2c91808375d8e80a0175e1f88a575222 `
|
||||
-Name john.doe `
|
||||
-Type null `
|
||||
-Modified 2018-06-25T20:22:28.104Z `
|
||||
-Synced null `
|
||||
-DisplayName Admin `
|
||||
@@ -49,8 +56,17 @@ $EntitlementDocument = Initialize-PSSailpoint.V2024EntitlementDocument -Id 2c91
|
||||
-CloudGoverned false `
|
||||
-Created 2018-06-25T20:22:28.104Z `
|
||||
-Privileged false `
|
||||
-IdentityCount 3 `
|
||||
-Tags [TAG_1, TAG_2]
|
||||
-Tags [TAG_1, TAG_2] `
|
||||
-Attribute groups `
|
||||
-Value 1733ff75-441e-4327-9bfc-3ac445fd8cd1 `
|
||||
-SourceSchemaObjectType group `
|
||||
-Schema group `
|
||||
-Hash c6fab95235584cca98a454a2f51e5683bc77d6a0 `
|
||||
-Attributes null `
|
||||
-TruncatedAttributes null `
|
||||
-ContainsDataAccess null `
|
||||
-ManuallyUpdatedFields null `
|
||||
-Permissions null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: v2024-entitlement-document-all-of-manually-updated-fields
|
||||
title: EntitlementDocumentAllOfManuallyUpdatedFields
|
||||
pagination_label: EntitlementDocumentAllOfManuallyUpdatedFields
|
||||
sidebar_label: EntitlementDocumentAllOfManuallyUpdatedFields
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementDocumentAllOfManuallyUpdatedFields', 'V2024EntitlementDocumentAllOfManuallyUpdatedFields']
|
||||
slug: /tools/sdk/powershell/v2024/models/entitlement-document-all-of-manually-updated-fields
|
||||
tags: ['SDK', 'Software Development Kit', 'EntitlementDocumentAllOfManuallyUpdatedFields', 'V2024EntitlementDocumentAllOfManuallyUpdatedFields']
|
||||
---
|
||||
|
||||
|
||||
# EntitlementDocumentAllOfManuallyUpdatedFields
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**DESCRIPTION** | **Boolean** | | [optional] [default to $false]
|
||||
**DISPLAYNAME** | **Boolean** | | [optional] [default to $false]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$EntitlementDocumentAllOfManuallyUpdatedFields = Initialize-PSSailpoint.V2024EntitlementDocumentAllOfManuallyUpdatedFields -DESCRIPTION false `
|
||||
-DISPLAYNAME false
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$EntitlementDocumentAllOfManuallyUpdatedFields | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: v2024-entitlement-document-all-of-permissions
|
||||
title: EntitlementDocumentAllOfPermissions
|
||||
pagination_label: EntitlementDocumentAllOfPermissions
|
||||
sidebar_label: EntitlementDocumentAllOfPermissions
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementDocumentAllOfPermissions', 'V2024EntitlementDocumentAllOfPermissions']
|
||||
slug: /tools/sdk/powershell/v2024/models/entitlement-document-all-of-permissions
|
||||
tags: ['SDK', 'Software Development Kit', 'EntitlementDocumentAllOfPermissions', 'V2024EntitlementDocumentAllOfPermissions']
|
||||
---
|
||||
|
||||
|
||||
# EntitlementDocumentAllOfPermissions
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Target** | **String** | The target the permission would grants rights on. | [optional]
|
||||
**Rights** | **[]String** | All the rights (e.g. actions) that this permission allows on the target | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$EntitlementDocumentAllOfPermissions = Initialize-PSSailpoint.V2024EntitlementDocumentAllOfPermissions -Target SYS.GV_$TRANSACTION `
|
||||
-Rights null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$EntitlementDocumentAllOfPermissions | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -18,13 +18,15 @@ Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | ID of entitlement's source. | [optional]
|
||||
**Name** | **String** | Display name of entitlement's source. | [optional]
|
||||
**Type** | **String** | Type of object. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$EntitlementDocumentAllOfSource = Initialize-PSSailpoint.V2024EntitlementDocumentAllOfSource -Id 2c91808b6e9e6fb8016eec1a2b6f7b5f `
|
||||
-Name ODS-HR-Employees
|
||||
-Name ODS-HR-Employees `
|
||||
-Type SOURCE
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
|
||||
@@ -19,9 +19,9 @@ Name | Type | Description | Notes
|
||||
**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]
|
||||
**Description** | **String** | Description of access item. | [optional]
|
||||
**Source** | [**Reference1**](reference1) | | [optional]
|
||||
**Type** | **String** | Type of the access item. | [optional]
|
||||
**Privileged** | **Boolean** | | [optional]
|
||||
**Attribute** | **String** | | [optional]
|
||||
**Value** | **String** | | [optional]
|
||||
@@ -34,9 +34,9 @@ Name | Type | Description | Notes
|
||||
$EntitlementSummary = Initialize-PSSailpoint.V2024EntitlementSummary -Id 2c91808568c529c60168cca6f90c1313 `
|
||||
-Name John Doe `
|
||||
-DisplayName John Q. Doe `
|
||||
-Type null `
|
||||
-Description null `
|
||||
-Source null `
|
||||
-Type ENTITLEMENT `
|
||||
-Privileged false `
|
||||
-Attribute memberOf `
|
||||
-Value CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com `
|
||||
|
||||
@@ -16,15 +16,14 @@ tags: ['SDK', 'Software Development Kit', 'ModelEvent', 'V2024ModelEvent']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | | [required]
|
||||
**Name** | **String** | | [required]
|
||||
**Type** | [**DocumentType**](document-type) | | [required]
|
||||
**Id** | **String** | ID of the entitlement. | [optional]
|
||||
**Name** | **String** | Name of the entitlement. | [optional]
|
||||
**Created** | **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
|
||||
**Synced** | **String** | 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]
|
||||
**Action** | **String** | Name of the event as it's displayed in audit reports. | [optional]
|
||||
**Type** | **String** | Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. | [optional]
|
||||
**Actor** | **String** | Name of the actor that generated the event. | [optional]
|
||||
**Target** | **String** | Name of the target, or recipient, of the event. | [optional]
|
||||
**Actor** | [**EventActor**](event-actor) | | [optional]
|
||||
**Target** | [**EventTarget**](event-target) | | [optional]
|
||||
**Stack** | **String** | The event's stack. | [optional]
|
||||
**TrackingNumber** | **String** | ID of the group of events. | [optional]
|
||||
**IpAddress** | **String** | Target system's IP address. | [optional]
|
||||
@@ -40,23 +39,22 @@ Name | Type | Description | Notes
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ModelEvent = Initialize-PSSailpoint.V2024ModelEvent -Id 2c91808375d8e80a0175e1f88a575222 `
|
||||
-Name john.doe `
|
||||
-Type null `
|
||||
-Name Add Entitlement Passed `
|
||||
-Created 2018-06-25T20:22:28.104Z `
|
||||
-Synced null `
|
||||
-Action update `
|
||||
-Type SYSTEM_CONFIG `
|
||||
-Actor System `
|
||||
-Target Carol.Adams `
|
||||
-Synced 2018-06-25T20:22:28.104Z `
|
||||
-Action AddEntitlement `
|
||||
-Type ACCESS_ITEM `
|
||||
-Actor null `
|
||||
-Target null `
|
||||
-Stack tpe `
|
||||
-TrackingNumber 63f891e0735f4cc8bf1968144a1e7440 `
|
||||
-IpAddress 52.52.97.85 `
|
||||
-Details 73b65dfbed1842548c207432a18c84b0 `
|
||||
-Attributes {pod=stg03-useast1, org=acme, sourceName=SailPoint} `
|
||||
-Objects null `
|
||||
-Operation REQUEST `
|
||||
-Operation ADD `
|
||||
-Status PASSED `
|
||||
-TechnicalName AUTHENTICATION_REQUEST_PASSED
|
||||
-TechnicalName ENTITLEMENT_ADD_PASSED
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
|
||||
@@ -0,0 +1,35 @@
|
||||
---
|
||||
id: v2024-event-actor
|
||||
title: EventActor
|
||||
pagination_label: EventActor
|
||||
sidebar_label: EventActor
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'EventActor', 'V2024EventActor']
|
||||
slug: /tools/sdk/powershell/v2024/models/event-actor
|
||||
tags: ['SDK', 'Software Development Kit', 'EventActor', 'V2024EventActor']
|
||||
---
|
||||
|
||||
|
||||
# EventActor
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Name** | **String** | Name of the actor that generated the event. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$EventActor = Initialize-PSSailpoint.V2024EventActor -Name System
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$EventActor | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -16,15 +16,14 @@ tags: ['SDK', 'Software Development Kit', 'EventDocument', 'V2024EventDocument']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | | [required]
|
||||
**Name** | **String** | | [required]
|
||||
**Type** | [**DocumentType**](document-type) | | [required]
|
||||
**Id** | **String** | ID of the entitlement. | [optional]
|
||||
**Name** | **String** | Name of the entitlement. | [optional]
|
||||
**Created** | **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
|
||||
**Synced** | **String** | 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]
|
||||
**Action** | **String** | Name of the event as it's displayed in audit reports. | [optional]
|
||||
**Type** | **String** | Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. | [optional]
|
||||
**Actor** | **String** | Name of the actor that generated the event. | [optional]
|
||||
**Target** | **String** | Name of the target, or recipient, of the event. | [optional]
|
||||
**Actor** | [**EventActor**](event-actor) | | [optional]
|
||||
**Target** | [**EventTarget**](event-target) | | [optional]
|
||||
**Stack** | **String** | The event's stack. | [optional]
|
||||
**TrackingNumber** | **String** | ID of the group of events. | [optional]
|
||||
**IpAddress** | **String** | Target system's IP address. | [optional]
|
||||
@@ -40,23 +39,22 @@ Name | Type | Description | Notes
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$EventDocument = Initialize-PSSailpoint.V2024EventDocument -Id 2c91808375d8e80a0175e1f88a575222 `
|
||||
-Name john.doe `
|
||||
-Type null `
|
||||
-Name Add Entitlement Passed `
|
||||
-Created 2018-06-25T20:22:28.104Z `
|
||||
-Synced null `
|
||||
-Action update `
|
||||
-Type SYSTEM_CONFIG `
|
||||
-Actor System `
|
||||
-Target Carol.Adams `
|
||||
-Synced 2018-06-25T20:22:28.104Z `
|
||||
-Action AddEntitlement `
|
||||
-Type ACCESS_ITEM `
|
||||
-Actor null `
|
||||
-Target null `
|
||||
-Stack tpe `
|
||||
-TrackingNumber 63f891e0735f4cc8bf1968144a1e7440 `
|
||||
-IpAddress 52.52.97.85 `
|
||||
-Details 73b65dfbed1842548c207432a18c84b0 `
|
||||
-Attributes {pod=stg03-useast1, org=acme, sourceName=SailPoint} `
|
||||
-Objects null `
|
||||
-Operation REQUEST `
|
||||
-Operation ADD `
|
||||
-Status PASSED `
|
||||
-TechnicalName AUTHENTICATION_REQUEST_PASSED
|
||||
-TechnicalName ENTITLEMENT_ADD_PASSED
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
|
||||
@@ -0,0 +1,35 @@
|
||||
---
|
||||
id: v2024-event-target
|
||||
title: EventTarget
|
||||
pagination_label: EventTarget
|
||||
sidebar_label: EventTarget
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'EventTarget', 'V2024EventTarget']
|
||||
slug: /tools/sdk/powershell/v2024/models/event-target
|
||||
tags: ['SDK', 'Software Development Kit', 'EventTarget', 'V2024EventTarget']
|
||||
---
|
||||
|
||||
|
||||
# EventTarget
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Name** | **String** | Name of the target, or recipient, of the event. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$EventTarget = Initialize-PSSailpoint.V2024EventTarget -Name Carol.Adams
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$EventTarget | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -17,10 +17,12 @@ tags: ['SDK', 'Software Development Kit', 'ExpansionItem', 'V2024ExpansionItem']
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**AccountId** | **String** | The ID of the account | [optional]
|
||||
**Cause** | **String** | | [optional]
|
||||
**Cause** | **String** | Cause of the expansion item. | [optional]
|
||||
**Name** | **String** | The name of the item | [optional]
|
||||
**AttributeRequests** | [**[]AttributeRequest**](attribute-request) | | [optional]
|
||||
**AttributeRequest** | [**AttributeRequest**](attribute-request) | | [optional]
|
||||
**Source** | [**AccountSource**](account-source) | | [optional]
|
||||
**Id** | **String** | ID of the expansion item | [optional]
|
||||
**State** | **String** | State of the expansion item | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
@@ -29,8 +31,10 @@ Name | Type | Description | Notes
|
||||
$ExpansionItem = Initialize-PSSailpoint.V2024ExpansionItem -AccountId 2c91808981f58ea601821c3e93482e6f `
|
||||
-Cause Role `
|
||||
-Name smartsheet-role `
|
||||
-AttributeRequests null `
|
||||
-Source null
|
||||
-AttributeRequest null `
|
||||
-Source null `
|
||||
-Id ac2887ffe0e7435a8c18c73f7ae94c7b `
|
||||
-State EXECUTING
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
|
||||
@@ -19,8 +19,8 @@ Name | Type | Description | Notes
|
||||
**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]
|
||||
**Description** | **String** | Description of access item. | [optional]
|
||||
**Type** | **String** | Type of the access item. | [optional]
|
||||
**Source** | [**Reference1**](reference1) | | [optional]
|
||||
**Owner** | [**DisplayReference**](display-reference) | | [optional]
|
||||
**Revocable** | **Boolean** | | [optional]
|
||||
@@ -37,8 +37,8 @@ Name | Type | Description | Notes
|
||||
$IdentityAccess = Initialize-PSSailpoint.V2024IdentityAccess -Id 2c91808568c529c60168cca6f90c1313 `
|
||||
-Name John Doe `
|
||||
-DisplayName John Q. Doe `
|
||||
-Type null `
|
||||
-Description null `
|
||||
-Type ROLE `
|
||||
-Source null `
|
||||
-Owner null `
|
||||
-Revocable null `
|
||||
|
||||
@@ -18,7 +18,6 @@ Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | The unique ID of the referenced object. | [required]
|
||||
**Name** | **String** | The human readable name of the referenced object. | [required]
|
||||
**Type** | [**DocumentType**](document-type) | | [required]
|
||||
**DisplayName** | **String** | Identity's display name. | [optional]
|
||||
**FirstName** | **String** | Identity's first name. | [optional]
|
||||
**LastName** | **String** | Identity's last name. | [optional]
|
||||
@@ -36,6 +35,8 @@ Name | Type | Description | Notes
|
||||
**IdentityProfile** | [**IdentityDocumentAllOfIdentityProfile**](identity-document-all-of-identity-profile) | | [optional]
|
||||
**Source** | [**IdentityDocumentAllOfSource**](identity-document-all-of-source) | | [optional]
|
||||
**Attributes** | [**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]
|
||||
**Disabled** | **Boolean** | Indicates whether the identity is disabled. | [optional] [default to $false]
|
||||
**Locked** | **Boolean** | Indicates whether the identity is locked. | [optional] [default to $false]
|
||||
**ProcessingState** | **String** | Identity's processing state. | [optional]
|
||||
**ProcessingDetails** | [**ProcessingDetails**](processing-details) | | [optional]
|
||||
**Accounts** | [**[]BaseAccount**](base-account) | List of accounts associated with the identity. | [optional]
|
||||
@@ -50,6 +51,9 @@ Name | Type | Description | Notes
|
||||
**Owns** | [**[]Owns**](owns) | Access items the identity owns. | [optional]
|
||||
**OwnsCount** | **Int32** | Number of access items the identity owns. | [optional]
|
||||
**Tags** | **[]String** | Tags that have been applied to the object. | [optional]
|
||||
**TagsCount** | **Int32** | Number of tags on the identity. | [optional]
|
||||
**VisibleSegments** | **[]String** | List of segments that the identity is in. | [optional]
|
||||
**VisibleSegmentCount** | **Int32** | Number of segments the identity is in. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
@@ -57,7 +61,6 @@ Name | Type | Description | Notes
|
||||
```powershell
|
||||
$IdentityDocument = Initialize-PSSailpoint.V2024IdentityDocument -Id 2c91808568c529c60168cca6f90c1313 `
|
||||
-Name John Doe `
|
||||
-Type null `
|
||||
-DisplayName Carol.Adams `
|
||||
-FirstName Carol `
|
||||
-LastName Adams `
|
||||
@@ -75,7 +78,9 @@ $IdentityDocument = Initialize-PSSailpoint.V2024IdentityDocument -Id 2c91808568
|
||||
-IdentityProfile null `
|
||||
-Source null `
|
||||
-Attributes {country=US, firstname=Carol, cloudStatus=UNREGISTERED} `
|
||||
-ProcessingState null `
|
||||
-Disabled false `
|
||||
-Locked false `
|
||||
-ProcessingState ERROR `
|
||||
-ProcessingDetails null `
|
||||
-Accounts null `
|
||||
-AccountCount 3 `
|
||||
@@ -88,7 +93,10 @@ $IdentityDocument = Initialize-PSSailpoint.V2024IdentityDocument -Id 2c91808568
|
||||
-AccessProfileCount 1 `
|
||||
-Owns null `
|
||||
-OwnsCount 5 `
|
||||
-Tags [TAG_1, TAG_2]
|
||||
-Tags [TAG_1, TAG_2] `
|
||||
-TagsCount null `
|
||||
-VisibleSegments [All Employees] `
|
||||
-VisibleSegmentCount 1
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
|
||||
@@ -17,6 +17,7 @@ tags: ['SDK', 'Software Development Kit', 'OriginalRequest', 'V2024OriginalReque
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**AccountId** | **String** | Account ID. | [optional]
|
||||
**Result** | [**Result**](result) | | [optional]
|
||||
**AttributeRequests** | [**[]AttributeRequest**](attribute-request) | Attribute changes requested for account. | [optional]
|
||||
**Op** | **String** | Operation used. | [optional]
|
||||
**Source** | [**AccountSource**](account-source) | | [optional]
|
||||
@@ -26,6 +27,7 @@ Name | Type | Description | Notes
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$OriginalRequest = Initialize-PSSailpoint.V2024OriginalRequest -AccountId CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com `
|
||||
-Result null `
|
||||
-AttributeRequests null `
|
||||
-Op add `
|
||||
-Source null
|
||||
|
||||
35
docs/tools/sdk/powershell/Reference/V2024/Models/Result.md
Normal file
35
docs/tools/sdk/powershell/Reference/V2024/Models/Result.md
Normal file
@@ -0,0 +1,35 @@
|
||||
---
|
||||
id: v2024-result
|
||||
title: Result
|
||||
pagination_label: Result
|
||||
sidebar_label: Result
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'Result', 'V2024Result']
|
||||
slug: /tools/sdk/powershell/v2024/models/result
|
||||
tags: ['SDK', 'Software Development Kit', 'Result', 'V2024Result']
|
||||
---
|
||||
|
||||
|
||||
# Result
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Status** | **String** | Request result status | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$Result = Initialize-PSSailpoint.V2024Result -Status Manual Task Created
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$Result | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -16,9 +16,6 @@ tags: ['SDK', 'Software Development Kit', 'RoleDocument', 'V2024RoleDocument']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | The unique ID of the referenced object. | [required]
|
||||
**Name** | **String** | The human readable name of the referenced object. | [required]
|
||||
**Type** | [**DocumentType**](document-type) | | [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]
|
||||
@@ -26,23 +23,26 @@ Name | Type | Description | Notes
|
||||
**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]
|
||||
**Owner** | [**BaseAccessOwner**](base-access-owner) | | [optional]
|
||||
**Id** | **String** | ID of the role. | [required]
|
||||
**Name** | **String** | Name of the role. | [required]
|
||||
**AccessProfiles** | [**[]BaseAccessProfile**](base-access-profile) | Access profiles included with the role. | [optional]
|
||||
**AccessProfileCount** | **Int32** | Number of access profiles included with the role. | [optional]
|
||||
**Tags** | **[]String** | Tags that have been applied to the object. | [optional]
|
||||
**Segments** | [**[]BaseSegment**](base-segment) | Segments with the role. | [optional]
|
||||
**SegmentCount** | **Int32** | Number of segments with the role. | [optional]
|
||||
**Entitlements** | [**[]BaseEntitlement**](base-entitlement) | Entitlements included with the role. | [optional]
|
||||
**Entitlements** | [**[]RoleDocumentAllOfEntitlements**](role-document-all-of-entitlements) | Entitlements included with the role. | [optional]
|
||||
**EntitlementCount** | **Int32** | Number of entitlements included with the role. | [optional]
|
||||
**Dimensional** | **Boolean** | | [optional] [default to $false]
|
||||
**DimensionSchemaAttributeCount** | **Int32** | Number of dimension attributes included with the role. | [optional]
|
||||
**DimensionSchemaAttributes** | [**[]RoleDocumentAllOfDimensionSchemaAttributes**](role-document-all-of-dimension-schema-attributes) | Dimension attributes included with the role. | [optional]
|
||||
**Dimensions** | [**[]RoleDocumentAllOfDimensions**](role-document-all-of-dimensions) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$RoleDocument = Initialize-PSSailpoint.V2024RoleDocument -Id 2c91808568c529c60168cca6f90c1313 `
|
||||
-Name John Doe `
|
||||
-Type null `
|
||||
-Description The admin role `
|
||||
$RoleDocument = Initialize-PSSailpoint.V2024RoleDocument -Description Admin access `
|
||||
-Created 2018-06-25T20:22:28.104Z `
|
||||
-Modified 2018-06-25T20:22:28.104Z `
|
||||
-Synced 2018-06-25T20:22:33.104Z `
|
||||
@@ -50,13 +50,19 @@ $RoleDocument = Initialize-PSSailpoint.V2024RoleDocument -Id 2c91808568c529c601
|
||||
-Requestable true `
|
||||
-RequestCommentsRequired false `
|
||||
-Owner null `
|
||||
-Id 2c91808375d8e80a0175e1f88a575222 `
|
||||
-Name Branch Manager Access `
|
||||
-AccessProfiles null `
|
||||
-AccessProfileCount 1 `
|
||||
-Tags [TAG_1, TAG_2] `
|
||||
-Segments null `
|
||||
-SegmentCount 1 `
|
||||
-Entitlements null `
|
||||
-EntitlementCount 3
|
||||
-EntitlementCount 3 `
|
||||
-Dimensional false `
|
||||
-DimensionSchemaAttributeCount 3 `
|
||||
-DimensionSchemaAttributes null `
|
||||
-Dimensions null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: v2024-role-document-all-of-dimension-schema-attributes
|
||||
title: RoleDocumentAllOfDimensionSchemaAttributes
|
||||
pagination_label: RoleDocumentAllOfDimensionSchemaAttributes
|
||||
sidebar_label: RoleDocumentAllOfDimensionSchemaAttributes
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'RoleDocumentAllOfDimensionSchemaAttributes', 'V2024RoleDocumentAllOfDimensionSchemaAttributes']
|
||||
slug: /tools/sdk/powershell/v2024/models/role-document-all-of-dimension-schema-attributes
|
||||
tags: ['SDK', 'Software Development Kit', 'RoleDocumentAllOfDimensionSchemaAttributes', 'V2024RoleDocumentAllOfDimensionSchemaAttributes']
|
||||
---
|
||||
|
||||
|
||||
# RoleDocumentAllOfDimensionSchemaAttributes
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Derived** | **Boolean** | | [optional] [default to $true]
|
||||
**DisplayName** | **String** | Displayname of the dimension attribute. | [optional]
|
||||
**Name** | **String** | Name of the dimension attribute. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$RoleDocumentAllOfDimensionSchemaAttributes = Initialize-PSSailpoint.V2024RoleDocumentAllOfDimensionSchemaAttributes -Derived true `
|
||||
-DisplayName Department `
|
||||
-Name department
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$RoleDocumentAllOfDimensionSchemaAttributes | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
id: v2024-role-document-all-of-dimensions
|
||||
title: RoleDocumentAllOfDimensions
|
||||
pagination_label: RoleDocumentAllOfDimensions
|
||||
sidebar_label: RoleDocumentAllOfDimensions
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'RoleDocumentAllOfDimensions', 'V2024RoleDocumentAllOfDimensions']
|
||||
slug: /tools/sdk/powershell/v2024/models/role-document-all-of-dimensions
|
||||
tags: ['SDK', 'Software Development Kit', 'RoleDocumentAllOfDimensions', 'V2024RoleDocumentAllOfDimensions']
|
||||
---
|
||||
|
||||
|
||||
# RoleDocumentAllOfDimensions
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | Unique ID of the dimension. | [optional]
|
||||
**Name** | **String** | Name of the dimension. | [optional]
|
||||
**Description** | **String** | Description of the dimension. | [optional]
|
||||
**Entitlements** | [**[]RoleDocumentAllOfEntitlements1**](role-document-all-of-entitlements1) | Entitlements included with the role. | [optional]
|
||||
**AccessProfiles** | [**[]BaseAccessProfile**](base-access-profile) | Access profiles included in the dimension. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$RoleDocumentAllOfDimensions = Initialize-PSSailpoint.V2024RoleDocumentAllOfDimensions -Id b3c28992ba964a40a7598978139d1ced `
|
||||
-Name Manager Austin Branch `
|
||||
-Description Managers located at the Austin branch `
|
||||
-Entitlements null `
|
||||
-AccessProfiles null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$RoleDocumentAllOfDimensions | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,53 @@
|
||||
---
|
||||
id: v2024-role-document-all-of-entitlements
|
||||
title: RoleDocumentAllOfEntitlements
|
||||
pagination_label: RoleDocumentAllOfEntitlements
|
||||
sidebar_label: RoleDocumentAllOfEntitlements
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'RoleDocumentAllOfEntitlements', 'V2024RoleDocumentAllOfEntitlements']
|
||||
slug: /tools/sdk/powershell/v2024/models/role-document-all-of-entitlements
|
||||
tags: ['SDK', 'Software Development Kit', 'RoleDocumentAllOfEntitlements', 'V2024RoleDocumentAllOfEntitlements']
|
||||
---
|
||||
|
||||
|
||||
# RoleDocumentAllOfEntitlements
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**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]
|
||||
**SourceSchemaObjectType** | **String** | Schema objectType. | [optional]
|
||||
**Hash** | **String** | Read-only calculated hash value of an entitlement. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$RoleDocumentAllOfEntitlements = Initialize-PSSailpoint.V2024RoleDocumentAllOfEntitlements -HasPermissions false `
|
||||
-Description Cloud engineering `
|
||||
-Attribute memberOf `
|
||||
-Value CN=Cloud Engineering,DC=sailpoint,DC=COM `
|
||||
-Schema group `
|
||||
-Privileged false `
|
||||
-Id 2c918084575812550157589064f33b89 `
|
||||
-Name CN=Cloud Engineering,DC=sailpoint,DC=COM `
|
||||
-SourceSchemaObjectType group `
|
||||
-Hash c6fab95235584cca98a454a2f51e5683bc77d6a0
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$RoleDocumentAllOfEntitlements | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,53 @@
|
||||
---
|
||||
id: v2024-role-document-all-of-entitlements1
|
||||
title: RoleDocumentAllOfEntitlements1
|
||||
pagination_label: RoleDocumentAllOfEntitlements1
|
||||
sidebar_label: RoleDocumentAllOfEntitlements1
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'RoleDocumentAllOfEntitlements1', 'V2024RoleDocumentAllOfEntitlements1']
|
||||
slug: /tools/sdk/powershell/v2024/models/role-document-all-of-entitlements1
|
||||
tags: ['SDK', 'Software Development Kit', 'RoleDocumentAllOfEntitlements1', 'V2024RoleDocumentAllOfEntitlements1']
|
||||
---
|
||||
|
||||
|
||||
# RoleDocumentAllOfEntitlements1
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**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]
|
||||
**SourceSchemaObjectType** | **String** | Schema objectType. | [optional]
|
||||
**Hash** | **String** | Read-only calculated hash value of an entitlement. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$RoleDocumentAllOfEntitlements1 = Initialize-PSSailpoint.V2024RoleDocumentAllOfEntitlements1 -HasPermissions false `
|
||||
-Description Cloud engineering `
|
||||
-Attribute memberOf `
|
||||
-Value CN=Cloud Engineering,DC=sailpoint,DC=COM `
|
||||
-Schema group `
|
||||
-Privileged false `
|
||||
-Id 2c918084575812550157589064f33b89 `
|
||||
-Name CN=Cloud Engineering,DC=sailpoint,DC=COM `
|
||||
-SourceSchemaObjectType group `
|
||||
-Hash c6fab95235584cca98a454a2f51e5683bc77d6a0
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$RoleDocumentAllOfEntitlements1 | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -19,8 +19,8 @@ Name | Type | Description | Notes
|
||||
**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]
|
||||
**Description** | **String** | Description of access item. | [optional]
|
||||
**Type** | **String** | Type of the access item. | [optional]
|
||||
**Owner** | [**DisplayReference**](display-reference) | | [optional]
|
||||
**Disabled** | **Boolean** | | [optional]
|
||||
**Revocable** | **Boolean** | | [optional]
|
||||
@@ -32,8 +32,8 @@ Name | Type | Description | Notes
|
||||
$RoleSummary = Initialize-PSSailpoint.V2024RoleSummary -Id 2c91808568c529c60168cca6f90c1313 `
|
||||
-Name John Doe `
|
||||
-DisplayName John Q. Doe `
|
||||
-Type null `
|
||||
-Description null `
|
||||
-Type ROLE `
|
||||
-Owner null `
|
||||
-Disabled null `
|
||||
-Revocable null
|
||||
|
||||
@@ -19,8 +19,7 @@ Name | Type | Description | Notes
|
||||
**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]
|
||||
**Description** | **String** | Description of access item. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
@@ -29,7 +28,6 @@ Name | Type | Description | Notes
|
||||
$Access = Initialize-PSSailpoint.V3Access -Id 2c91808568c529c60168cca6f90c1313 `
|
||||
-Name John Doe `
|
||||
-DisplayName John Q. Doe `
|
||||
-Type null `
|
||||
-Description null
|
||||
```
|
||||
|
||||
|
||||
41
docs/tools/sdk/powershell/Reference/V3/Models/AccessApps.md
Normal file
41
docs/tools/sdk/powershell/Reference/V3/Models/AccessApps.md
Normal file
@@ -0,0 +1,41 @@
|
||||
---
|
||||
id: access-apps
|
||||
title: AccessApps
|
||||
pagination_label: AccessApps
|
||||
sidebar_label: AccessApps
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessApps', 'AccessApps']
|
||||
slug: /tools/sdk/powershell/v3/models/access-apps
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessApps', 'AccessApps']
|
||||
---
|
||||
|
||||
|
||||
# AccessApps
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | The unique ID of the referenced object. | [optional]
|
||||
**Name** | **String** | Name of application | [optional]
|
||||
**Description** | **String** | Description of application. | [optional]
|
||||
**Owner** | [**AccessAppsOwner**](access-apps-owner) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AccessApps = Initialize-PSSailpoint.V3AccessApps -Id 2c91808568c529c60168cca6f90c1313 `
|
||||
-Name Travel and Expense `
|
||||
-Description Travel and Expense Application `
|
||||
-Owner null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$AccessApps | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
---
|
||||
id: access-apps-owner
|
||||
title: AccessAppsOwner
|
||||
pagination_label: AccessAppsOwner
|
||||
sidebar_label: AccessAppsOwner
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessAppsOwner', 'AccessAppsOwner']
|
||||
slug: /tools/sdk/powershell/v3/models/access-apps-owner
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessAppsOwner', 'AccessAppsOwner']
|
||||
---
|
||||
|
||||
|
||||
# AccessAppsOwner
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**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
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AccessAppsOwner = Initialize-PSSailpoint.V3AccessAppsOwner -Type IDENTITY `
|
||||
-Id 2c9180a46faadee4016fb4e018c20639 `
|
||||
-Name John Doe `
|
||||
-Email john.doe@sailpoint.com
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$AccessAppsOwner | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -16,8 +16,6 @@ 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** | **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]
|
||||
@@ -25,20 +23,22 @@ Name | Type | Description | Notes
|
||||
**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]
|
||||
**Owner** | [**BaseAccessOwner**](base-access-owner) | | [optional]
|
||||
**Id** | **String** | Access profile's ID. | [required]
|
||||
**Name** | **String** | Access profile's name. | [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]
|
||||
**Segments** | [**[]BaseSegment**](base-segment) | Segments with the access profile. | [optional]
|
||||
**SegmentCount** | **Int32** | Number of segments with the access profile. | [optional]
|
||||
**Tags** | **[]String** | Tags that have been applied to the object. | [optional]
|
||||
**Apps** | [**[]AccessApps**](access-apps) | Applications with the access profile | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AccessProfileDocument = Initialize-PSSailpoint.V3AccessProfileDocument -Id 2c9180825a6c1adc015a71c9023f0818 `
|
||||
-Name Cloud Eng `
|
||||
-Description The admin role `
|
||||
$AccessProfileDocument = Initialize-PSSailpoint.V3AccessProfileDocument -Description Admin access `
|
||||
-Created 2018-06-25T20:22:28.104Z `
|
||||
-Modified 2018-06-25T20:22:28.104Z `
|
||||
-Synced 2018-06-25T20:22:33.104Z `
|
||||
@@ -46,11 +46,15 @@ $AccessProfileDocument = Initialize-PSSailpoint.V3AccessProfileDocument -Id 2c9
|
||||
-Requestable true `
|
||||
-RequestCommentsRequired false `
|
||||
-Owner null `
|
||||
-Type accessprofile `
|
||||
-Id 2c9180825a6c1adc015a71c9023f0818 `
|
||||
-Name Cloud Eng `
|
||||
-Source null `
|
||||
-Entitlements null `
|
||||
-EntitlementCount 5 `
|
||||
-Tags [TAG_1, TAG_2]
|
||||
-Segments null `
|
||||
-SegmentCount 1 `
|
||||
-Tags [TAG_1, TAG_2] `
|
||||
-Apps null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
|
||||
@@ -19,9 +19,9 @@ Name | Type | Description | Notes
|
||||
**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]
|
||||
**Description** | **String** | Description of access item. | [optional]
|
||||
**Source** | [**Reference1**](reference1) | | [optional]
|
||||
**Type** | **String** | Type of the access item. | [optional]
|
||||
**Privileged** | **Boolean** | | [optional]
|
||||
**Attribute** | **String** | | [optional]
|
||||
**Value** | **String** | | [optional]
|
||||
@@ -34,9 +34,9 @@ Name | Type | Description | Notes
|
||||
$AccessProfileEntitlement = Initialize-PSSailpoint.V3AccessProfileEntitlement -Id 2c91808568c529c60168cca6f90c1313 `
|
||||
-Name John Doe `
|
||||
-DisplayName John Q. Doe `
|
||||
-Type null `
|
||||
-Description null `
|
||||
-Source null `
|
||||
-Type ENTITLEMENT `
|
||||
-Privileged false `
|
||||
-Attribute memberOf `
|
||||
-Value CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com `
|
||||
|
||||
@@ -19,8 +19,8 @@ Name | Type | Description | Notes
|
||||
**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]
|
||||
**Description** | **String** | Description of access item. | [optional]
|
||||
**Type** | **String** | Type of the access item. | [optional]
|
||||
**Owner** | [**DisplayReference**](display-reference) | | [optional]
|
||||
**Disabled** | **Boolean** | | [optional]
|
||||
**Revocable** | **Boolean** | | [optional]
|
||||
@@ -32,8 +32,8 @@ Name | Type | Description | Notes
|
||||
$AccessProfileRole = Initialize-PSSailpoint.V3AccessProfileRole -Id 2c91808568c529c60168cca6f90c1313 `
|
||||
-Name John Doe `
|
||||
-DisplayName John Q. Doe `
|
||||
-Type null `
|
||||
-Description null `
|
||||
-Type ROLE `
|
||||
-Owner null `
|
||||
-Disabled null `
|
||||
-Revocable null
|
||||
|
||||
@@ -19,8 +19,8 @@ Name | Type | Description | Notes
|
||||
**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]
|
||||
**Description** | **String** | Description of access item. | [optional]
|
||||
**Type** | **String** | Type of the access item. | [optional]
|
||||
**Source** | [**Reference1**](reference1) | | [optional]
|
||||
**Owner** | [**DisplayReference**](display-reference) | | [optional]
|
||||
**Revocable** | **Boolean** | | [optional]
|
||||
@@ -32,8 +32,8 @@ Name | Type | Description | Notes
|
||||
$AccessProfileSummary = Initialize-PSSailpoint.V3AccessProfileSummary -Id 2c91808568c529c60168cca6f90c1313 `
|
||||
-Name John Doe `
|
||||
-DisplayName John Q. Doe `
|
||||
-Type null `
|
||||
-Description null `
|
||||
-Type ACCESS_PROFILE `
|
||||
-Source null `
|
||||
-Owner null `
|
||||
-Revocable true
|
||||
|
||||
@@ -16,17 +16,15 @@ tags: ['SDK', 'Software Development Kit', 'AccountActivityDocument', 'AccountAct
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | | [required]
|
||||
**Name** | **String** | | [required]
|
||||
**Type** | [**DocumentType**](document-type) | | [required]
|
||||
**Id** | **String** | ID of account activity. | [optional]
|
||||
**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]
|
||||
**Synced** | **String** | 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]
|
||||
**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]
|
||||
**Requester** | [**ActivityIdentity**](activity-identity) | | [optional]
|
||||
**Recipient** | [**ActivityIdentity**](activity-identity) | | [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]
|
||||
@@ -41,13 +39,11 @@ Name | Type | Description | Notes
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AccountActivityDocument = Initialize-PSSailpoint.V3AccountActivityDocument -Id 2c91808375d8e80a0175e1f88a575222 `
|
||||
-Name john.doe `
|
||||
-Type null `
|
||||
-Action Identity Refresh. `
|
||||
-Created 2018-06-25T20:22:28.104Z `
|
||||
-Modified 2018-06-25T20:22:28.104Z `
|
||||
-Synced 2018-06-25T20:22:28.104Z `
|
||||
-Stage Completed `
|
||||
-Origin null `
|
||||
-Status Complete `
|
||||
-Requester null `
|
||||
-Recipient null `
|
||||
|
||||
@@ -16,17 +16,15 @@ tags: ['SDK', 'Software Development Kit', 'AccountActivitySearchedItem', 'Accoun
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | | [required]
|
||||
**Name** | **String** | | [required]
|
||||
**Type** | [**DocumentType**](document-type) | | [required]
|
||||
**Id** | **String** | ID of account activity. | [optional]
|
||||
**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]
|
||||
**Synced** | **String** | 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]
|
||||
**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]
|
||||
**Requester** | [**ActivityIdentity**](activity-identity) | | [optional]
|
||||
**Recipient** | [**ActivityIdentity**](activity-identity) | | [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]
|
||||
@@ -41,13 +39,11 @@ Name | Type | Description | Notes
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AccountActivitySearchedItem = Initialize-PSSailpoint.V3AccountActivitySearchedItem -Id 2c91808375d8e80a0175e1f88a575222 `
|
||||
-Name john.doe `
|
||||
-Type null `
|
||||
-Action Identity Refresh. `
|
||||
-Created 2018-06-25T20:22:28.104Z `
|
||||
-Modified 2018-06-25T20:22:28.104Z `
|
||||
-Synced 2018-06-25T20:22:28.104Z `
|
||||
-Stage Completed `
|
||||
-Origin null `
|
||||
-Status Complete `
|
||||
-Requester null `
|
||||
-Recipient null `
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccountRequestResult', 'AccountReques
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Errors** | **[]String** | | [optional]
|
||||
**Errors** | **[]String** | Error message. | [optional]
|
||||
**Status** | **String** | The status of the account request | [optional]
|
||||
**TicketId** | **String** | | [optional]
|
||||
**TicketId** | **String** | ID of associated ticket. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: activity-identity
|
||||
title: ActivityIdentity
|
||||
pagination_label: ActivityIdentity
|
||||
sidebar_label: ActivityIdentity
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'ActivityIdentity', 'ActivityIdentity']
|
||||
slug: /tools/sdk/powershell/v3/models/activity-identity
|
||||
tags: ['SDK', 'Software Development Kit', 'ActivityIdentity', 'ActivityIdentity']
|
||||
---
|
||||
|
||||
|
||||
# ActivityIdentity
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**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 object | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ActivityIdentity = Initialize-PSSailpoint.V3ActivityIdentity -Id 2c91808568c529c60168cca6f90c1313 `
|
||||
-Name John Doe `
|
||||
-Type Identity
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$ActivityIdentity | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -17,22 +17,22 @@ tags: ['SDK', 'Software Development Kit', 'Approval', 'Approval']
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**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]
|
||||
**Owner** | [**ActivityIdentity**](activity-identity) | | [optional]
|
||||
**Result** | **String** | The result of the approval | [optional]
|
||||
**Type** | **String** | | [optional]
|
||||
**AttributeRequest** | [**AttributeRequest**](attribute-request) | | [optional]
|
||||
**Source** | [**AccountSource**](account-source) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$Approval = Initialize-PSSailpoint.V3Approval -Comments null `
|
||||
-Created 2018-06-25T20:22:28.104Z `
|
||||
-Modified 2018-06-25T20:22:28.104Z `
|
||||
-Owner null `
|
||||
-Result Finished `
|
||||
-Type null
|
||||
-AttributeRequest null `
|
||||
-Source null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
|
||||
@@ -18,7 +18,7 @@ Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Name** | **String** | Attribute name. | [optional]
|
||||
**Op** | **String** | Operation to perform on attribute. | [optional]
|
||||
**Value** | **String** | Value of attribute. | [optional]
|
||||
**Value** | [**AttributeRequestValue**](attribute-request-value) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
@@ -26,7 +26,7 @@ Name | Type | Description | Notes
|
||||
```powershell
|
||||
$AttributeRequest = Initialize-PSSailpoint.V3AttributeRequest -Name groups `
|
||||
-Op Add `
|
||||
-Value 3203537556531076
|
||||
-Value null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
|
||||
@@ -0,0 +1,34 @@
|
||||
---
|
||||
id: attribute-request-value
|
||||
title: AttributeRequestValue
|
||||
pagination_label: AttributeRequestValue
|
||||
sidebar_label: AttributeRequestValue
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'AttributeRequestValue', 'AttributeRequestValue']
|
||||
slug: /tools/sdk/powershell/v3/models/attribute-request-value
|
||||
tags: ['SDK', 'Software Development Kit', 'AttributeRequestValue', 'AttributeRequestValue']
|
||||
---
|
||||
|
||||
|
||||
# AttributeRequestValue
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$AttributeRequestValue = Initialize-PSSailpoint.V3AttributeRequestValue
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$AttributeRequestValue | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -16,8 +16,6 @@ tags: ['SDK', 'Software Development Kit', 'BaseAccess', 'BaseAccess']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**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]
|
||||
@@ -25,15 +23,13 @@ Name | Type | Description | Notes
|
||||
**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]
|
||||
**Owner** | [**BaseAccessOwner**](base-access-owner) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$BaseAccess = Initialize-PSSailpoint.V3BaseAccess -Id 2c91808568c529c60168cca6f90c1313 `
|
||||
-Name John Doe `
|
||||
-Description The admin role `
|
||||
$BaseAccess = Initialize-PSSailpoint.V3BaseAccess -Description Admin access `
|
||||
-Created 2018-06-25T20:22:28.104Z `
|
||||
-Modified 2018-06-25T20:22:28.104Z `
|
||||
-Synced 2018-06-25T20:22:33.104Z `
|
||||
|
||||
@@ -1,16 +1,16 @@
|
||||
---
|
||||
id: v2024-base-access-all-of-owner
|
||||
title: BaseAccessAllOfOwner
|
||||
pagination_label: BaseAccessAllOfOwner
|
||||
sidebar_label: BaseAccessAllOfOwner
|
||||
id: base-access-owner
|
||||
title: BaseAccessOwner
|
||||
pagination_label: BaseAccessOwner
|
||||
sidebar_label: BaseAccessOwner
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'BaseAccessAllOfOwner', 'V2024BaseAccessAllOfOwner']
|
||||
slug: /tools/sdk/powershell/v2024/models/base-access-all-of-owner
|
||||
tags: ['SDK', 'Software Development Kit', 'BaseAccessAllOfOwner', 'V2024BaseAccessAllOfOwner']
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'BaseAccessOwner', 'BaseAccessOwner']
|
||||
slug: /tools/sdk/powershell/v3/models/base-access-owner
|
||||
tags: ['SDK', 'Software Development Kit', 'BaseAccessOwner', 'BaseAccessOwner']
|
||||
---
|
||||
|
||||
|
||||
# BaseAccessAllOfOwner
|
||||
# BaseAccessOwner
|
||||
|
||||
## Properties
|
||||
|
||||
@@ -25,7 +25,7 @@ Name | Type | Description | Notes
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$BaseAccessAllOfOwner = Initialize-PSSailpoint.V2024BaseAccessAllOfOwner -Type IDENTITY `
|
||||
$BaseAccessOwner = Initialize-PSSailpoint.V3BaseAccessOwner -Type IDENTITY `
|
||||
-Id 2c9180a46faadee4016fb4e018c20639 `
|
||||
-Name Support `
|
||||
-Email cloud-support@sailpoint.com
|
||||
@@ -33,7 +33,7 @@ $BaseAccessAllOfOwner = Initialize-PSSailpoint.V2024BaseAccessAllOfOwner -Type
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$BaseAccessAllOfOwner | ConvertTo-JSON
|
||||
$BaseAccessOwner | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
@@ -27,6 +27,8 @@ Name | Type | Description | Notes
|
||||
**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]
|
||||
**SupportsPasswordChange** | **Boolean** | Indicates whether the account supports password change. | [optional] [default to $false]
|
||||
**AccountAttributes** | [**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]
|
||||
|
||||
## Examples
|
||||
|
||||
@@ -42,7 +44,9 @@ $BaseAccount = Initialize-PSSailpoint.V3BaseAccount -Id 2c91808568c529c60168cca
|
||||
-ManuallyCorrelated false `
|
||||
-PasswordLastSet 2018-06-25T20:22:28.104Z `
|
||||
-EntitlementAttributes {moderator=true, admin=true, trust_level=4} `
|
||||
-Created 2018-06-25T20:22:28.104Z
|
||||
-Created 2018-06-25T20:22:28.104Z `
|
||||
-SupportsPasswordChange false `
|
||||
-AccountAttributes {type=global, admin=true, trust_level=4}
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
|
||||
@@ -16,17 +16,15 @@ tags: ['SDK', 'Software Development Kit', 'BaseDocument', 'BaseDocument']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | | [required]
|
||||
**Name** | **String** | | [required]
|
||||
**Type** | [**DocumentType**](document-type) | | [required]
|
||||
**Id** | **String** | ID of the referenced object. | [required]
|
||||
**Name** | **String** | The human readable name of the referenced object. | [required]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$BaseDocument = Initialize-PSSailpoint.V3BaseDocument -Id 2c91808375d8e80a0175e1f88a575222 `
|
||||
-Name john.doe `
|
||||
-Type null
|
||||
-Name john.doe
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
|
||||
@@ -1,36 +0,0 @@
|
||||
---
|
||||
id: document-type
|
||||
title: DocumentType
|
||||
pagination_label: DocumentType
|
||||
sidebar_label: DocumentType
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'DocumentType', 'DocumentType']
|
||||
slug: /tools/sdk/powershell/v3/models/document-type
|
||||
tags: ['SDK', 'Software Development Kit', 'DocumentType', 'DocumentType']
|
||||
---
|
||||
|
||||
|
||||
# DocumentType
|
||||
|
||||
## Enum
|
||||
|
||||
|
||||
* `accessprofile` (value: `"accessprofile"`)
|
||||
|
||||
* `accountactivity` (value: `"accountactivity"`)
|
||||
|
||||
* `account` (value: `"account"`)
|
||||
|
||||
* `aggregation` (value: `"aggregation"`)
|
||||
|
||||
* `entitlement` (value: `"entitlement"`)
|
||||
|
||||
* `event` (value: `"event"`)
|
||||
|
||||
* `identity` (value: `"identity"`)
|
||||
|
||||
* `role` (value: `"role"`)
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -16,21 +16,29 @@ tags: ['SDK', 'Software Development Kit', 'EntitlementDocument', 'EntitlementDoc
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | | [required]
|
||||
**Name** | **String** | | [required]
|
||||
**Type** | [**DocumentType**](document-type) | | [required]
|
||||
**Id** | **String** | ID of the referenced object. | [required]
|
||||
**Name** | **String** | The human readable name of the referenced object. | [required]
|
||||
**Modified** | **System.DateTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional]
|
||||
**Synced** | **String** | 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]
|
||||
**DisplayName** | **String** | Entitlement's display name. | [optional]
|
||||
**Source** | [**EntitlementDocumentAllOfSource**](entitlement-document-all-of-source) | | [optional]
|
||||
**Segments** | [**[]BaseSegment**](base-segment) | Segments with the role. | [optional]
|
||||
**Segments** | [**[]BaseSegment**](base-segment) | Segments with the entitlement. | [optional]
|
||||
**SegmentCount** | **Int32** | Number of segments with the role. | [optional]
|
||||
**Requestable** | **Boolean** | Indicates whether the entitlement is requestable. | [optional] [default to $false]
|
||||
**CloudGoverned** | **Boolean** | Indicates whether the entitlement is cloud governed. | [optional] [default to $false]
|
||||
**Created** | **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
|
||||
**Privileged** | **Boolean** | Indicates whether the entitlement is privileged. | [optional] [default to $false]
|
||||
**IdentityCount** | **Int32** | Number of identities who have access to the entitlement. | [optional]
|
||||
**Tags** | **[]String** | Tags that have been applied to the object. | [optional]
|
||||
**Attribute** | **String** | Attribute information for the entitlement. | [optional]
|
||||
**Value** | **String** | Value of the entitlement. | [optional]
|
||||
**SourceSchemaObjectType** | **String** | Source schema object type of the entitlement. | [optional]
|
||||
**Schema** | **String** | Schema type of the entitlement. | [optional]
|
||||
**Hash** | **String** | Read-only calculated hash value of an entitlement. | [optional]
|
||||
**Attributes** | [**map[string]AnyType**]https://learn.microsoft.com/en-us/powershell/scripting/lang-spec/chapter-04?view=powershell-7.4 | Attributes of the entitlement. | [optional]
|
||||
**TruncatedAttributes** | **[]String** | Truncated attributes of the entitlement. | [optional]
|
||||
**ContainsDataAccess** | **Boolean** | Indicates whether the entitlement contains data access. | [optional] [default to $false]
|
||||
**ManuallyUpdatedFields** | [**EntitlementDocumentAllOfManuallyUpdatedFields**](entitlement-document-all-of-manually-updated-fields) | | [optional]
|
||||
**Permissions** | [**[]EntitlementDocumentAllOfPermissions**](entitlement-document-all-of-permissions) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
@@ -38,7 +46,6 @@ Name | Type | Description | Notes
|
||||
```powershell
|
||||
$EntitlementDocument = Initialize-PSSailpoint.V3EntitlementDocument -Id 2c91808375d8e80a0175e1f88a575222 `
|
||||
-Name john.doe `
|
||||
-Type null `
|
||||
-Modified 2018-06-25T20:22:28.104Z `
|
||||
-Synced null `
|
||||
-DisplayName Admin `
|
||||
@@ -49,8 +56,17 @@ $EntitlementDocument = Initialize-PSSailpoint.V3EntitlementDocument -Id 2c91808
|
||||
-CloudGoverned false `
|
||||
-Created 2018-06-25T20:22:28.104Z `
|
||||
-Privileged false `
|
||||
-IdentityCount 3 `
|
||||
-Tags [TAG_1, TAG_2]
|
||||
-Tags [TAG_1, TAG_2] `
|
||||
-Attribute groups `
|
||||
-Value 1733ff75-441e-4327-9bfc-3ac445fd8cd1 `
|
||||
-SourceSchemaObjectType group `
|
||||
-Schema group `
|
||||
-Hash c6fab95235584cca98a454a2f51e5683bc77d6a0 `
|
||||
-Attributes null `
|
||||
-TruncatedAttributes null `
|
||||
-ContainsDataAccess null `
|
||||
-ManuallyUpdatedFields null `
|
||||
-Permissions null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: entitlement-document-all-of-manually-updated-fields
|
||||
title: EntitlementDocumentAllOfManuallyUpdatedFields
|
||||
pagination_label: EntitlementDocumentAllOfManuallyUpdatedFields
|
||||
sidebar_label: EntitlementDocumentAllOfManuallyUpdatedFields
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementDocumentAllOfManuallyUpdatedFields', 'EntitlementDocumentAllOfManuallyUpdatedFields']
|
||||
slug: /tools/sdk/powershell/v3/models/entitlement-document-all-of-manually-updated-fields
|
||||
tags: ['SDK', 'Software Development Kit', 'EntitlementDocumentAllOfManuallyUpdatedFields', 'EntitlementDocumentAllOfManuallyUpdatedFields']
|
||||
---
|
||||
|
||||
|
||||
# EntitlementDocumentAllOfManuallyUpdatedFields
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**DESCRIPTION** | **Boolean** | | [optional] [default to $false]
|
||||
**DISPLAYNAME** | **Boolean** | | [optional] [default to $false]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$EntitlementDocumentAllOfManuallyUpdatedFields = Initialize-PSSailpoint.V3EntitlementDocumentAllOfManuallyUpdatedFields -DESCRIPTION false `
|
||||
-DISPLAYNAME false
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$EntitlementDocumentAllOfManuallyUpdatedFields | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: entitlement-document-all-of-permissions
|
||||
title: EntitlementDocumentAllOfPermissions
|
||||
pagination_label: EntitlementDocumentAllOfPermissions
|
||||
sidebar_label: EntitlementDocumentAllOfPermissions
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'EntitlementDocumentAllOfPermissions', 'EntitlementDocumentAllOfPermissions']
|
||||
slug: /tools/sdk/powershell/v3/models/entitlement-document-all-of-permissions
|
||||
tags: ['SDK', 'Software Development Kit', 'EntitlementDocumentAllOfPermissions', 'EntitlementDocumentAllOfPermissions']
|
||||
---
|
||||
|
||||
|
||||
# EntitlementDocumentAllOfPermissions
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Target** | **String** | The target the permission would grants rights on. | [optional]
|
||||
**Rights** | **[]String** | All the rights (e.g. actions) that this permission allows on the target | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$EntitlementDocumentAllOfPermissions = Initialize-PSSailpoint.V3EntitlementDocumentAllOfPermissions -Target SYS.GV_$TRANSACTION `
|
||||
-Rights null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$EntitlementDocumentAllOfPermissions | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -18,13 +18,15 @@ Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | ID of entitlement's source. | [optional]
|
||||
**Name** | **String** | Display name of entitlement's source. | [optional]
|
||||
**Type** | **String** | Type of object. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$EntitlementDocumentAllOfSource = Initialize-PSSailpoint.V3EntitlementDocumentAllOfSource -Id 2c91808b6e9e6fb8016eec1a2b6f7b5f `
|
||||
-Name ODS-HR-Employees
|
||||
-Name ODS-HR-Employees `
|
||||
-Type SOURCE
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
|
||||
@@ -19,9 +19,9 @@ Name | Type | Description | Notes
|
||||
**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]
|
||||
**Description** | **String** | Description of access item. | [optional]
|
||||
**Source** | [**Reference1**](reference1) | | [optional]
|
||||
**Type** | **String** | Type of the access item. | [optional]
|
||||
**Privileged** | **Boolean** | | [optional]
|
||||
**Attribute** | **String** | | [optional]
|
||||
**Value** | **String** | | [optional]
|
||||
@@ -34,9 +34,9 @@ Name | Type | Description | Notes
|
||||
$EntitlementSummary = Initialize-PSSailpoint.V3EntitlementSummary -Id 2c91808568c529c60168cca6f90c1313 `
|
||||
-Name John Doe `
|
||||
-DisplayName John Q. Doe `
|
||||
-Type null `
|
||||
-Description null `
|
||||
-Source null `
|
||||
-Type ENTITLEMENT `
|
||||
-Privileged false `
|
||||
-Attribute memberOf `
|
||||
-Value CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com `
|
||||
|
||||
@@ -16,15 +16,14 @@ tags: ['SDK', 'Software Development Kit', 'ModelEvent', 'ModelEvent']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | | [required]
|
||||
**Name** | **String** | | [required]
|
||||
**Type** | [**DocumentType**](document-type) | | [required]
|
||||
**Id** | **String** | ID of the entitlement. | [optional]
|
||||
**Name** | **String** | Name of the entitlement. | [optional]
|
||||
**Created** | **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
|
||||
**Synced** | **String** | 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]
|
||||
**Action** | **String** | Name of the event as it's displayed in audit reports. | [optional]
|
||||
**Type** | **String** | Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. | [optional]
|
||||
**Actor** | **String** | Name of the actor that generated the event. | [optional]
|
||||
**Target** | **String** | Name of the target, or recipient, of the event. | [optional]
|
||||
**Actor** | [**EventActor**](event-actor) | | [optional]
|
||||
**Target** | [**EventTarget**](event-target) | | [optional]
|
||||
**Stack** | **String** | The event's stack. | [optional]
|
||||
**TrackingNumber** | **String** | ID of the group of events. | [optional]
|
||||
**IpAddress** | **String** | Target system's IP address. | [optional]
|
||||
@@ -40,23 +39,22 @@ Name | Type | Description | Notes
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$ModelEvent = Initialize-PSSailpoint.V3ModelEvent -Id 2c91808375d8e80a0175e1f88a575222 `
|
||||
-Name john.doe `
|
||||
-Type null `
|
||||
-Name Add Entitlement Passed `
|
||||
-Created 2018-06-25T20:22:28.104Z `
|
||||
-Synced null `
|
||||
-Action update `
|
||||
-Type SYSTEM_CONFIG `
|
||||
-Actor System `
|
||||
-Target Carol.Adams `
|
||||
-Synced 2018-06-25T20:22:28.104Z `
|
||||
-Action AddEntitlement `
|
||||
-Type ACCESS_ITEM `
|
||||
-Actor null `
|
||||
-Target null `
|
||||
-Stack tpe `
|
||||
-TrackingNumber 63f891e0735f4cc8bf1968144a1e7440 `
|
||||
-IpAddress 52.52.97.85 `
|
||||
-Details 73b65dfbed1842548c207432a18c84b0 `
|
||||
-Attributes {pod=stg03-useast1, org=acme, sourceName=SailPoint} `
|
||||
-Objects null `
|
||||
-Operation REQUEST `
|
||||
-Operation ADD `
|
||||
-Status PASSED `
|
||||
-TechnicalName AUTHENTICATION_REQUEST_PASSED
|
||||
-TechnicalName ENTITLEMENT_ADD_PASSED
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
|
||||
35
docs/tools/sdk/powershell/Reference/V3/Models/EventActor.md
Normal file
35
docs/tools/sdk/powershell/Reference/V3/Models/EventActor.md
Normal file
@@ -0,0 +1,35 @@
|
||||
---
|
||||
id: event-actor
|
||||
title: EventActor
|
||||
pagination_label: EventActor
|
||||
sidebar_label: EventActor
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'EventActor', 'EventActor']
|
||||
slug: /tools/sdk/powershell/v3/models/event-actor
|
||||
tags: ['SDK', 'Software Development Kit', 'EventActor', 'EventActor']
|
||||
---
|
||||
|
||||
|
||||
# EventActor
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Name** | **String** | Name of the actor that generated the event. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$EventActor = Initialize-PSSailpoint.V3EventActor -Name System
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$EventActor | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -16,15 +16,14 @@ tags: ['SDK', 'Software Development Kit', 'EventDocument', 'EventDocument']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | | [required]
|
||||
**Name** | **String** | | [required]
|
||||
**Type** | [**DocumentType**](document-type) | | [required]
|
||||
**Id** | **String** | ID of the entitlement. | [optional]
|
||||
**Name** | **String** | Name of the entitlement. | [optional]
|
||||
**Created** | **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
|
||||
**Synced** | **String** | 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]
|
||||
**Action** | **String** | Name of the event as it's displayed in audit reports. | [optional]
|
||||
**Type** | **String** | Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. | [optional]
|
||||
**Actor** | **String** | Name of the actor that generated the event. | [optional]
|
||||
**Target** | **String** | Name of the target, or recipient, of the event. | [optional]
|
||||
**Actor** | [**EventActor**](event-actor) | | [optional]
|
||||
**Target** | [**EventTarget**](event-target) | | [optional]
|
||||
**Stack** | **String** | The event's stack. | [optional]
|
||||
**TrackingNumber** | **String** | ID of the group of events. | [optional]
|
||||
**IpAddress** | **String** | Target system's IP address. | [optional]
|
||||
@@ -40,23 +39,22 @@ Name | Type | Description | Notes
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$EventDocument = Initialize-PSSailpoint.V3EventDocument -Id 2c91808375d8e80a0175e1f88a575222 `
|
||||
-Name john.doe `
|
||||
-Type null `
|
||||
-Name Add Entitlement Passed `
|
||||
-Created 2018-06-25T20:22:28.104Z `
|
||||
-Synced null `
|
||||
-Action update `
|
||||
-Type SYSTEM_CONFIG `
|
||||
-Actor System `
|
||||
-Target Carol.Adams `
|
||||
-Synced 2018-06-25T20:22:28.104Z `
|
||||
-Action AddEntitlement `
|
||||
-Type ACCESS_ITEM `
|
||||
-Actor null `
|
||||
-Target null `
|
||||
-Stack tpe `
|
||||
-TrackingNumber 63f891e0735f4cc8bf1968144a1e7440 `
|
||||
-IpAddress 52.52.97.85 `
|
||||
-Details 73b65dfbed1842548c207432a18c84b0 `
|
||||
-Attributes {pod=stg03-useast1, org=acme, sourceName=SailPoint} `
|
||||
-Objects null `
|
||||
-Operation REQUEST `
|
||||
-Operation ADD `
|
||||
-Status PASSED `
|
||||
-TechnicalName AUTHENTICATION_REQUEST_PASSED
|
||||
-TechnicalName ENTITLEMENT_ADD_PASSED
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
|
||||
35
docs/tools/sdk/powershell/Reference/V3/Models/EventTarget.md
Normal file
35
docs/tools/sdk/powershell/Reference/V3/Models/EventTarget.md
Normal file
@@ -0,0 +1,35 @@
|
||||
---
|
||||
id: event-target
|
||||
title: EventTarget
|
||||
pagination_label: EventTarget
|
||||
sidebar_label: EventTarget
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'EventTarget', 'EventTarget']
|
||||
slug: /tools/sdk/powershell/v3/models/event-target
|
||||
tags: ['SDK', 'Software Development Kit', 'EventTarget', 'EventTarget']
|
||||
---
|
||||
|
||||
|
||||
# EventTarget
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Name** | **String** | Name of the target, or recipient, of the event. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$EventTarget = Initialize-PSSailpoint.V3EventTarget -Name Carol.Adams
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$EventTarget | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -17,10 +17,12 @@ tags: ['SDK', 'Software Development Kit', 'ExpansionItem', 'ExpansionItem']
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**AccountId** | **String** | The ID of the account | [optional]
|
||||
**Cause** | **String** | | [optional]
|
||||
**Cause** | **String** | Cause of the expansion item. | [optional]
|
||||
**Name** | **String** | The name of the item | [optional]
|
||||
**AttributeRequests** | [**[]AttributeRequest**](attribute-request) | | [optional]
|
||||
**AttributeRequest** | [**AttributeRequest**](attribute-request) | | [optional]
|
||||
**Source** | [**AccountSource**](account-source) | | [optional]
|
||||
**Id** | **String** | ID of the expansion item | [optional]
|
||||
**State** | **String** | State of the expansion item | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
@@ -29,8 +31,10 @@ Name | Type | Description | Notes
|
||||
$ExpansionItem = Initialize-PSSailpoint.V3ExpansionItem -AccountId 2c91808981f58ea601821c3e93482e6f `
|
||||
-Cause Role `
|
||||
-Name smartsheet-role `
|
||||
-AttributeRequests null `
|
||||
-Source null
|
||||
-AttributeRequest null `
|
||||
-Source null `
|
||||
-Id ac2887ffe0e7435a8c18c73f7ae94c7b `
|
||||
-State EXECUTING
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
|
||||
@@ -19,8 +19,8 @@ Name | Type | Description | Notes
|
||||
**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]
|
||||
**Description** | **String** | Description of access item. | [optional]
|
||||
**Type** | **String** | Type of the access item. | [optional]
|
||||
**Source** | [**Reference1**](reference1) | | [optional]
|
||||
**Owner** | [**DisplayReference**](display-reference) | | [optional]
|
||||
**Revocable** | **Boolean** | | [optional]
|
||||
@@ -37,8 +37,8 @@ Name | Type | Description | Notes
|
||||
$IdentityAccess = Initialize-PSSailpoint.V3IdentityAccess -Id 2c91808568c529c60168cca6f90c1313 `
|
||||
-Name John Doe `
|
||||
-DisplayName John Q. Doe `
|
||||
-Type null `
|
||||
-Description null `
|
||||
-Type ROLE `
|
||||
-Source null `
|
||||
-Owner null `
|
||||
-Revocable null `
|
||||
|
||||
@@ -18,7 +18,6 @@ Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | The unique ID of the referenced object. | [required]
|
||||
**Name** | **String** | The human readable name of the referenced object. | [required]
|
||||
**Type** | [**DocumentType**](document-type) | | [required]
|
||||
**DisplayName** | **String** | Identity's display name. | [optional]
|
||||
**FirstName** | **String** | Identity's first name. | [optional]
|
||||
**LastName** | **String** | Identity's last name. | [optional]
|
||||
@@ -36,6 +35,8 @@ Name | Type | Description | Notes
|
||||
**IdentityProfile** | [**IdentityDocumentAllOfIdentityProfile**](identity-document-all-of-identity-profile) | | [optional]
|
||||
**Source** | [**IdentityDocumentAllOfSource**](identity-document-all-of-source) | | [optional]
|
||||
**Attributes** | [**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]
|
||||
**Disabled** | **Boolean** | Indicates whether the identity is disabled. | [optional] [default to $false]
|
||||
**Locked** | **Boolean** | Indicates whether the identity is locked. | [optional] [default to $false]
|
||||
**ProcessingState** | **String** | Identity's processing state. | [optional]
|
||||
**ProcessingDetails** | [**ProcessingDetails**](processing-details) | | [optional]
|
||||
**Accounts** | [**[]BaseAccount**](base-account) | List of accounts associated with the identity. | [optional]
|
||||
@@ -50,6 +51,9 @@ Name | Type | Description | Notes
|
||||
**Owns** | [**[]Owns**](owns) | Access items the identity owns. | [optional]
|
||||
**OwnsCount** | **Int32** | Number of access items the identity owns. | [optional]
|
||||
**Tags** | **[]String** | Tags that have been applied to the object. | [optional]
|
||||
**TagsCount** | **Int32** | Number of tags on the identity. | [optional]
|
||||
**VisibleSegments** | **[]String** | List of segments that the identity is in. | [optional]
|
||||
**VisibleSegmentCount** | **Int32** | Number of segments the identity is in. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
@@ -57,7 +61,6 @@ Name | Type | Description | Notes
|
||||
```powershell
|
||||
$IdentityDocument = Initialize-PSSailpoint.V3IdentityDocument -Id 2c91808568c529c60168cca6f90c1313 `
|
||||
-Name John Doe `
|
||||
-Type null `
|
||||
-DisplayName Carol.Adams `
|
||||
-FirstName Carol `
|
||||
-LastName Adams `
|
||||
@@ -75,7 +78,9 @@ $IdentityDocument = Initialize-PSSailpoint.V3IdentityDocument -Id 2c91808568c52
|
||||
-IdentityProfile null `
|
||||
-Source null `
|
||||
-Attributes {country=US, firstname=Carol, cloudStatus=UNREGISTERED} `
|
||||
-ProcessingState null `
|
||||
-Disabled false `
|
||||
-Locked false `
|
||||
-ProcessingState ERROR `
|
||||
-ProcessingDetails null `
|
||||
-Accounts null `
|
||||
-AccountCount 3 `
|
||||
@@ -88,7 +93,10 @@ $IdentityDocument = Initialize-PSSailpoint.V3IdentityDocument -Id 2c91808568c52
|
||||
-AccessProfileCount 1 `
|
||||
-Owns null `
|
||||
-OwnsCount 5 `
|
||||
-Tags [TAG_1, TAG_2]
|
||||
-Tags [TAG_1, TAG_2] `
|
||||
-TagsCount null `
|
||||
-VisibleSegments [All Employees] `
|
||||
-VisibleSegmentCount 1
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
|
||||
@@ -17,6 +17,7 @@ tags: ['SDK', 'Software Development Kit', 'OriginalRequest', 'OriginalRequest']
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**AccountId** | **String** | Account ID. | [optional]
|
||||
**Result** | [**Result**](result) | | [optional]
|
||||
**AttributeRequests** | [**[]AttributeRequest**](attribute-request) | Attribute changes requested for account. | [optional]
|
||||
**Op** | **String** | Operation used. | [optional]
|
||||
**Source** | [**AccountSource**](account-source) | | [optional]
|
||||
@@ -26,6 +27,7 @@ Name | Type | Description | Notes
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$OriginalRequest = Initialize-PSSailpoint.V3OriginalRequest -AccountId CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com `
|
||||
-Result null `
|
||||
-AttributeRequests null `
|
||||
-Op add `
|
||||
-Source null
|
||||
|
||||
35
docs/tools/sdk/powershell/Reference/V3/Models/Result.md
Normal file
35
docs/tools/sdk/powershell/Reference/V3/Models/Result.md
Normal file
@@ -0,0 +1,35 @@
|
||||
---
|
||||
id: result
|
||||
title: Result
|
||||
pagination_label: Result
|
||||
sidebar_label: Result
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'Result', 'Result']
|
||||
slug: /tools/sdk/powershell/v3/models/result
|
||||
tags: ['SDK', 'Software Development Kit', 'Result', 'Result']
|
||||
---
|
||||
|
||||
|
||||
# Result
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Status** | **String** | Request result status | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$Result = Initialize-PSSailpoint.V3Result -Status Manual Task Created
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$Result | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -16,9 +16,6 @@ tags: ['SDK', 'Software Development Kit', 'RoleDocument', 'RoleDocument']
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | The unique ID of the referenced object. | [required]
|
||||
**Name** | **String** | The human readable name of the referenced object. | [required]
|
||||
**Type** | [**DocumentType**](document-type) | | [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]
|
||||
@@ -26,23 +23,26 @@ Name | Type | Description | Notes
|
||||
**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]
|
||||
**Owner** | [**BaseAccessOwner**](base-access-owner) | | [optional]
|
||||
**Id** | **String** | ID of the role. | [required]
|
||||
**Name** | **String** | Name of the role. | [required]
|
||||
**AccessProfiles** | [**[]BaseAccessProfile**](base-access-profile) | Access profiles included with the role. | [optional]
|
||||
**AccessProfileCount** | **Int32** | Number of access profiles included with the role. | [optional]
|
||||
**Tags** | **[]String** | Tags that have been applied to the object. | [optional]
|
||||
**Segments** | [**[]BaseSegment**](base-segment) | Segments with the role. | [optional]
|
||||
**SegmentCount** | **Int32** | Number of segments with the role. | [optional]
|
||||
**Entitlements** | [**[]BaseEntitlement**](base-entitlement) | Entitlements included with the role. | [optional]
|
||||
**Entitlements** | [**[]RoleDocumentAllOfEntitlements**](role-document-all-of-entitlements) | Entitlements included with the role. | [optional]
|
||||
**EntitlementCount** | **Int32** | Number of entitlements included with the role. | [optional]
|
||||
**Dimensional** | **Boolean** | | [optional] [default to $false]
|
||||
**DimensionSchemaAttributeCount** | **Int32** | Number of dimension attributes included with the role. | [optional]
|
||||
**DimensionSchemaAttributes** | [**[]RoleDocumentAllOfDimensionSchemaAttributes**](role-document-all-of-dimension-schema-attributes) | Dimension attributes included with the role. | [optional]
|
||||
**Dimensions** | [**[]RoleDocumentAllOfDimensions**](role-document-all-of-dimensions) | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$RoleDocument = Initialize-PSSailpoint.V3RoleDocument -Id 2c91808568c529c60168cca6f90c1313 `
|
||||
-Name John Doe `
|
||||
-Type null `
|
||||
-Description The admin role `
|
||||
$RoleDocument = Initialize-PSSailpoint.V3RoleDocument -Description Admin access `
|
||||
-Created 2018-06-25T20:22:28.104Z `
|
||||
-Modified 2018-06-25T20:22:28.104Z `
|
||||
-Synced 2018-06-25T20:22:33.104Z `
|
||||
@@ -50,13 +50,19 @@ $RoleDocument = Initialize-PSSailpoint.V3RoleDocument -Id 2c91808568c529c60168c
|
||||
-Requestable true `
|
||||
-RequestCommentsRequired false `
|
||||
-Owner null `
|
||||
-Id 2c91808375d8e80a0175e1f88a575222 `
|
||||
-Name Branch Manager Access `
|
||||
-AccessProfiles null `
|
||||
-AccessProfileCount 1 `
|
||||
-Tags [TAG_1, TAG_2] `
|
||||
-Segments null `
|
||||
-SegmentCount 1 `
|
||||
-Entitlements null `
|
||||
-EntitlementCount 3
|
||||
-EntitlementCount 3 `
|
||||
-Dimensional false `
|
||||
-DimensionSchemaAttributeCount 3 `
|
||||
-DimensionSchemaAttributes null `
|
||||
-Dimensions null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
|
||||
@@ -0,0 +1,39 @@
|
||||
---
|
||||
id: role-document-all-of-dimension-schema-attributes
|
||||
title: RoleDocumentAllOfDimensionSchemaAttributes
|
||||
pagination_label: RoleDocumentAllOfDimensionSchemaAttributes
|
||||
sidebar_label: RoleDocumentAllOfDimensionSchemaAttributes
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'RoleDocumentAllOfDimensionSchemaAttributes', 'RoleDocumentAllOfDimensionSchemaAttributes']
|
||||
slug: /tools/sdk/powershell/v3/models/role-document-all-of-dimension-schema-attributes
|
||||
tags: ['SDK', 'Software Development Kit', 'RoleDocumentAllOfDimensionSchemaAttributes', 'RoleDocumentAllOfDimensionSchemaAttributes']
|
||||
---
|
||||
|
||||
|
||||
# RoleDocumentAllOfDimensionSchemaAttributes
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Derived** | **Boolean** | | [optional] [default to $true]
|
||||
**DisplayName** | **String** | Displayname of the dimension attribute. | [optional]
|
||||
**Name** | **String** | Name of the dimension attribute. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$RoleDocumentAllOfDimensionSchemaAttributes = Initialize-PSSailpoint.V3RoleDocumentAllOfDimensionSchemaAttributes -Derived true `
|
||||
-DisplayName Department `
|
||||
-Name department
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$RoleDocumentAllOfDimensionSchemaAttributes | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
id: role-document-all-of-dimensions
|
||||
title: RoleDocumentAllOfDimensions
|
||||
pagination_label: RoleDocumentAllOfDimensions
|
||||
sidebar_label: RoleDocumentAllOfDimensions
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'RoleDocumentAllOfDimensions', 'RoleDocumentAllOfDimensions']
|
||||
slug: /tools/sdk/powershell/v3/models/role-document-all-of-dimensions
|
||||
tags: ['SDK', 'Software Development Kit', 'RoleDocumentAllOfDimensions', 'RoleDocumentAllOfDimensions']
|
||||
---
|
||||
|
||||
|
||||
# RoleDocumentAllOfDimensions
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Id** | **String** | Unique ID of the dimension. | [optional]
|
||||
**Name** | **String** | Name of the dimension. | [optional]
|
||||
**Description** | **String** | Description of the dimension. | [optional]
|
||||
**Entitlements** | [**[]RoleDocumentAllOfEntitlements1**](role-document-all-of-entitlements1) | Entitlements included with the role. | [optional]
|
||||
**AccessProfiles** | [**[]BaseAccessProfile**](base-access-profile) | Access profiles included in the dimension. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$RoleDocumentAllOfDimensions = Initialize-PSSailpoint.V3RoleDocumentAllOfDimensions -Id b3c28992ba964a40a7598978139d1ced `
|
||||
-Name Manager Austin Branch `
|
||||
-Description Managers located at the Austin branch `
|
||||
-Entitlements null `
|
||||
-AccessProfiles null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$RoleDocumentAllOfDimensions | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,53 @@
|
||||
---
|
||||
id: role-document-all-of-entitlements
|
||||
title: RoleDocumentAllOfEntitlements
|
||||
pagination_label: RoleDocumentAllOfEntitlements
|
||||
sidebar_label: RoleDocumentAllOfEntitlements
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'RoleDocumentAllOfEntitlements', 'RoleDocumentAllOfEntitlements']
|
||||
slug: /tools/sdk/powershell/v3/models/role-document-all-of-entitlements
|
||||
tags: ['SDK', 'Software Development Kit', 'RoleDocumentAllOfEntitlements', 'RoleDocumentAllOfEntitlements']
|
||||
---
|
||||
|
||||
|
||||
# RoleDocumentAllOfEntitlements
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**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]
|
||||
**SourceSchemaObjectType** | **String** | Schema objectType. | [optional]
|
||||
**Hash** | **String** | Read-only calculated hash value of an entitlement. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$RoleDocumentAllOfEntitlements = Initialize-PSSailpoint.V3RoleDocumentAllOfEntitlements -HasPermissions false `
|
||||
-Description Cloud engineering `
|
||||
-Attribute memberOf `
|
||||
-Value CN=Cloud Engineering,DC=sailpoint,DC=COM `
|
||||
-Schema group `
|
||||
-Privileged false `
|
||||
-Id 2c918084575812550157589064f33b89 `
|
||||
-Name CN=Cloud Engineering,DC=sailpoint,DC=COM `
|
||||
-SourceSchemaObjectType group `
|
||||
-Hash c6fab95235584cca98a454a2f51e5683bc77d6a0
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$RoleDocumentAllOfEntitlements | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,53 @@
|
||||
---
|
||||
id: role-document-all-of-entitlements1
|
||||
title: RoleDocumentAllOfEntitlements1
|
||||
pagination_label: RoleDocumentAllOfEntitlements1
|
||||
sidebar_label: RoleDocumentAllOfEntitlements1
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'RoleDocumentAllOfEntitlements1', 'RoleDocumentAllOfEntitlements1']
|
||||
slug: /tools/sdk/powershell/v3/models/role-document-all-of-entitlements1
|
||||
tags: ['SDK', 'Software Development Kit', 'RoleDocumentAllOfEntitlements1', 'RoleDocumentAllOfEntitlements1']
|
||||
---
|
||||
|
||||
|
||||
# RoleDocumentAllOfEntitlements1
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**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]
|
||||
**SourceSchemaObjectType** | **String** | Schema objectType. | [optional]
|
||||
**Hash** | **String** | Read-only calculated hash value of an entitlement. | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$RoleDocumentAllOfEntitlements1 = Initialize-PSSailpoint.V3RoleDocumentAllOfEntitlements1 -HasPermissions false `
|
||||
-Description Cloud engineering `
|
||||
-Attribute memberOf `
|
||||
-Value CN=Cloud Engineering,DC=sailpoint,DC=COM `
|
||||
-Schema group `
|
||||
-Privileged false `
|
||||
-Id 2c918084575812550157589064f33b89 `
|
||||
-Name CN=Cloud Engineering,DC=sailpoint,DC=COM `
|
||||
-SourceSchemaObjectType group `
|
||||
-Hash c6fab95235584cca98a454a2f51e5683bc77d6a0
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$RoleDocumentAllOfEntitlements1 | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -19,8 +19,8 @@ Name | Type | Description | Notes
|
||||
**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]
|
||||
**Description** | **String** | Description of access item. | [optional]
|
||||
**Type** | **String** | Type of the access item. | [optional]
|
||||
**Owner** | [**DisplayReference**](display-reference) | | [optional]
|
||||
**Disabled** | **Boolean** | | [optional]
|
||||
**Revocable** | **Boolean** | | [optional]
|
||||
@@ -32,8 +32,8 @@ Name | Type | Description | Notes
|
||||
$RoleSummary = Initialize-PSSailpoint.V3RoleSummary -Id 2c91808568c529c60168cca6f90c1313 `
|
||||
-Name John Doe `
|
||||
-DisplayName John Q. Doe `
|
||||
-Type null `
|
||||
-Description null `
|
||||
-Type ROLE `
|
||||
-Owner null `
|
||||
-Disabled null `
|
||||
-Revocable null
|
||||
|
||||
Reference in New Issue
Block a user