Skip to content

Commit d8aeab4

Browse files
developer-relations-spdeveloper-relations-sp
committed
Update to powershell SDK docs: 13400083192
1 parent 63e80b2 commit d8aeab4

File tree

78 files changed

+1364
-340
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

78 files changed

+1364
-340
lines changed

‎docs/tools/sdk/powershell/Reference/V2024/Models/Access.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,7 @@ Name | Type | Description | Notes
1919
**Id** | **String** | The unique ID of the referenced object. | [optional]
2020
**Name** | **String** | The human readable name of the referenced object. | [optional]
2121
**DisplayName** | **String** | | [optional]
22-
**Type** | [**DtoType**](dto-type) | | [optional]
23-
**Description** | **String** | | [optional]
22+
**Description** | **String** | Description of access item. | [optional]
2423

2524
## Examples
2625

@@ -29,7 +28,6 @@ Name | Type | Description | Notes
2928
$Access = Initialize-PSSailpoint.V2024Access -Id 2c91808568c529c60168cca6f90c1313 `
3029
-Name John Doe `
3130
-DisplayName John Q. Doe `
32-
-Type null `
3331
-Description null
3432
```
3533

‎docs/tools/sdk/powershell/Reference/V2024/Models/AccessApps.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
id: v2024-access-apps
3+
title: AccessApps
4+
pagination_label: AccessApps
5+
sidebar_label: AccessApps
6+
sidebar_class_name: powershellsdk
7+
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessApps', 'V2024AccessApps']
8+
slug: /tools/sdk/powershell/v2024/models/access-apps
9+
tags: ['SDK', 'Software Development Kit', 'AccessApps', 'V2024AccessApps']
10+
---
11+
12+
13+
# AccessApps
14+
15+
## Properties
16+
17+
Name | Type | Description | Notes
18+
------------ | ------------- | ------------- | -------------
19+
**Id** | **String** | The unique ID of the referenced object. | [optional]
20+
**Name** | **String** | Name of application | [optional]
21+
**Description** | **String** | Description of application. | [optional]
22+
**Owner** | [**AccessAppsOwner**](access-apps-owner) | | [optional]
23+
24+
## Examples
25+
26+
- Prepare the resource
27+
```powershell
28+
$AccessApps = Initialize-PSSailpoint.V2024AccessApps -Id 2c91808568c529c60168cca6f90c1313 `
29+
-Name Travel and Expense `
30+
-Description Travel and Expense Application `
31+
-Owner null
32+
```
33+
34+
- Convert the resource to JSON
35+
```powershell
36+
$AccessApps | ConvertTo-JSON
37+
```
38+
39+
40+
[[Back to top]](#)
41+

‎docs/tools/sdk/powershell/Reference/V2024/Models/AccessAppsOwner.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
id: v2024-access-apps-owner
3+
title: AccessAppsOwner
4+
pagination_label: AccessAppsOwner
5+
sidebar_label: AccessAppsOwner
6+
sidebar_class_name: powershellsdk
7+
keywords: ['powershell', 'PowerShell', 'sdk', 'AccessAppsOwner', 'V2024AccessAppsOwner']
8+
slug: /tools/sdk/powershell/v2024/models/access-apps-owner
9+
tags: ['SDK', 'Software Development Kit', 'AccessAppsOwner', 'V2024AccessAppsOwner']
10+
---
11+
12+
13+
# AccessAppsOwner
14+
15+
## Properties
16+
17+
Name | Type | Description | Notes
18+
------------ | ------------- | ------------- | -------------
19+
**Type** | **Enum** [ "IDENTITY" ] | Owner's DTO type. | [optional]
20+
**Id** | **String** | Owner's identity ID. | [optional]
21+
**Name** | **String** | Owner's display name. | [optional]
22+
**Email** | **String** | Owner's email. | [optional]
23+
24+
## Examples
25+
26+
- Prepare the resource
27+
```powershell
28+
$AccessAppsOwner = Initialize-PSSailpoint.V2024AccessAppsOwner -Type IDENTITY `
29+
-Id 2c9180a46faadee4016fb4e018c20639 `
30+
-Name John Doe `
31+
-Email [email protected]
32+
```
33+
34+
- Convert the resource to JSON
35+
```powershell
36+
$AccessAppsOwner | ConvertTo-JSON
37+
```
38+
39+
40+
[[Back to top]](#)
41+

‎docs/tools/sdk/powershell/Reference/V2024/Models/AccessProfileDocument.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,41 +16,45 @@ tags: ['SDK', 'Software Development Kit', 'AccessProfileDocument', 'V2024AccessP
1616

1717
Name | Type | Description | Notes
1818
------------ | ------------- | ------------- | -------------
19-
**Id** | **String** | Access profile's ID. | [required]
20-
**Name** | **String** | Access profile's name. | [required]
2119
**Description** | **String** | Access item's description. | [optional]
2220
**Created** | **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
2321
**Modified** | **System.DateTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional]
2422
**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]
2523
**Enabled** | **Boolean** | Indicates whether the access item is currently enabled. | [optional] [default to $false]
2624
**Requestable** | **Boolean** | Indicates whether the access item can be requested. | [optional] [default to $true]
2725
**RequestCommentsRequired** | **Boolean** | Indicates whether comments are required for requests to access the item. | [optional] [default to $false]
28-
**Owner** | [**BaseAccessAllOfOwner**](base-access-all-of-owner) | | [optional]
29-
**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]
26+
**Owner** | [**BaseAccessOwner**](base-access-owner) | | [optional]
27+
**Id** | **String** | Access profile's ID. | [required]
28+
**Name** | **String** | Access profile's name. | [required]
3029
**Source** | [**AccessProfileDocumentAllOfSource**](access-profile-document-all-of-source) | | [optional]
3130
**Entitlements** | [**[]BaseEntitlement**](base-entitlement) | Entitlements the access profile has access to. | [optional]
3231
**EntitlementCount** | **Int32** | Number of entitlements. | [optional]
32+
**Segments** | [**[]BaseSegment**](base-segment) | Segments with the access profile. | [optional]
33+
**SegmentCount** | **Int32** | Number of segments with the access profile. | [optional]
3334
**Tags** | **[]String** | Tags that have been applied to the object. | [optional]
35+
**Apps** | [**[]AccessApps**](access-apps) | Applications with the access profile | [optional]
3436

3537
## Examples
3638

3739
- Prepare the resource
3840
```powershell
39-
$AccessProfileDocument = Initialize-PSSailpoint.V2024AccessProfileDocument -Id 2c9180825a6c1adc015a71c9023f0818 `
40-
-Name Cloud Eng `
41-
-Description The admin role `
41+
$AccessProfileDocument = Initialize-PSSailpoint.V2024AccessProfileDocument -Description Admin access `
4242
-Created 2018-06-25T20:22:28.104Z `
4343
-Modified 2018-06-25T20:22:28.104Z `
4444
-Synced 2018-06-25T20:22:33.104Z `
4545
-Enabled true `
4646
-Requestable true `
4747
-RequestCommentsRequired false `
4848
-Owner null `
49-
-Type accessprofile `
49+
-Id 2c9180825a6c1adc015a71c9023f0818 `
50+
-Name Cloud Eng `
5051
-Source null `
5152
-Entitlements null `
5253
-EntitlementCount 5 `
53-
-Tags [TAG_1, TAG_2]
54+
-Segments null `
55+
-SegmentCount 1 `
56+
-Tags [TAG_1, TAG_2] `
57+
-Apps null
5458
```
5559

5660
- Convert the resource to JSON

‎docs/tools/sdk/powershell/Reference/V2024/Models/AccessProfileEntitlement.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ Name | Type | Description | Notes
1919
**Id** | **String** | The unique ID of the referenced object. | [optional]
2020
**Name** | **String** | The human readable name of the referenced object. | [optional]
2121
**DisplayName** | **String** | | [optional]
22-
**Type** | [**DtoType**](dto-type) | | [optional]
23-
**Description** | **String** | | [optional]
22+
**Description** | **String** | Description of access item. | [optional]
2423
**Source** | [**Reference1**](reference1) | | [optional]
24+
**Type** | **String** | Type of the access item. | [optional]
2525
**Privileged** | **Boolean** | | [optional]
2626
**Attribute** | **String** | | [optional]
2727
**Value** | **String** | | [optional]
@@ -34,9 +34,9 @@ Name | Type | Description | Notes
3434
$AccessProfileEntitlement = Initialize-PSSailpoint.V2024AccessProfileEntitlement -Id 2c91808568c529c60168cca6f90c1313 `
3535
-Name John Doe `
3636
-DisplayName John Q. Doe `
37-
-Type null `
3837
-Description null `
3938
-Source null `
39+
-Type ENTITLEMENT `
4040
-Privileged false `
4141
-Attribute memberOf `
4242
-Value CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com `

‎docs/tools/sdk/powershell/Reference/V2024/Models/AccessProfileRole.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ Name | Type | Description | Notes
1919
**Id** | **String** | The unique ID of the referenced object. | [optional]
2020
**Name** | **String** | The human readable name of the referenced object. | [optional]
2121
**DisplayName** | **String** | | [optional]
22-
**Type** | [**DtoType**](dto-type) | | [optional]
23-
**Description** | **String** | | [optional]
22+
**Description** | **String** | Description of access item. | [optional]
23+
**Type** | **String** | Type of the access item. | [optional]
2424
**Owner** | [**DisplayReference**](display-reference) | | [optional]
2525
**Disabled** | **Boolean** | | [optional]
2626
**Revocable** | **Boolean** | | [optional]
@@ -32,8 +32,8 @@ Name | Type | Description | Notes
3232
$AccessProfileRole = Initialize-PSSailpoint.V2024AccessProfileRole -Id 2c91808568c529c60168cca6f90c1313 `
3333
-Name John Doe `
3434
-DisplayName John Q. Doe `
35-
-Type null `
3635
-Description null `
36+
-Type ROLE `
3737
-Owner null `
3838
-Disabled null `
3939
-Revocable null

‎docs/tools/sdk/powershell/Reference/V2024/Models/AccessProfileSummary.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ Name | Type | Description | Notes
1919
**Id** | **String** | The unique ID of the referenced object. | [optional]
2020
**Name** | **String** | The human readable name of the referenced object. | [optional]
2121
**DisplayName** | **String** | | [optional]
22-
**Type** | [**DtoType**](dto-type) | | [optional]
23-
**Description** | **String** | | [optional]
22+
**Description** | **String** | Description of access item. | [optional]
23+
**Type** | **String** | Type of the access item. | [optional]
2424
**Source** | [**Reference1**](reference1) | | [optional]
2525
**Owner** | [**DisplayReference**](display-reference) | | [optional]
2626
**Revocable** | **Boolean** | | [optional]
@@ -32,8 +32,8 @@ Name | Type | Description | Notes
3232
$AccessProfileSummary = Initialize-PSSailpoint.V2024AccessProfileSummary -Id 2c91808568c529c60168cca6f90c1313 `
3333
-Name John Doe `
3434
-DisplayName John Q. Doe `
35-
-Type null `
3635
-Description null `
36+
-Type ACCESS_PROFILE `
3737
-Source null `
3838
-Owner null `
3939
-Revocable true

‎docs/tools/sdk/powershell/Reference/V2024/Models/AccountActivityDocument.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,15 @@ tags: ['SDK', 'Software Development Kit', 'AccountActivityDocument', 'V2024Accou
1616

1717
Name | Type | Description | Notes
1818
------------ | ------------- | ------------- | -------------
19-
**Id** | **String** | | [required]
20-
**Name** | **String** | | [required]
21-
**Type** | [**DocumentType**](document-type) | | [required]
19+
**Id** | **String** | ID of account activity. | [optional]
2220
**Action** | **String** | Type of action performed in the activity. | [optional]
2321
**Created** | **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
2422
**Modified** | **System.DateTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional]
23+
**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]
2524
**Stage** | **String** | Activity's current stage. | [optional]
26-
**Origin** | **String** | Activity's origin. | [optional]
2725
**Status** | **String** | Activity's current status. | [optional]
28-
**Requester** | [**AccountSource**](account-source) | | [optional]
29-
**Recipient** | [**AccountSource**](account-source) | | [optional]
26+
**Requester** | [**ActivityIdentity**](activity-identity) | | [optional]
27+
**Recipient** | [**ActivityIdentity**](activity-identity) | | [optional]
3028
**TrackingNumber** | **String** | Account activity's tracking number. | [optional]
3129
**Errors** | **[]String** | Errors provided by the source while completing account actions. | [optional]
3230
**Warnings** | **[]String** | Warnings provided by the source while completing account actions. | [optional]
@@ -41,13 +39,11 @@ Name | Type | Description | Notes
4139
- Prepare the resource
4240
```powershell
4341
$AccountActivityDocument = Initialize-PSSailpoint.V2024AccountActivityDocument -Id 2c91808375d8e80a0175e1f88a575222 `
44-
-Name john.doe `
45-
-Type null `
4642
-Action Identity Refresh. `
4743
-Created 2018-06-25T20:22:28.104Z `
4844
-Modified 2018-06-25T20:22:28.104Z `
45+
-Synced 2018-06-25T20:22:28.104Z `
4946
-Stage Completed `
50-
-Origin null `
5147
-Status Complete `
5248
-Requester null `
5349
-Recipient null `

‎docs/tools/sdk/powershell/Reference/V2024/Models/AccountActivitySearchedItem.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,15 @@ tags: ['SDK', 'Software Development Kit', 'AccountActivitySearchedItem', 'V2024A
1616

1717
Name | Type | Description | Notes
1818
------------ | ------------- | ------------- | -------------
19-
**Id** | **String** | | [required]
20-
**Name** | **String** | | [required]
21-
**Type** | [**DocumentType**](document-type) | | [required]
19+
**Id** | **String** | ID of account activity. | [optional]
2220
**Action** | **String** | Type of action performed in the activity. | [optional]
2321
**Created** | **System.DateTime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
2422
**Modified** | **System.DateTime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional]
23+
**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]
2524
**Stage** | **String** | Activity's current stage. | [optional]
26-
**Origin** | **String** | Activity's origin. | [optional]
2725
**Status** | **String** | Activity's current status. | [optional]
28-
**Requester** | [**AccountSource**](account-source) | | [optional]
29-
**Recipient** | [**AccountSource**](account-source) | | [optional]
26+
**Requester** | [**ActivityIdentity**](activity-identity) | | [optional]
27+
**Recipient** | [**ActivityIdentity**](activity-identity) | | [optional]
3028
**TrackingNumber** | **String** | Account activity's tracking number. | [optional]
3129
**Errors** | **[]String** | Errors provided by the source while completing account actions. | [optional]
3230
**Warnings** | **[]String** | Warnings provided by the source while completing account actions. | [optional]
@@ -41,13 +39,11 @@ Name | Type | Description | Notes
4139
- Prepare the resource
4240
```powershell
4341
$AccountActivitySearchedItem = Initialize-PSSailpoint.V2024AccountActivitySearchedItem -Id 2c91808375d8e80a0175e1f88a575222 `
44-
-Name john.doe `
45-
-Type null `
4642
-Action Identity Refresh. `
4743
-Created 2018-06-25T20:22:28.104Z `
4844
-Modified 2018-06-25T20:22:28.104Z `
45+
-Synced 2018-06-25T20:22:28.104Z `
4946
-Stage Completed `
50-
-Origin null `
5147
-Status Complete `
5248
-Requester null `
5349
-Recipient null `

‎docs/tools/sdk/powershell/Reference/V2024/Models/AccountRequestResult.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccountRequestResult', 'V2024AccountR
1616

1717
Name | Type | Description | Notes
1818
------------ | ------------- | ------------- | -------------
19-
**Errors** | **[]String** | | [optional]
19+
**Errors** | **[]String** | Error message. | [optional]
2020
**Status** | **String** | The status of the account request | [optional]
21-
**TicketId** | **String** | | [optional]
21+
**TicketId** | **String** | ID of associated ticket. | [optional]
2222

2323
## Examples
2424

0 commit comments

Comments
 (0)