Skip to content

Commit

Permalink
Update to powershell SDK docs: 13400083192
Browse files Browse the repository at this point in the history
  • Loading branch information
developer-relations-sp committed Feb 18, 2025
1 parent 63e80b2 commit d8aeab4
Show file tree
Hide file tree
Showing 78 changed files with 1,364 additions and 340 deletions.
4 changes: 1 addition & 3 deletions docs/tools/sdk/powershell/Reference/V2024/Models/Access.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
```

Expand Down
41 changes: 41 additions & 0 deletions docs/tools/sdk/powershell/Reference/V2024/Models/AccessApps.md
Original file line number Diff line number Diff line change
@@ -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]](#)

Original file line number Diff line number Diff line change
@@ -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 [email protected]
```

- Convert the resource to JSON
```powershell
$AccessAppsOwner | ConvertTo-JSON
```


[[Back to top]](#)

Original file line number Diff line number Diff line change
Expand Up @@ -16,41 +16,45 @@ 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]
**Synced** | **System.DateTime** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional]
**Enabled** | **Boolean** | Indicates whether the access item is currently enabled. | [optional] [default to $false]
**Requestable** | **Boolean** | Indicates whether the access item can be requested. | [optional] [default to $true]
**RequestCommentsRequired** | **Boolean** | Indicates whether comments are required for requests to access the item. | [optional] [default to $false]
**Owner** | [**BaseAccessAllOfOwner**](base-access-all-of-owner) | | [optional]
**Type** | **Enum** [ "accessprofile", "accountactivity", "account", "aggregation", "entitlement", "event", "identity", "role" ] | Access profile's document type. This enum represents the currently supported document types. Additional values may be added in the future without notice. | [required]
**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 `
-Enabled true `
-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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand All @@ -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 `
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand All @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand All @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand All @@ -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 `
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand All @@ -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 `
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
@@ -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]](#)

10 changes: 5 additions & 5 deletions docs/tools/sdk/powershell/Reference/V2024/Models/Approval1.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@ 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

- Prepare the resource
```powershell
$AttributeRequest = Initialize-PSSailpoint.V2024AttributeRequest -Name groups `
-Op Add `
-Value 3203537556531076
-Value null
```

- Convert the resource to JSON
Expand Down
Loading

0 comments on commit d8aeab4

Please sign in to comment.