LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-07 04:19:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update PowerShell SDK docs: 15141274669

Browse Source
This commit is contained in:
developer-relations-sp
2025-05-20 15:12:17 +00:00
parent c4f4d72fc8
commit 8df9b19e41
308 changed files with 6591 additions and 5586 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessModelMetadataApi.md
View File

@@ -27,10 +27,10 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-BetaAccessModelMetadataAttribute**](#get-access-model-metadata-attribute) | **GET** `/access-model-metadata/attributes/{key}` | Get Access Model Metadata Attribute
[**Get-BetaAccessModelMetadataAttributeValue**](#get-access-model-metadata-attribute-value) | **GET** `/access-model-metadata/attributes/{key}/values/{value}` | Get Access Model Metadata Value
[**Get-BetaAccessModelMetadataAttribute**](#list-access-model-metadata-attribute) | **GET** `/access-model-metadata/attributes` | List Access Model Metadata Attributes
[**Get-BetaAccessModelMetadataAttributeValue**](#list-access-model-metadata-attribute-value) | **GET** `/access-model-metadata/attributes/{key}/values` | List Access Model Metadata Values
[**Get-BetaAccessModelMetadataAttribute**](#get-access-model-metadata-attribute) | **GET** `/access-model-metadata/attributes/{key}` | Get access model metadata attribute
[**Get-BetaAccessModelMetadataAttributeValue**](#get-access-model-metadata-attribute-value) | **GET** `/access-model-metadata/attributes/{key}/values/{value}` | Get access model metadata value
[**Get-BetaAccessModelMetadataAttribute**](#list-access-model-metadata-attribute) | **GET** `/access-model-metadata/attributes` | List access model metadata attributes
[**Get-BetaAccessModelMetadataAttributeValue**](#list-access-model-metadata-attribute-value) | **GET** `/access-model-metadata/attributes/{key}/values` | List access model metadata values
## get-access-model-metadata-attribute
@@ -64,7 +64,7 @@ Code | Description | Data Type
```powershell
$Key = "iscPrivacy" # String | Technical name of the Attribute.
# Get Access Model Metadata Attribute
# Get access model metadata attribute
try {
Get-BetaAccessModelMetadataAttribute -Key $Key
@@ -111,7 +111,7 @@ Code | Description | Data Type
$Key = "iscPrivacy" # String | Technical name of the Attribute.
$Value = "public" # String | Technical name of the Attribute value.
# Get Access Model Metadata Value
# Get access model metadata value
try {
Get-BetaAccessModelMetadataAttributeValue -Key $Key -Value $Value
@@ -156,7 +156,7 @@ Code | Description | Data Type
```powershell
$Filters = 'name eq "Privacy"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional)
# List Access Model Metadata Attributes
# List access model metadata attributes
try {
Get-BetaAccessModelMetadataAttribute
@@ -201,7 +201,7 @@ Code | Description | Data Type
```powershell
$Key = "iscPrivacy" # String | Technical name of the Attribute.
# List Access Model Metadata Values
# List access model metadata values
try {
Get-BetaAccessModelMetadataAttributeValue -Key $Key

32
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessProfilesApi.md
View File

@@ -51,14 +51,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-BetaAccessProfile**](#create-access-profile) | **POST** `/access-profiles` | Create Access Profile
[**Remove-BetaAccessProfile**](#delete-access-profile) | **DELETE** `/access-profiles/{id}` | Delete the specified Access Profile
[**Remove-BetaAccessProfilesInBulk**](#delete-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-delete` | Delete Access Profile(s)
[**Get-BetaAccessProfile**](#get-access-profile) | **GET** `/access-profiles/{id}` | Get an Access Profile
[**Get-BetaAccessProfileEntitlements**](#get-access-profile-entitlements) | **GET** `/access-profiles/{id}/entitlements` | List Access Profile's Entitlements
[**Get-BetaAccessProfiles**](#list-access-profiles) | **GET** `/access-profiles` | List Access Profiles
[**Update-BetaAccessProfile**](#patch-access-profile) | **PATCH** `/access-profiles/{id}` | Patch a specified Access Profile
[**Update-BetaAccessProfilesInBulk**](#update-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-update-requestable` | Update Access Profile(s) requestable field.
[**New-BetaAccessProfile**](#create-access-profile) | **POST** `/access-profiles` | Create access profile
[**Remove-BetaAccessProfile**](#delete-access-profile) | **DELETE** `/access-profiles/{id}` | Delete the specified access profile
[**Remove-BetaAccessProfilesInBulk**](#delete-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-delete` | Delete access profile(s)
[**Get-BetaAccessProfile**](#get-access-profile) | **GET** `/access-profiles/{id}` | Get an access profile
[**Get-BetaAccessProfileEntitlements**](#get-access-profile-entitlements) | **GET** `/access-profiles/{id}/entitlements` | List access profile's entitlements
[**Get-BetaAccessProfiles**](#list-access-profiles) | **GET** `/access-profiles` | List access profiles
[**Update-BetaAccessProfile**](#patch-access-profile) | **PATCH** `/access-profiles/{id}` | Patch a specified access profile
[**Update-BetaAccessProfilesInBulk**](#update-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-update-requestable` | Update access profile(s) requestable field.
## create-access-profile
@@ -180,7 +180,7 @@ $AccessProfile = @"{
"requestable" : true
}"@
# Create Access Profile
# Create access profile
try {
$Result = ConvertFrom-JsonToAccessProfile -Json $AccessProfile
@@ -230,7 +230,7 @@ Code | Description | Data Type
```powershell
$Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to delete
# Delete the specified Access Profile
# Delete the specified access profile
try {
Remove-BetaAccessProfile -Id $Id
@@ -282,7 +282,7 @@ $AccessProfileBulkDeleteRequest = @"{
"bestEffortOnly" : true
}"@
# Delete Access Profile(s)
# Delete access profile(s)
try {
$Result = ConvertFrom-JsonToAccessProfileBulkDeleteRequest -Json $AccessProfileBulkDeleteRequest
@@ -328,7 +328,7 @@ Code | Description | Data Type
```powershell
$Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Access Profile
# Get an Access Profile
# Get an access profile
try {
Get-BetaAccessProfile -Id $Id
@@ -384,7 +384,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Filters = 'attribute eq "memberOf"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional)
$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional)
# List Access Profile's Entitlements
# List access profile's entitlements
try {
Get-BetaAccessProfileEntitlements -Id $Id
@@ -444,7 +444,7 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de
$ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional)
$IncludeUnsegmented = $false # Boolean | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to $true)
# List Access Profiles
# List access profiles
try {
Get-BetaAccessProfiles
@@ -501,7 +501,7 @@ $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Access Profile to
}"@ # JsonPatchOperation[] |
# Patch a specified Access Profile
# Patch a specified access profile
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
@@ -555,7 +555,7 @@ Code | Description | Data Type
$AccessProfileBulkUpdateRequestInner = @"[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]"@ # AccessProfileBulkUpdateRequestInner[] |
# Update Access Profile(s) requestable field.
# Update access profile(s) requestable field.
try {
$Result = ConvertFrom-JsonToAccessProfileBulkUpdateRequestInner -Json $AccessProfileBulkUpdateRequestInner

24
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestApprovalsApi.md
View File

@@ -34,12 +34,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Approve-BetaAccessRequest**](#approve-access-request) | **POST** `/access-request-approvals/{approvalId}/approve` | Approve Access Request Approval
[**Invoke-BetaForwardAccessRequest**](#forward-access-request) | **POST** `/access-request-approvals/{approvalId}/forward` | Forward Access Request Approval
[**Get-BetaAccessRequestApprovalSummary**](#get-access-request-approval-summary) | **GET** `/access-request-approvals/approval-summary` | Get Access Requests Approvals Number
[**Get-BetaCompletedApprovals**](#list-completed-approvals) | **GET** `/access-request-approvals/completed` | Completed Access Request Approvals List
[**Get-BetaPendingApprovals**](#list-pending-approvals) | **GET** `/access-request-approvals/pending` | Pending Access Request Approvals List
[**Deny-BetaAccessRequest**](#reject-access-request) | **POST** `/access-request-approvals/{approvalId}/reject` | Reject Access Request Approval
[**Approve-BetaAccessRequest**](#approve-access-request) | **POST** `/access-request-approvals/{approvalId}/approve` | Approve access request approval
[**Invoke-BetaForwardAccessRequest**](#forward-access-request) | **POST** `/access-request-approvals/{approvalId}/forward` | Forward access request approval
[**Get-BetaAccessRequestApprovalSummary**](#get-access-request-approval-summary) | **GET** `/access-request-approvals/approval-summary` | Get access requests approvals number
[**Get-BetaCompletedApprovals**](#list-completed-approvals) | **GET** `/access-request-approvals/completed` | Completed access request approvals list
[**Get-BetaPendingApprovals**](#list-pending-approvals) | **GET** `/access-request-approvals/pending` | Pending access request approvals list
[**Deny-BetaAccessRequest**](#reject-access-request) | **POST** `/access-request-approvals/{approvalId}/reject` | Reject access request approval
## approve-access-request
@@ -84,7 +84,7 @@ $CommentDto = @"{
"comment" : "This is a comment."
}"@
# Approve Access Request Approval
# Approve access request approval
try {
$Result = ConvertFrom-JsonToCommentDto -Json $CommentDto
@@ -136,7 +136,7 @@ $ForwardApprovalDto = @"{
"comment" : "comment"
}"@
# Forward Access Request Approval
# Forward access request approval
try {
$Result = ConvertFrom-JsonToForwardApprovalDto -Json $ForwardApprovalDto
@@ -184,7 +184,7 @@ Code | Description | Data Type
$OwnerId = "2c91808568c529c60168cca6f90c1313" # String | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional)
$FromDate = "from-date=2020-03-19T19:59:11Z" # String | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional)
# Get Access Requests Approvals Number
# Get access requests approvals number
try {
Get-BetaAccessRequestApprovalSummary
@@ -238,7 +238,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Filters = 'MyFilters' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **requestedFor.id**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, sw* (optional)
$Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional)
# Completed Access Request Approvals List
# Completed access request approvals list
try {
Get-BetaCompletedApprovals
@@ -292,7 +292,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Filters = 'MyFilters' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **requestedFor.id**: *eq, in* **modified**: *gt, lt, ge, le, eq, in* (optional)
$Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional)
# Pending Access Request Approvals List
# Pending access request approvals list
try {
Get-BetaPendingApprovals
@@ -348,7 +348,7 @@ $CommentDto = @"{
"comment" : "This is a comment."
}"@
# Reject Access Request Approval
# Reject access request approval
try {
$Result = ConvertFrom-JsonToCommentDto -Json $CommentDto

24
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccessRequestsApi.md
View File

@@ -32,12 +32,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Suspend-BetaAccessRequest**](#cancel-access-request) | **POST** `/access-requests/cancel` | Cancel Access Request
[**Close-BetaAccessRequest**](#close-access-request) | **POST** `/access-requests/close` | Close Access Request
[**New-BetaAccessRequest**](#create-access-request) | **POST** `/access-requests` | Submit Access Request
[**Get-BetaAccessRequestConfig**](#get-access-request-config) | **GET** `/access-request-config` | Get Access Request Configuration
[**Get-BetaAccessRequestStatus**](#list-access-request-status) | **GET** `/access-request-status` | Access Request Status
[**Set-BetaAccessRequestConfig**](#set-access-request-config) | **PUT** `/access-request-config` | Update Access Request Configuration
[**Suspend-BetaAccessRequest**](#cancel-access-request) | **POST** `/access-requests/cancel` | Cancel access request
[**Close-BetaAccessRequest**](#close-access-request) | **POST** `/access-requests/close` | Close access request
[**New-BetaAccessRequest**](#create-access-request) | **POST** `/access-requests` | Submit access request
[**Get-BetaAccessRequestConfig**](#get-access-request-config) | **GET** `/access-request-config` | Get access request configuration
[**Get-BetaAccessRequestStatus**](#list-access-request-status) | **GET** `/access-request-status` | Access request status
[**Set-BetaAccessRequestConfig**](#set-access-request-config) | **PUT** `/access-request-config` | Update access request configuration
## cancel-access-request
@@ -76,7 +76,7 @@ $CancelAccessRequest = @"{
"comment" : "I requested this role by mistake."
}"@
# Cancel Access Request
# Cancel access request
try {
$Result = ConvertFrom-JsonToCancelAccessRequest -Json $CancelAccessRequest
@@ -138,7 +138,7 @@ $CloseAccessRequest = @"{
"message" : "The IdentityNow Administrator manually closed this request."
}"@
# Close Access Request
# Close access request
try {
$Result = ConvertFrom-JsonToCloseAccessRequest -Json $CloseAccessRequest
@@ -399,7 +399,7 @@ $AccessRequest = @"{
} ]
}"@
# Submit Access Request
# Submit access request
try {
$Result = ConvertFrom-JsonToAccessRequest -Json $AccessRequest
@@ -443,7 +443,7 @@ Code | Description | Data Type
### Example
```powershell
# Get Access Request Configuration
# Get access request configuration
try {
Get-BetaAccessRequestConfig
@@ -508,7 +508,7 @@ $Filters = 'accountActivityItemId eq "2c918086771c86df0177401efcdf54c0"' # Strin
$Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified, accountActivityItemId, name** (optional)
$RequestState = "request-state=EXECUTING" # String | Filter the results by the state of the request. The only valid value is *EXECUTING*. (optional)
# Access Request Status
# Access request status
try {
Get-BetaAccessRequestStatus
@@ -578,7 +578,7 @@ $AccessRequestConfig = @"{
"approvalsMustBeExternal" : true
}"@
# Update Access Request Configuration
# Update access request configuration
try {
$Result = ConvertFrom-JsonToAccessRequestConfig -Json $AccessRequestConfig

8
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountActivitiesApi.md
View File

@@ -50,8 +50,8 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-BetaAccountActivity**](#get-account-activity) | **GET** `/account-activities/{id}` | Get Account Activity
[**Get-BetaAccountActivities**](#list-account-activities) | **GET** `/account-activities` | List Account Activities
[**Get-BetaAccountActivity**](#get-account-activity) | **GET** `/account-activities/{id}` | Get account activity
[**Get-BetaAccountActivities**](#list-account-activities) | **GET** `/account-activities` | List account activities
## get-account-activity
@@ -86,7 +86,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account activity id
# Get Account Activity
# Get account activity
try {
Get-BetaAccountActivity -Id $Id
@@ -147,7 +147,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Filters = 'MyFilters' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **type**: *eq, in, ge, gt, le, lt, ne, isnull, sw* **created**: *gt, lt, ge, le, eq, in, ne, isnull, sw* **modified**: *gt, lt, ge, le, eq, in, ne, isnull, sw* (optional)
$Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **type, created, modified** (optional)
# List Account Activities
# List account activities
try {
Get-BetaAccountActivities

4
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountAggregationsApi.md
View File

@@ -27,7 +27,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-BetaAccountAggregationStatus**](#get-account-aggregation-status) | **GET** `/account-aggregations/{id}/status` | In-progress Account Aggregation status
[**Get-BetaAccountAggregationStatus**](#get-account-aggregation-status) | **GET** `/account-aggregations/{id}/status` | In-progress account aggregation status
## get-account-aggregation-status
@@ -69,7 +69,7 @@ Code | Description | Data Type
```powershell
$Id = "2c91808477a6b0c60177a81146b8110b" # String | The account aggregation id
# In-progress Account Aggregation status
# In-progress account aggregation status
try {
Get-BetaAccountAggregationStatus -Id $Id

64
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAccountsApi.md
View File

@@ -44,22 +44,22 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-BetaAccount**](#create-account) | **POST** `/accounts` | Create Account
[**Remove-BetaAccount**](#delete-account) | **DELETE** `/accounts/{id}` | Delete Account
[**Remove-BetaAccountAsync**](#delete-account-async) | **POST** `/accounts/{id}/remove` | Remove Account
[**Disable-BetaAccount**](#disable-account) | **POST** `/accounts/{id}/disable` | Disable Account
[**Disable-BetaAccountForIdentity**](#disable-account-for-identity) | **POST** `/identities-accounts/{id}/disable` | Disable IDN Account for Identity
[**Disable-BetaAccountsForIdentities**](#disable-accounts-for-identities) | **POST** `/identities-accounts/disable` | Disable IDN Accounts for Identities
[**Enable-BetaAccount**](#enable-account) | **POST** `/accounts/{id}/enable` | Enable Account
[**Enable-BetaAccountForIdentity**](#enable-account-for-identity) | **POST** `/identities-accounts/{id}/enable` | Enable IDN Account for Identity
[**Enable-BetaAccountsForIdentities**](#enable-accounts-for-identities) | **POST** `/identities-accounts/enable` | Enable IDN Accounts for Identities
[**Get-BetaAccount**](#get-account) | **GET** `/accounts/{id}` | Account Details
[**Get-BetaAccountEntitlements**](#get-account-entitlements) | **GET** `/accounts/{id}/entitlements` | Account Entitlements
[**Get-BetaAccounts**](#list-accounts) | **GET** `/accounts` | Accounts List
[**Send-BetaAccount**](#put-account) | **PUT** `/accounts/{id}` | Update Account
[**Submit-BetaReloadAccount**](#submit-reload-account) | **POST** `/accounts/{id}/reload` | Reload Account
[**Unlock-BetaAccount**](#unlock-account) | **POST** `/accounts/{id}/unlock` | Unlock Account
[**Update-BetaAccount**](#update-account) | **PATCH** `/accounts/{id}` | Update Account
[**New-BetaAccount**](#create-account) | **POST** `/accounts` | Create account
[**Remove-BetaAccount**](#delete-account) | **DELETE** `/accounts/{id}` | Delete account
[**Remove-BetaAccountAsync**](#delete-account-async) | **POST** `/accounts/{id}/remove` | Remove account
[**Disable-BetaAccount**](#disable-account) | **POST** `/accounts/{id}/disable` | Disable account
[**Disable-BetaAccountForIdentity**](#disable-account-for-identity) | **POST** `/identities-accounts/{id}/disable` | Disable idn account for identity
[**Disable-BetaAccountsForIdentities**](#disable-accounts-for-identities) | **POST** `/identities-accounts/disable` | Disable idn accounts for identities
[**Enable-BetaAccount**](#enable-account) | **POST** `/accounts/{id}/enable` | Enable account
[**Enable-BetaAccountForIdentity**](#enable-account-for-identity) | **POST** `/identities-accounts/{id}/enable` | Enable idn account for identity
[**Enable-BetaAccountsForIdentities**](#enable-accounts-for-identities) | **POST** `/identities-accounts/enable` | Enable idn accounts for identities
[**Get-BetaAccount**](#get-account) | **GET** `/accounts/{id}` | Account details
[**Get-BetaAccountEntitlements**](#get-account-entitlements) | **GET** `/accounts/{id}/entitlements` | Account entitlements
[**Get-BetaAccounts**](#list-accounts) | **GET** `/accounts` | Accounts list
[**Send-BetaAccount**](#put-account) | **PUT** `/accounts/{id}` | Update account
[**Submit-BetaReloadAccount**](#submit-reload-account) | **POST** `/accounts/{id}/reload` | Reload account
[**Unlock-BetaAccount**](#unlock-account) | **POST** `/accounts/{id}/unlock` | Unlock account
[**Update-BetaAccount**](#update-account) | **PATCH** `/accounts/{id}` | Update account
## create-account
@@ -116,7 +116,7 @@ $AccountAttributesCreate = @"{
}
}"@
# Create Account
# Create account
try {
$Result = ConvertFrom-JsonToAccountAttributesCreate -Json $AccountAttributesCreate
@@ -170,7 +170,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID.
# Delete Account
# Delete account
try {
Remove-BetaAccount -Id $Id
@@ -221,7 +221,7 @@ Code | Description | Data Type
```powershell
$Id = "c350d6aa4f104c61b062cb632421ad10" # String | The account id
# Remove Account
# Remove account
try {
Remove-BetaAccountAsync -Id $Id
@@ -276,7 +276,7 @@ $AccountToggleRequest = @"{
"externalVerificationId" : "3f9180835d2e5168015d32f890ca1581"
}"@
# Disable Account
# Disable account
try {
$Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest
@@ -326,7 +326,7 @@ Code | Description | Data Type
```powershell
$Id = "2c91808384203c2d018437e631158309" # String | The identity id.
# Disable IDN Account for Identity
# Disable idn account for identity
try {
Disable-BetaAccountForIdentity -Id $Id
@@ -376,7 +376,7 @@ $IdentitiesAccountsBulkRequest = @"{
"identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ]
}"@
# Disable IDN Accounts for Identities
# Disable idn accounts for identities
try {
$Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest
@@ -432,7 +432,7 @@ $AccountToggleRequest = @"{
"externalVerificationId" : "3f9180835d2e5168015d32f890ca1581"
}"@
# Enable Account
# Enable account
try {
$Result = ConvertFrom-JsonToAccountToggleRequest -Json $AccountToggleRequest
@@ -482,7 +482,7 @@ Code | Description | Data Type
```powershell
$Id = "2c91808384203c2d018437e631158309" # String | The identity id.
# Enable IDN Account for Identity
# Enable idn account for identity
try {
Enable-BetaAccountForIdentity -Id $Id
@@ -532,7 +532,7 @@ $IdentitiesAccountsBulkRequest = @"{
"identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ]
}"@
# Enable IDN Accounts for Identities
# Enable idn accounts for identities
try {
$Result = ConvertFrom-JsonToIdentitiesAccountsBulkRequest -Json $IdentitiesAccountsBulkRequest
@@ -583,7 +583,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Account ID.
# Account Details
# Account details
try {
Get-BetaAccount -Id $Id
@@ -639,7 +639,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
# Account Entitlements
# Account entitlements
try {
Get-BetaAccountEntitlements -Id $Id
@@ -697,7 +697,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Filters = 'identityId eq "2c9180858082150f0180893dbaf44201"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **hasEntitlements**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le* **modified**: *eq, ge, gt, le, lt* (optional)
$Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.name** (optional)
# Accounts List
# Accounts list
try {
Get-BetaAccounts
@@ -763,7 +763,7 @@ $AccountAttributes = @"{
}
}"@
# Update Account
# Update account
try {
$Result = ConvertFrom-JsonToAccountAttributes -Json $AccountAttributes
@@ -814,7 +814,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The account id
# Reload Account
# Reload account
try {
Submit-BetaReloadAccount -Id $Id
@@ -871,7 +871,7 @@ $AccountUnlockRequest = @"{
"unlockIDNAccount" : false
}"@
# Unlock Account
# Unlock account
try {
$Result = ConvertFrom-JsonToAccountUnlockRequest -Json $AccountUnlockRequest
@@ -936,7 +936,7 @@ $RequestBody = # SystemCollectionsHashtable[] | A list of account update operat
$RequestBody = @"{Uncorrelate account={description=Remove account from Identity, value=[{op=remove, path=/identityId}]}, Reassign account={description=Move account from one Identity to another Identity, value=[{op=replace, path=/identityId, value=2c9180857725c14301772a93bb77242d}]}, Add account attribute={description=Add flat file account's attribute, value=[{op=add, path=/attributes/familyName, value=Smith}]}, Replace account attribute={description=Replace flat file account's attribute, value=[{op=replace, path=/attributes/familyName, value=Smith}]}, Remove account attribute={description=Remove flat file account's attribute, value=[{op=remove, path=/attributes/familyName}]}}"@ # SystemCollectionsHashtable[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
# Update Account
# Update account
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody

16
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaApplicationDiscoveryApi.md
View File

@@ -19,11 +19,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-BetaDiscoveredApplicationByID**](#get-discovered-application-by-id) | **GET** `/discovered-applications/{id}` | Get Discovered Application by ID
[**Get-BetaDiscoveredApplicationByID**](#get-discovered-application-by-id) | **GET** `/discovered-applications/{id}` | Get discovered application by id
[**Get-BetaDiscoveredApplications**](#get-discovered-applications) | **GET** `/discovered-applications` | Retrieve discovered applications for tenant
[**Get-BetaManualDiscoverApplicationsCsvTemplate**](#get-manual-discover-applications-csv-template) | **GET** `/manual-discover-applications-template` | Download CSV Template for Discovery
[**Update-BetaDiscoveredApplicationByID**](#patch-discovered-application-by-id) | **PATCH** `/discovered-applications/{id}` | Patch Discovered Application by ID
[**Send-BetaManualDiscoverApplicationsCsvTemplate**](#send-manual-discover-applications-csv-template) | **POST** `/manual-discover-applications` | Upload CSV to Discover Applications
[**Get-BetaManualDiscoverApplicationsCsvTemplate**](#get-manual-discover-applications-csv-template) | **GET** `/manual-discover-applications-template` | Download csv template for discovery
[**Update-BetaDiscoveredApplicationByID**](#patch-discovered-application-by-id) | **PATCH** `/discovered-applications/{id}` | Patch discovered application by id
[**Send-BetaManualDiscoverApplicationsCsvTemplate**](#send-manual-discover-applications-csv-template) | **POST** `/manual-discover-applications` | Upload csv to discover applications
## get-discovered-application-by-id
@@ -58,7 +58,7 @@ Code | Description | Data Type
```powershell
$Id = "123e4567-e89b-12d3-a456-426655440000" # String | Discovered application's ID.
# Get Discovered Application by ID
# Get discovered application by id
try {
Get-BetaDiscoveredApplicationByID -Id $Id
@@ -158,7 +158,7 @@ Code | Description | Data Type
### Example
```powershell
# Download CSV Template for Discovery
# Download csv template for discovery
try {
Get-BetaManualDiscoverApplicationsCsvTemplate
@@ -211,7 +211,7 @@ $Id = "123e4567-e89b-12d3-a456-426655440000" # String | Discovered application's
}"@ # JsonPatchOperations[] | (optional)
# Patch Discovered Application by ID
# Patch discovered application by id
try {
Update-BetaDiscoveredApplicationByID -Id $Id
@@ -257,7 +257,7 @@ Code | Description | Data Type
```powershell
$File = # System.IO.FileInfo | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered.
# Upload CSV to Discover Applications
# Upload csv to discover applications
try {
Send-BetaManualDiscoverApplicationsCsvTemplate -File $File

8
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaApprovalsApi.md
View File

@@ -20,8 +20,8 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-BetaApproval**](#get-approval) | **GET** `/generic-approvals/{id}` | Get Approval
[**Get-BetaApprovals**](#get-approvals) | **GET** `/generic-approvals` | Get Approvals
[**Get-BetaApproval**](#get-approval) | **GET** `/generic-approvals/{id}` | Get approval
[**Get-BetaApprovals**](#get-approvals) | **GET** `/generic-approvals` | Get approvals
## get-approval
@@ -55,7 +55,7 @@ Code | Description | Data Type
```powershell
$Id = "38453251-6be2-5f8f-df93-5ce19e295837" # String | ID of the approval that to be returned.
# Get Approval
# Get approval
try {
Get-BetaApproval -Id $Id
@@ -105,7 +105,7 @@ $Mine = $true # Boolean | Returns the list of approvals for the current caller.
$RequesterId = "17e633e7d57e481569df76323169deb6a" # String | Returns the list of approvals for a given requester ID. (optional)
$Filters = 'filters=status eq PENDING' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **status**: *eq* **referenceType**: *eq* (optional)
# Get Approvals
# Get approvals
try {
Get-BetaApprovals

16
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAppsApi.md
View File

@@ -21,8 +21,8 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**New-BetaSourceApp**](#create-source-app) | **POST** `/source-apps` | Create source app
[**Remove-BetaAccessProfilesFromSourceAppByBulk**](#delete-access-profiles-from-source-app-by-bulk) | **POST** `/source-apps/{id}/access-profiles/bulk-remove` | Bulk remove access profiles from the specified source app
[**Remove-BetaSourceApp**](#delete-source-app) | **DELETE** `/source-apps/{id}` | Delete source app by ID
[**Get-BetaSourceApp**](#get-source-app) | **GET** `/source-apps/{id}` | Get source app by ID
[**Remove-BetaSourceApp**](#delete-source-app) | **DELETE** `/source-apps/{id}` | Delete source app by id
[**Get-BetaSourceApp**](#get-source-app) | **GET** `/source-apps/{id}` | Get source app by id
[**Get-BetaAccessProfilesForSourceApp**](#list-access-profiles-for-source-app) | **GET** `/source-apps/{id}/access-profiles` | List access profiles for the specified source app
[**Get-BetaAllSourceApp**](#list-all-source-app) | **GET** `/source-apps/all` | List all source apps
[**Get-BetaAllUserApps**](#list-all-user-apps) | **GET** `/user-apps/all` | List all user apps
@@ -30,8 +30,8 @@ Method | HTTP request | Description
[**Get-BetaAvailableAccountsForUserApp**](#list-available-accounts-for-user-app) | **GET** `/user-apps/{id}/available-accounts` | List available accounts for user app
[**Get-BetaAvailableSourceApps**](#list-available-source-apps) | **GET** `/source-apps` | List available source apps
[**Get-BetaOwnedUserApps**](#list-owned-user-apps) | **GET** `/user-apps` | List owned user apps
[**Update-BetaSourceApp**](#patch-source-app) | **PATCH** `/source-apps/{id}` | Patch source app by ID
[**Update-BetaUserApp**](#patch-user-app) | **PATCH** `/user-apps/{id}` | Patch user app by ID
[**Update-BetaSourceApp**](#patch-source-app) | **PATCH** `/source-apps/{id}` | Patch source app by id
[**Update-BetaUserApp**](#patch-user-app) | **PATCH** `/user-apps/{id}` | Patch user app by id
[**Update-BetaSourceAppsInBulk**](#update-source-apps-in-bulk) | **POST** `/source-apps/bulk-update` | Bulk update source apps
@@ -173,7 +173,7 @@ Code | Description | Data Type
```powershell
$Id = "2c9180835d191a86015d28455b4a2329" # String | source app ID.
# Delete source app by ID
# Delete source app by id
try {
Remove-BetaSourceApp -Id $Id
@@ -219,7 +219,7 @@ Code | Description | Data Type
```powershell
$Id = "2c91808a7813090a017814121e121518" # String | ID of the source app
# Get source app by ID
# Get source app by id
try {
Get-BetaSourceApp -Id $Id
@@ -640,7 +640,7 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the source app to patc
}"@ # JsonPatchOperation[] | (optional)
# Patch source app by ID
# Patch source app by id
try {
Update-BetaSourceApp -Id $Id
@@ -694,7 +694,7 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the user app to patch
}"@ # JsonPatchOperation[] | (optional)
# Patch user app by ID
# Patch user app by id
try {
Update-BetaUserApp -Id $Id

12
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaAuthProfileApi.md
View File

@@ -23,9 +23,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-BetaProfileConfig**](#get-profile-config) | **GET** `/auth-profiles/{id}` | Get Auth Profile.
[**Get-BetaProfileConfigList**](#get-profile-config-list) | **GET** `/auth-profiles` | Get list of Auth Profiles.
[**Update-BetaProfileConfig**](#patch-profile-config) | **PATCH** `/auth-profiles/{id}` | Patch a specified Auth Profile
[**Get-BetaProfileConfig**](#get-profile-config) | **GET** `/auth-profiles/{id}` | Get auth profile.
[**Get-BetaProfileConfigList**](#get-profile-config-list) | **GET** `/auth-profiles` | Get list of auth profiles.
[**Update-BetaProfileConfig**](#patch-profile-config) | **PATCH** `/auth-profiles/{id}` | Patch a specified auth profile
## get-profile-config
@@ -60,7 +60,7 @@ Code | Description | Data Type
```powershell
$Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to get.
# Get Auth Profile.
# Get auth profile.
try {
Get-BetaProfileConfig -Id $Id
@@ -103,7 +103,7 @@ Code | Description | Data Type
### Example
```powershell
# Get list of Auth Profiles.
# Get list of auth profiles.
try {
Get-BetaProfileConfigList
@@ -156,7 +156,7 @@ $Id = "2c91808a7813090a017814121919ecca" # String | ID of the Auth Profile to pa
}"@ # JsonPatchOperation[] |
# Patch a specified Auth Profile
# Patch a specified auth profile
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation

88
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCertificationCampaignsApi.md
View File

@@ -82,28 +82,28 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Complete-BetaCampaign**](#complete-campaign) | **POST** `/campaigns/{id}/complete` | Complete a Campaign
[**New-BetaCampaign**](#create-campaign) | **POST** `/campaigns` | Create Campaign
[**New-BetaCampaignTemplate**](#create-campaign-template) | **POST** `/campaign-templates` | Create a Campaign Template
[**Remove-BetaCampaignTemplate**](#delete-campaign-template) | **DELETE** `/campaign-templates/{id}` | Delete a Campaign Template
[**Remove-BetaCampaignTemplateSchedule**](#delete-campaign-template-schedule) | **DELETE** `/campaign-templates/{id}/schedule` | Delete Campaign Template Schedule
[**Remove-BetaCampaigns**](#delete-campaigns) | **POST** `/campaigns/delete` | Delete Campaigns
[**Get-BetaActiveCampaigns**](#get-active-campaigns) | **GET** `/campaigns` | List Campaigns
[**Get-BetaCampaign**](#get-campaign) | **GET** `/campaigns/{id}` | Get Campaign
[**Get-BetaCampaignReports**](#get-campaign-reports) | **GET** `/campaigns/{id}/reports` | Get Campaign Reports
[**Get-BetaCampaignReportsConfig**](#get-campaign-reports-config) | **GET** `/campaigns/reports-configuration` | Get Campaign Reports Configuration
[**Get-BetaCampaignTemplate**](#get-campaign-template) | **GET** `/campaign-templates/{id}` | Get a Campaign Template
[**Get-BetaCampaignTemplateSchedule**](#get-campaign-template-schedule) | **GET** `/campaign-templates/{id}/schedule` | Get Campaign Template Schedule
[**Get-BetaCampaignTemplates**](#get-campaign-templates) | **GET** `/campaign-templates` | List Campaign Templates
[**Move-Beta**](#move) | **POST** `/campaigns/{id}/reassign` | Reassign Certifications
[**Update-BetaCampaignTemplate**](#patch-campaign-template) | **PATCH** `/campaign-templates/{id}` | Update a Campaign Template
[**Set-BetaCampaignReportsConfig**](#set-campaign-reports-config) | **PUT** `/campaigns/reports-configuration` | Set Campaign Reports Configuration
[**Set-BetaCampaignTemplateSchedule**](#set-campaign-template-schedule) | **PUT** `/campaign-templates/{id}/schedule` | Set Campaign Template Schedule
[**Start-BetaCampaign**](#start-campaign) | **POST** `/campaigns/{id}/activate` | Activate a Campaign
[**Start-BetaCampaignRemediationScan**](#start-campaign-remediation-scan) | **POST** `/campaigns/{id}/run-remediation-scan` | Run Campaign Remediation Scan
[**Start-BetaCampaignReport**](#start-campaign-report) | **POST** `/campaigns/{id}/run-report/{type}` | Run Campaign Report
[**Start-BetaGenerateCampaignTemplate**](#start-generate-campaign-template) | **POST** `/campaign-templates/{id}/generate` | Generate a Campaign from Template
[**Update-BetaCampaign**](#update-campaign) | **PATCH** `/campaigns/{id}` | Update a Campaign
[**Complete-BetaCampaign**](#complete-campaign) | **POST** `/campaigns/{id}/complete` | Complete a campaign
[**New-BetaCampaign**](#create-campaign) | **POST** `/campaigns` | Create campaign
[**New-BetaCampaignTemplate**](#create-campaign-template) | **POST** `/campaign-templates` | Create a campaign template
[**Remove-BetaCampaignTemplate**](#delete-campaign-template) | **DELETE** `/campaign-templates/{id}` | Delete a campaign template
[**Remove-BetaCampaignTemplateSchedule**](#delete-campaign-template-schedule) | **DELETE** `/campaign-templates/{id}/schedule` | Delete campaign template schedule
[**Remove-BetaCampaigns**](#delete-campaigns) | **POST** `/campaigns/delete` | Delete campaigns
[**Get-BetaActiveCampaigns**](#get-active-campaigns) | **GET** `/campaigns` | List campaigns
[**Get-BetaCampaign**](#get-campaign) | **GET** `/campaigns/{id}` | Get campaign
[**Get-BetaCampaignReports**](#get-campaign-reports) | **GET** `/campaigns/{id}/reports` | Get campaign reports
[**Get-BetaCampaignReportsConfig**](#get-campaign-reports-config) | **GET** `/campaigns/reports-configuration` | Get campaign reports configuration
[**Get-BetaCampaignTemplate**](#get-campaign-template) | **GET** `/campaign-templates/{id}` | Get a campaign template
[**Get-BetaCampaignTemplateSchedule**](#get-campaign-template-schedule) | **GET** `/campaign-templates/{id}/schedule` | Get campaign template schedule
[**Get-BetaCampaignTemplates**](#get-campaign-templates) | **GET** `/campaign-templates` | List campaign templates
[**Move-Beta**](#move) | **POST** `/campaigns/{id}/reassign` | Reassign certifications
[**Update-BetaCampaignTemplate**](#patch-campaign-template) | **PATCH** `/campaign-templates/{id}` | Update a campaign template
[**Set-BetaCampaignReportsConfig**](#set-campaign-reports-config) | **PUT** `/campaigns/reports-configuration` | Set campaign reports configuration
[**Set-BetaCampaignTemplateSchedule**](#set-campaign-template-schedule) | **PUT** `/campaign-templates/{id}/schedule` | Set campaign template schedule
[**Start-BetaCampaign**](#start-campaign) | **POST** `/campaigns/{id}/activate` | Activate a campaign
[**Start-BetaCampaignRemediationScan**](#start-campaign-remediation-scan) | **POST** `/campaigns/{id}/run-remediation-scan` | Run campaign remediation scan
[**Start-BetaCampaignReport**](#start-campaign-report) | **POST** `/campaigns/{id}/run-report/{type}` | Run campaign report
[**Start-BetaGenerateCampaignTemplate**](#start-generate-campaign-template) | **POST** `/campaign-templates/{id}/generate` | Generate a campaign from template
[**Update-BetaCampaign**](#update-campaign) | **PATCH** `/campaigns/{id}` | Update a campaign
## complete-campaign
@@ -157,7 +157,7 @@ $CompleteCampaignOptions = @"{
"autoCompleteAction" : "REVOKE"
}"@
# Complete a Campaign
# Complete a campaign
try {
Complete-BetaCampaign -Id $Id
@@ -316,7 +316,7 @@ $Campaign = @"{
"correlatedStatus" : "CORRELATED"
}"@
# Create Campaign
# Create campaign
try {
$Result = ConvertFrom-JsonToCampaign -Json $Campaign
@@ -491,7 +491,7 @@ $CampaignTemplate = @"{
"id" : "2c9079b270a266a60170a277bb960008"
}"@
# Create a Campaign Template
# Create a campaign template
try {
$Result = ConvertFrom-JsonToCampaignTemplate -Json $CampaignTemplate
@@ -544,7 +544,7 @@ Code | Description | Data Type
```powershell
$Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template being deleted.
# Delete a Campaign Template
# Delete a campaign template
try {
Remove-BetaCampaignTemplate -Id $Id
@@ -596,7 +596,7 @@ Code | Description | Data Type
```powershell
$Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being deleted.
# Delete Campaign Template Schedule
# Delete campaign template schedule
try {
Remove-BetaCampaignTemplateSchedule -Id $Id
@@ -650,7 +650,7 @@ $DeleteCampaignsRequest = @"{
"ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ]
}"@
# Delete Campaigns
# Delete campaigns
try {
$Result = ConvertFrom-JsonToDeleteCampaignsRequest -Json $DeleteCampaignsRequest
@@ -712,7 +712,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Filters = 'name eq "Manager Campaign"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **status**: *eq, in* (optional)
$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created** (optional)
# List Campaigns
# List campaigns
try {
Get-BetaActiveCampaigns
@@ -764,7 +764,7 @@ Code | Description | Data Type
```powershell
$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign to be retrieved.
# Get Campaign
# Get campaign
try {
Get-BetaCampaign -Id $Id
@@ -816,7 +816,7 @@ Code | Description | Data Type
```powershell
$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign whose reports are being fetched.
# Get Campaign Reports
# Get campaign reports
try {
Get-BetaCampaignReports -Id $Id
@@ -865,7 +865,7 @@ Code | Description | Data Type
### Example
```powershell
# Get Campaign Reports Configuration
# Get campaign reports configuration
try {
Get-BetaCampaignReportsConfig
@@ -917,7 +917,7 @@ Code | Description | Data Type
```powershell
$Id = "2c9180835d191a86015d28455b4a2329" # String | Requested campaign template's ID.
# Get a Campaign Template
# Get a campaign template
try {
Get-BetaCampaignTemplate -Id $Id
@@ -969,7 +969,7 @@ Code | Description | Data Type
```powershell
$Id = "04bedce387bd47b2ae1f86eb0bb36dee" # String | ID of the campaign template whose schedule is being fetched.
# Get Campaign Template Schedule
# Get campaign template schedule
try {
Get-BetaCampaignTemplateSchedule -Id $Id
@@ -1030,7 +1030,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional)
$Filters = 'name eq "manager template"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, ge, gt, in, le, lt, ne, sw* **id**: *eq, ge, gt, in, le, lt, ne, sw* (optional)
# List Campaign Templates
# List campaign templates
try {
Get-BetaCampaignTemplates
@@ -1091,7 +1091,7 @@ $AdminReviewReassign = @"{
}
}"@
# Reassign Certifications
# Reassign certifications
try {
$Result = ConvertFrom-JsonToAdminReviewReassign -Json $AdminReviewReassign
@@ -1151,7 +1151,7 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template
}"@ # JsonPatchOperation[] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create)
# Update a Campaign Template
# Update a campaign template
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
@@ -1205,7 +1205,7 @@ $CampaignReportsConfig = @"{
"identityAttributeColumns" : [ "firstname", "lastname" ]
}"@
# Set Campaign Reports Configuration
# Set campaign reports configuration
try {
$Result = ConvertFrom-JsonToCampaignReportsConfig -Json $CampaignReportsConfig
@@ -1280,7 +1280,7 @@ $Schedule = @"{
"type" : "WEEKLY"
}"@
# Set Campaign Template Schedule
# Set campaign template schedule
try {
Set-BetaCampaignTemplateSchedule -Id $Id
@@ -1336,7 +1336,7 @@ $ActivateCampaignOptions = @"{
"timeZone" : "-05:00"
}"@
# Activate a Campaign
# Activate a campaign
try {
Start-BetaCampaign -Id $Id
@@ -1388,7 +1388,7 @@ Code | Description | Data Type
```powershell
$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the remediation scan is being run for.
# Run Campaign Remediation Scan
# Run campaign remediation scan
try {
Start-BetaCampaignRemediationScan -Id $Id
@@ -1442,7 +1442,7 @@ Code | Description | Data Type
$Id = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the campaign the report is being run for.
$Type = "CAMPAIGN_COMPOSITION_REPORT" # ReportType | Type of report to run.
# Run Campaign Report
# Run campaign report
try {
Start-BetaCampaignReport -Id $Id -Type $Type
@@ -1505,7 +1505,7 @@ Code | Description | Data Type
```powershell
$Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the campaign template to use for generation.
# Generate a Campaign from Template
# Generate a campaign from template
try {
Start-BetaGenerateCampaignTemplate -Id $Id
@@ -1561,7 +1561,7 @@ $RequestBody = # SystemCollectionsHashtable[] | A list of campaign update opera
$RequestBody = @"[{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}]"@ # SystemCollectionsHashtable[] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline
# Update a Campaign
# Update a campaign
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody

24
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCertificationsApi.md
View File

@@ -32,12 +32,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-BetaIdentityCertificationItemPermissions**](#get-identity-certification-item-permissions) | **GET** `/certifications/{certificationId}/access-review-items/{itemId}/permissions` | Permissions for Entitlement Certification Item
[**Get-BetaIdentityCertificationPendingTasks**](#get-identity-certification-pending-tasks) | **GET** `/certifications/{id}/tasks-pending` | Pending Certification Tasks
[**Get-BetaIdentityCertificationTaskStatus**](#get-identity-certification-task-status) | **GET** `/certifications/{id}/tasks/{taskId}` | Certification Task Status
[**Get-BetaCertificationReviewers**](#list-certification-reviewers) | **GET** `/certifications/{id}/reviewers` | List of Reviewers for certification
[**Get-BetaCertifications**](#list-certifications) | **GET** `/certifications` | Certifications by IDs
[**Submit-BetaReassignCertsAsync**](#submit-reassign-certs-async) | **POST** `/certifications/{id}/reassign-async` | Reassign Certifications Asynchronously
[**Get-BetaIdentityCertificationItemPermissions**](#get-identity-certification-item-permissions) | **GET** `/certifications/{certificationId}/access-review-items/{itemId}/permissions` | Permissions for entitlement certification item
[**Get-BetaIdentityCertificationPendingTasks**](#get-identity-certification-pending-tasks) | **GET** `/certifications/{id}/tasks-pending` | Pending certification tasks
[**Get-BetaIdentityCertificationTaskStatus**](#get-identity-certification-task-status) | **GET** `/certifications/{id}/tasks/{taskId}` | Certification task status
[**Get-BetaCertificationReviewers**](#list-certification-reviewers) | **GET** `/certifications/{id}/reviewers` | List of reviewers for certification
[**Get-BetaCertifications**](#list-certifications) | **GET** `/certifications` | Certifications by ids
[**Submit-BetaReassignCertsAsync**](#submit-reassign-certs-async) | **POST** `/certifications/{id}/reassign-async` | Reassign certifications asynchronously
## get-identity-certification-item-permissions
@@ -85,7 +85,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
# Permissions for Entitlement Certification Item
# Permissions for entitlement certification item
try {
Get-BetaIdentityCertificationItemPermissions -CertificationId $CertificationId -ItemId $ItemId
@@ -131,7 +131,7 @@ Code | Description | Data Type
```powershell
$Id = "MyId" # String | The identity campaign certification ID
# Pending Certification Tasks
# Pending certification tasks
try {
Get-BetaIdentityCertificationPendingTasks -Id $Id
@@ -179,7 +179,7 @@ Code | Description | Data Type
$Id = "MyId" # String | The identity campaign certification ID
$TaskId = "MyTaskId" # String | The certification task ID
# Certification Task Status
# Certification task status
try {
Get-BetaIdentityCertificationTaskStatus -Id $Id -TaskId $TaskId
@@ -238,7 +238,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Filters = 'name eq "Bob"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **email**: *eq, sw* (optional)
$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, email** (optional)
# List of Reviewers for certification
# List of reviewers for certification
try {
Get-BetaCertificationReviewers -Id $Id
@@ -293,7 +293,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Filters = 'MyFilters' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **phase**: *eq* **completed**: *eq, ne* **campaignRef.campaignType**: *eq, in* **campaignRef.id**: *eq, in* (optional)
$Sorters = "MySorters" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (optional)
# Certifications by IDs
# Certifications by ids
try {
Get-BetaCertifications
@@ -354,7 +354,7 @@ $ReviewReassign = @"{
} ]
}"@
# Reassign Certifications Asynchronously
# Reassign certifications asynchronously
try {
$Result = ConvertFrom-JsonToReviewReassign -Json $ReviewReassign

24
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaConnectorRuleManagementApi.md
View File

@@ -23,12 +23,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-BetaConnectorRule**](#create-connector-rule) | **POST** `/connector-rules` | Create Connector Rule
[**Remove-BetaConnectorRule**](#delete-connector-rule) | **DELETE** `/connector-rules/{id}` | Delete a Connector-Rule
[**Get-BetaConnectorRule**](#get-connector-rule) | **GET** `/connector-rules/{id}` | Connector-Rule by ID
[**Get-BetaConnectorRuleList**](#get-connector-rule-list) | **GET** `/connector-rules` | List Connector Rules
[**Update-BetaConnectorRule**](#update-connector-rule) | **PUT** `/connector-rules/{id}` | Update a Connector Rule
[**Confirm-BetaConnectorRule**](#validate-connector-rule) | **POST** `/connector-rules/validate` | Validate Connector Rule
[**New-BetaConnectorRule**](#create-connector-rule) | **POST** `/connector-rules` | Create connector rule
[**Remove-BetaConnectorRule**](#delete-connector-rule) | **DELETE** `/connector-rules/{id}` | Delete a connector-rule
[**Get-BetaConnectorRule**](#get-connector-rule) | **GET** `/connector-rules/{id}` | Connector-rule by id
[**Get-BetaConnectorRuleList**](#get-connector-rule-list) | **GET** `/connector-rules` | List connector rules
[**Update-BetaConnectorRule**](#update-connector-rule) | **PUT** `/connector-rules/{id}` | Update a connector rule
[**Confirm-BetaConnectorRule**](#validate-connector-rule) | **POST** `/connector-rules/validate` | Validate connector rule
## create-connector-rule
@@ -88,7 +88,7 @@ $ConnectorRuleCreateRequest = @"{
"type" : "BuildMap"
}"@
# Create Connector Rule
# Create connector rule
try {
$Result = ConvertFrom-JsonToConnectorRuleCreateRequest -Json $ConnectorRuleCreateRequest
@@ -136,7 +136,7 @@ Code | Description | Data Type
```powershell
$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to delete
# Delete a Connector-Rule
# Delete a connector-rule
try {
Remove-BetaConnectorRule -Id $Id
@@ -183,7 +183,7 @@ Code | Description | Data Type
```powershell
$Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | ID of the connector rule to retrieve
# Connector-Rule by ID
# Connector-rule by id
try {
Get-BetaConnectorRule -Id $Id
@@ -227,7 +227,7 @@ Code | Description | Data Type
### Example
```powershell
# List Connector Rules
# List connector rules
try {
Get-BetaConnectorRuleList
@@ -302,7 +302,7 @@ $ConnectorRuleUpdateRequest = @"{
"type" : "BuildMap"
}"@
# Update a Connector Rule
# Update a connector rule
try {
Update-BetaConnectorRule -Id $Id
@@ -351,7 +351,7 @@ $SourceCode = @"{
"script" : "return \"Mr. \" + firstName;"
}"@
# Validate Connector Rule
# Validate connector rule
try {
$Result = ConvertFrom-JsonToSourceCode -Json $SourceCode

4
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaConnectorsApi.md
View File

@@ -31,7 +31,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-BetaConnectorList**](#get-connector-list) | **GET** `/connectors` | Get Connector List
[**Get-BetaConnectorList**](#get-connector-list) | **GET** `/connectors` | Get connector list
## get-connector-list
@@ -74,7 +74,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Locale = "de" # String | The locale to apply to the config. If no viable locale is given, it will default to ""en"" (optional)
# Get Connector List
# Get connector list
try {
Get-BetaConnectorList

12
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCustomFormsApi.md
View File

@@ -27,15 +27,15 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**New-BetaFormDefinition**](#create-form-definition) | **POST** `/form-definitions` | Creates a form definition.
[**New-BetaFormDefinitionByTemplate**](#create-form-definition-by-template) | **POST** `/form-definitions/template` | Create a form definition by template.
[**New-BetaFormDefinitionDynamicSchema**](#create-form-definition-dynamic-schema) | **POST** `/form-definitions/forms-action-dynamic-schema` | Generate JSON Schema dynamically.
[**New-BetaFormDefinitionDynamicSchema**](#create-form-definition-dynamic-schema) | **POST** `/form-definitions/forms-action-dynamic-schema` | Generate json schema dynamically.
[**New-BetaFormDefinitionFileRequest**](#create-form-definition-file-request) | **POST** `/form-definitions/{formDefinitionID}/upload` | Upload new form definition file.
[**New-BetaFormInstance**](#create-form-instance) | **POST** `/form-instances` | Creates a form instance.
[**Remove-BetaFormDefinition**](#delete-form-definition) | **DELETE** `/form-definitions/{formDefinitionID}` | Deletes a form definition.
[**Export-BetaFormDefinitionsByTenant**](#export-form-definitions-by-tenant) | **GET** `/form-definitions/export` | List form definitions by tenant.
[**Get-BetaFileFromS3**](#get-file-from-s3) | **GET** `/form-definitions/{formDefinitionID}/file/{fileID}` | Download definition file by fileId.
[**Get-BetaFileFromS3**](#get-file-from-s3) | **GET** `/form-definitions/{formDefinitionID}/file/{fileID}` | Download definition file by fileid.
[**Get-BetaFormDefinitionByKey**](#get-form-definition-by-key) | **GET** `/form-definitions/{formDefinitionID}` | Return a form definition.
[**Get-BetaFormInstanceByKey**](#get-form-instance-by-key) | **GET** `/form-instances/{formInstanceID}` | Returns a form instance.
[**Get-BetaFormInstanceFile**](#get-form-instance-file) | **GET** `/form-instances/{formInstanceID}/file/{fileID}` | Download instance file by fileId.
[**Get-BetaFormInstanceFile**](#get-form-instance-file) | **GET** `/form-instances/{formInstanceID}/file/{fileID}` | Download instance file by fileid.
[**Import-BetaFormDefinitions**](#import-form-definitions) | **POST** `/form-definitions/import` | Import form definitions from export.
[**Update-BetaFormDefinition**](#patch-form-definition) | **PATCH** `/form-definitions/{formDefinitionID}` | Patch a form definition.
[**Update-BetaFormInstance**](#patch-form-instance) | **PATCH** `/form-instances/{formInstanceID}` | Patch a form instance.
@@ -396,7 +396,7 @@ $Body = @"{
"versionNumber" : 1
}"@
# Generate JSON Schema dynamically.
# Generate json schema dynamically.
try {
New-BetaFormDefinitionDynamicSchema
@@ -658,7 +658,7 @@ Code | Description | Data Type
$FormDefinitionID = "00000000-0000-0000-0000-000000000000" # String | FormDefinitionID Form definition ID
$FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving.
# Download definition file by fileId.
# Download definition file by fileid.
try {
Get-BetaFileFromS3 -FormDefinitionID $FormDefinitionID -FileID $FileID
@@ -799,7 +799,7 @@ Code | Description | Data Type
$FormInstanceID = "00000000-0000-0000-0000-000000000000" # String | FormInstanceID Form instance ID
$FileID = "00000031N0J7R2B57M8YG73J7M.png" # String | FileID String specifying the hashed name of the uploaded file we are retrieving.
# Download instance file by fileId.
# Download instance file by fileid.
try {
Get-BetaFormInstanceFile -FormInstanceID $FormInstanceID -FileID $FileID

12
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaCustomPasswordInstructionsApi.md
View File

@@ -28,9 +28,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-BetaCustomPasswordInstructions**](#create-custom-password-instructions) | **POST** `/custom-password-instructions` | Create Custom Password Instructions
[**Remove-BetaCustomPasswordInstructions**](#delete-custom-password-instructions) | **DELETE** `/custom-password-instructions/{pageId}` | Delete Custom Password Instructions by page ID
[**Get-BetaCustomPasswordInstructions**](#get-custom-password-instructions) | **GET** `/custom-password-instructions/{pageId}` | Get Custom Password Instructions by Page ID
[**New-BetaCustomPasswordInstructions**](#create-custom-password-instructions) | **POST** `/custom-password-instructions` | Create custom password instructions
[**Remove-BetaCustomPasswordInstructions**](#delete-custom-password-instructions) | **DELETE** `/custom-password-instructions/{pageId}` | Delete custom password instructions by page id
[**Get-BetaCustomPasswordInstructions**](#get-custom-password-instructions) | **GET** `/custom-password-instructions/{pageId}` | Get custom password instructions by page id
## create-custom-password-instructions
@@ -66,7 +66,7 @@ $CustomPasswordInstruction = @"{
"locale" : "en"
}"@
# Create Custom Password Instructions
# Create custom password instructions
try {
$Result = ConvertFrom-JsonToCustomPasswordInstruction -Json $CustomPasswordInstruction
@@ -113,7 +113,7 @@ Code | Description | Data Type
$PageId = "change-password:enter-password" # String | The page ID of custom password instructions to delete.
$Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional)
# Delete Custom Password Instructions by page ID
# Delete custom password instructions by page id
try {
Remove-BetaCustomPasswordInstructions -PageId $PageId
@@ -159,7 +159,7 @@ Code | Description | Data Type
$PageId = "change-password:enter-password" # String | The page ID of custom password instructions to query.
$Locale = "MyLocale" # String | The locale for the custom instructions, a BCP47 language tag. The default value is \""default\"". (optional)
# Get Custom Password Instructions by Page ID
# Get custom password instructions by page id
try {
Get-BetaCustomPasswordInstructions -PageId $PageId

16
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaEntitlementsApi.md
View File

@@ -69,14 +69,14 @@ Method | HTTP request | Description
[**New-BetaAccessModelMetadataForEntitlement**](#create-access-model-metadata-for-entitlement) | **POST** `/entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Add metadata to an entitlement.
[**Remove-BetaAccessModelMetadataFromEntitlement**](#delete-access-model-metadata-from-entitlement) | **DELETE** `/entitlements/{id}/access-model-metadata/{attributeKey}/values/{attributeValue}` | Remove metadata from an entitlement.
[**Get-BetaEntitlement**](#get-entitlement) | **GET** `/entitlements/{id}` | Get an entitlement
[**Get-BetaEntitlementRequestConfig**](#get-entitlement-request-config) | **GET** `/entitlements/{id}/entitlement-request-config` | Get Entitlement Request Config
[**Import-BetaEntitlementsBySource**](#import-entitlements-by-source) | **POST** `/entitlements/aggregate/sources/{id}` | Aggregate Entitlements
[**Get-BetaEntitlementRequestConfig**](#get-entitlement-request-config) | **GET** `/entitlements/{id}/entitlement-request-config` | Get entitlement request config
[**Import-BetaEntitlementsBySource**](#import-entitlements-by-source) | **POST** `/entitlements/aggregate/sources/{id}` | Aggregate entitlements
[**Get-BetaEntitlementChildren**](#list-entitlement-children) | **GET** `/entitlements/{id}/children` | List of entitlements children
[**Get-BetaEntitlementParents**](#list-entitlement-parents) | **GET** `/entitlements/{id}/parents` | List of entitlements parents
[**Get-BetaEntitlements**](#list-entitlements) | **GET** `/entitlements` | Gets a list of entitlements.
[**Update-BetaEntitlement**](#patch-entitlement) | **PATCH** `/entitlements/{id}` | Patch an entitlement
[**Send-BetaEntitlementRequestConfig**](#put-entitlement-request-config) | **PUT** `/entitlements/{id}/entitlement-request-config` | Replace Entitlement Request Config
[**Reset-BetaSourceEntitlements**](#reset-source-entitlements) | **POST** `/entitlements/reset/sources/{sourceId}` | Reset Source Entitlements
[**Send-BetaEntitlementRequestConfig**](#put-entitlement-request-config) | **PUT** `/entitlements/{id}/entitlement-request-config` | Replace entitlement request config
[**Reset-BetaSourceEntitlements**](#reset-source-entitlements) | **POST** `/entitlements/reset/sources/{sourceId}` | Reset source entitlements
[**Update-BetaEntitlementsInBulk**](#update-entitlements-in-bulk) | **POST** `/entitlements/bulk-update` | Bulk update an entitlement list
@@ -256,7 +256,7 @@ Code | Description | Data Type
```powershell
$Id = "2c91808874ff91550175097daaec161c" # String | Entitlement Id
# Get Entitlement Request Config
# Get entitlement request config
try {
Get-BetaEntitlementRequestConfig -Id $Id
@@ -310,7 +310,7 @@ Code | Description | Data Type
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id
$CsvFile = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional)
# Aggregate Entitlements
# Aggregate entitlements
try {
Import-BetaEntitlementsBySource -Id $Id
@@ -616,7 +616,7 @@ $EntitlementRequestConfig = @"{
}
}"@
# Replace Entitlement Request Config
# Replace entitlement request config
try {
$Result = ConvertFrom-JsonToEntitlementRequestConfig -Json $EntitlementRequestConfig
@@ -663,7 +663,7 @@ Code | Description | Data Type
```powershell
$SourceId = "2c91808a7813090a017814121919ecca" # String | ID of source for the entitlement reset
# Reset Source Entitlements
# Reset source entitlements
try {
Reset-BetaSourceEntitlements -SourceId $SourceId

40
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaGovernanceGroupsApi.md
View File

@@ -22,16 +22,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-BetaWorkgroup**](#create-workgroup) | **POST** `/workgroups` | Create a new Governance Group.
[**Remove-BetaWorkgroup**](#delete-workgroup) | **DELETE** `/workgroups/{id}` | Delete a Governance Group
[**Remove-BetaWorkgroupMembers**](#delete-workgroup-members) | **POST** `/workgroups/{workgroupId}/members/bulk-delete` | Remove members from Governance Group
[**Remove-BetaWorkgroupsInBulk**](#delete-workgroups-in-bulk) | **POST** `/workgroups/bulk-delete` | Delete Governance Group(s)
[**Get-BetaWorkgroup**](#get-workgroup) | **GET** `/workgroups/{id}` | Get Governance Group by Id
[**Get-BetaConnections**](#list-connections) | **GET** `/workgroups/{workgroupId}/connections` | List connections for Governance Group
[**Get-BetaWorkgroupMembers**](#list-workgroup-members) | **GET** `/workgroups/{workgroupId}/members` | List Governance Group Members
[**Get-BetaWorkgroups**](#list-workgroups) | **GET** `/workgroups` | List Governance Groups
[**Update-BetaWorkgroup**](#patch-workgroup) | **PATCH** `/workgroups/{id}` | Patch a Governance Group
[**Update-BetaWorkgroupMembers**](#update-workgroup-members) | **POST** `/workgroups/{workgroupId}/members/bulk-add` | Add members to Governance Group
[**New-BetaWorkgroup**](#create-workgroup) | **POST** `/workgroups` | Create a new governance group.
[**Remove-BetaWorkgroup**](#delete-workgroup) | **DELETE** `/workgroups/{id}` | Delete a governance group
[**Remove-BetaWorkgroupMembers**](#delete-workgroup-members) | **POST** `/workgroups/{workgroupId}/members/bulk-delete` | Remove members from governance group
[**Remove-BetaWorkgroupsInBulk**](#delete-workgroups-in-bulk) | **POST** `/workgroups/bulk-delete` | Delete governance group(s)
[**Get-BetaWorkgroup**](#get-workgroup) | **GET** `/workgroups/{id}` | Get governance group by id
[**Get-BetaConnections**](#list-connections) | **GET** `/workgroups/{workgroupId}/connections` | List connections for governance group
[**Get-BetaWorkgroupMembers**](#list-workgroup-members) | **GET** `/workgroups/{workgroupId}/members` | List governance group members
[**Get-BetaWorkgroups**](#list-workgroups) | **GET** `/workgroups` | List governance groups
[**Update-BetaWorkgroup**](#patch-workgroup) | **PATCH** `/workgroups/{id}` | Patch a governance group
[**Update-BetaWorkgroupMembers**](#update-workgroup-members) | **POST** `/workgroups/{workgroupId}/members/bulk-add` | Add members to governance group
## create-workgroup
@@ -80,7 +80,7 @@ $WorkgroupDto = @"{
"id" : "2c91808568c529c60168cca6f90c1313"
}"@
# Create a new Governance Group.
# Create a new governance group.
try {
$Result = ConvertFrom-JsonToWorkgroupDto -Json $WorkgroupDto
@@ -126,7 +126,7 @@ Code | Description | Data Type
```powershell
$Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group
# Delete a Governance Group
# Delete a governance group
try {
Remove-BetaWorkgroup -Id $Id
@@ -178,7 +178,7 @@ $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governanc
$BulkWorkgroupMembersRequestInner = @""@ # BulkWorkgroupMembersRequestInner[] | List of identities to be removed from a Governance Group members list.
# Remove members from Governance Group
# Remove members from governance group
try {
$Result = ConvertFrom-JsonToBulkWorkgroupMembersRequestInner -Json $BulkWorkgroupMembersRequestInner
@@ -237,7 +237,7 @@ $WorkgroupBulkDeleteRequest = @"{
"ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ]
}"@
# Delete Governance Group(s)
# Delete governance group(s)
try {
$Result = ConvertFrom-JsonToWorkgroupBulkDeleteRequest -Json $WorkgroupBulkDeleteRequest
@@ -283,7 +283,7 @@ Code | Description | Data Type
```powershell
$Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group
# Get Governance Group by Id
# Get governance group by id
try {
Get-BetaWorkgroup -Id $Id
@@ -336,7 +336,7 @@ $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50.
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional)
# List connections for Governance Group
# List connections for governance group
try {
Get-BetaConnections -WorkgroupId $WorkgroupId
@@ -389,7 +389,7 @@ $Limit = 50 # Int32 | Note that for this API the maximum value for limit is 50.
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified** (optional)
# List Governance Group Members
# List governance group members
try {
Get-BetaWorkgroupMembers -WorkgroupId $WorkgroupId
@@ -442,7 +442,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Filters = 'name sw "Test"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **name**: *eq, sw, in* **memberships.identityId**: *eq, in* (optional)
$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, description** (optional)
# List Governance Groups
# List governance groups
try {
Get-BetaWorkgroups
@@ -500,7 +500,7 @@ $Id = "2c9180837ca6693d017ca8d097500149" # String | ID of the Governance Group
}"@ # JsonPatchOperation[] | (optional)
# Patch a Governance Group
# Patch a governance group
try {
Update-BetaWorkgroup -Id $Id
@@ -552,7 +552,7 @@ $WorkgroupId = "2c91808a7813090a017814121919ecca" # String | ID of the Governanc
$BulkWorkgroupMembersRequestInner = @""@ # BulkWorkgroupMembersRequestInner[] | List of identities to be added to a Governance Group members list.
# Add members to Governance Group
# Add members to governance group
try {
$Result = ConvertFrom-JsonToBulkWorkgroupMembersRequestInner -Json $BulkWorkgroupMembersRequestInner

32
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIAccessRequestRecommendationsApi.md
View File

@@ -17,14 +17,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Add-BetaAccessRequestRecommendationsIgnoredItem**](#add-access-request-recommendations-ignored-item) | **POST** `/ai-access-request-recommendations/ignored-items` | Ignore Access Request Recommendation
[**Add-BetaAccessRequestRecommendationsRequestedItem**](#add-access-request-recommendations-requested-item) | **POST** `/ai-access-request-recommendations/requested-items` | Accept Access Request Recommendation
[**Add-BetaAccessRequestRecommendationsViewedItem**](#add-access-request-recommendations-viewed-item) | **POST** `/ai-access-request-recommendations/viewed-items` | Mark Viewed Access Request Recommendations
[**Add-BetaAccessRequestRecommendationsViewedItems**](#add-access-request-recommendations-viewed-items) | **POST** `/ai-access-request-recommendations/viewed-items/bulk-create` | Bulk Mark Viewed Access Request Recommendations
[**Get-BetaAccessRequestRecommendations**](#get-access-request-recommendations) | **GET** `/ai-access-request-recommendations` | Identity Access Request Recommendations
[**Get-BetaAccessRequestRecommendationsIgnoredItems**](#get-access-request-recommendations-ignored-items) | **GET** `/ai-access-request-recommendations/ignored-items` | List Ignored Access Request Recommendations
[**Get-BetaAccessRequestRecommendationsRequestedItems**](#get-access-request-recommendations-requested-items) | **GET** `/ai-access-request-recommendations/requested-items` | List Accepted Access Request Recommendations
[**Get-BetaAccessRequestRecommendationsViewedItems**](#get-access-request-recommendations-viewed-items) | **GET** `/ai-access-request-recommendations/viewed-items` | List Viewed Access Request Recommendations
[**Add-BetaAccessRequestRecommendationsIgnoredItem**](#add-access-request-recommendations-ignored-item) | **POST** `/ai-access-request-recommendations/ignored-items` | Ignore access request recommendation
[**Add-BetaAccessRequestRecommendationsRequestedItem**](#add-access-request-recommendations-requested-item) | **POST** `/ai-access-request-recommendations/requested-items` | Accept access request recommendation
[**Add-BetaAccessRequestRecommendationsViewedItem**](#add-access-request-recommendations-viewed-item) | **POST** `/ai-access-request-recommendations/viewed-items` | Mark viewed access request recommendations
[**Add-BetaAccessRequestRecommendationsViewedItems**](#add-access-request-recommendations-viewed-items) | **POST** `/ai-access-request-recommendations/viewed-items/bulk-create` | Bulk mark viewed access request recommendations
[**Get-BetaAccessRequestRecommendations**](#get-access-request-recommendations) | **GET** `/ai-access-request-recommendations` | Identity access request recommendations
[**Get-BetaAccessRequestRecommendationsIgnoredItems**](#get-access-request-recommendations-ignored-items) | **GET** `/ai-access-request-recommendations/ignored-items` | List ignored access request recommendations
[**Get-BetaAccessRequestRecommendationsRequestedItems**](#get-access-request-recommendations-requested-items) | **GET** `/ai-access-request-recommendations/requested-items` | List accepted access request recommendations
[**Get-BetaAccessRequestRecommendationsViewedItems**](#get-access-request-recommendations-viewed-items) | **GET** `/ai-access-request-recommendations/viewed-items` | List viewed access request recommendations
## add-access-request-recommendations-ignored-item
@@ -64,7 +64,7 @@ $AccessRequestRecommendationActionItemDto = @"{
"identityId" : "2c91808570313110017040b06f344ec9"
}"@
# Ignore Access Request Recommendation
# Ignore access request recommendation
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
@@ -116,7 +116,7 @@ $AccessRequestRecommendationActionItemDto = @"{
"identityId" : "2c91808570313110017040b06f344ec9"
}"@
# Accept Access Request Recommendation
# Accept access request recommendation
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
@@ -168,7 +168,7 @@ $AccessRequestRecommendationActionItemDto = @"{
"identityId" : "2c91808570313110017040b06f344ec9"
}"@
# Mark Viewed Access Request Recommendations
# Mark viewed access request recommendations
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
@@ -221,7 +221,7 @@ Code | Description | Data Type
}"@ # AccessRequestRecommendationActionItemDto[] | The recommended access items that were viewed for an identity.
# Bulk Mark Viewed Access Request Recommendations
# Bulk mark viewed access request recommendations
try {
$Result = ConvertFrom-JsonToAccessRequestRecommendationActionItemDto -Json $AccessRequestRecommendationActionItemDto
@@ -279,7 +279,7 @@ $IncludeTranslationMessages = $false # Boolean | If *true* it will populate a li
$Filters = 'access.name co "admin"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional)
$Sorters = "access.name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional)
# Identity Access Request Recommendations
# Identity access request recommendations
try {
Get-BetaAccessRequestRecommendations
@@ -332,7 +332,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Filters = 'identityId eq "2c9180846b0a0583016b299f210c1314"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional)
$Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional)
# List Ignored Access Request Recommendations
# List ignored access request recommendations
try {
Get-BetaAccessRequestRecommendationsIgnoredItems
@@ -385,7 +385,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Filters = 'access.id eq "2c9180846b0a0583016b299f210c1314"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional)
$Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional)
# List Accepted Access Request Recommendations
# List accepted access request recommendations
try {
Get-BetaAccessRequestRecommendationsRequestedItems
@@ -438,7 +438,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Filters = 'access.id eq "2c9180846b0a0583016b299f210c1314"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional)
$Sorters = "access.id" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **access.id, access.type, identityId, timestamp** (optional)
# List Viewed Access Request Recommendations
# List viewed access request recommendations
try {
Get-BetaAccessRequestRecommendationsViewedItems

4
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIMessageCatalogsApi.md
View File

@@ -17,7 +17,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-BetaMessageCatalogs**](#get-message-catalogs) | **GET** `/translation-catalogs/{catalog-id}` | Get Message catalogs
[**Get-BetaMessageCatalogs**](#get-message-catalogs) | **GET** `/translation-catalogs/{catalog-id}` | Get message catalogs
## get-message-catalogs
@@ -51,7 +51,7 @@ Code | Description | Data Type
```powershell
$CatalogId = "recommender" # String | The ID of the message catalog.
# Get Message catalogs
# Get message catalogs
try {
Get-BetaMessageCatalogs -CatalogId $CatalogId

24
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIOutliersApi.md
View File

@@ -17,15 +17,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Export-BetaOutliersZip**](#export-outliers-zip) | **GET** `/outliers/export` | IAI Identity Outliers Export
[**Get-BetaIdentityOutlierSnapshots**](#get-identity-outlier-snapshots) | **GET** `/outlier-summaries` | IAI Identity Outliers Summary
[**Get-BetaIdentityOutliers**](#get-identity-outliers) | **GET** `/outliers` | IAI Get Identity Outliers
[**Get-BetaLatestIdentityOutlierSnapshots**](#get-latest-identity-outlier-snapshots) | **GET** `/outlier-summaries/latest` | IAI Identity Outliers Latest Summary
[**Export-BetaOutliersZip**](#export-outliers-zip) | **GET** `/outliers/export` | Iai identity outliers export
[**Get-BetaIdentityOutlierSnapshots**](#get-identity-outlier-snapshots) | **GET** `/outlier-summaries` | Iai identity outliers summary
[**Get-BetaIdentityOutliers**](#get-identity-outliers) | **GET** `/outliers` | Iai get identity outliers
[**Get-BetaLatestIdentityOutlierSnapshots**](#get-latest-identity-outlier-snapshots) | **GET** `/outlier-summaries/latest` | Iai identity outliers latest summary
[**Get-BetaOutlierContributingFeatureSummary**](#get-outlier-contributing-feature-summary) | **GET** `/outlier-feature-summaries/{outlierFeatureId}` | Get identity outlier contibuting feature summary
[**Get-BetaPeerGroupOutliersContributingFeatures**](#get-peer-group-outliers-contributing-features) | **GET** `/outliers/{outlierId}/contributing-features` | Get identity outlier's contibuting features
[**Invoke-BetaIgnoreIdentityOutliers**](#ignore-identity-outliers) | **POST** `/outliers/ignore` | IAI Identity Outliers Ignore
[**Invoke-BetaIgnoreIdentityOutliers**](#ignore-identity-outliers) | **POST** `/outliers/ignore` | Iai identity outliers ignore
[**Get-BetaOutliersContributingFeatureAccessItems**](#list-outliers-contributing-feature-access-items) | **GET** `/outliers/{outlierId}/feature-details/{contributingFeatureName}/access-items` | Gets a list of access items associated with each identity outlier contributing feature
[**Invoke-BetaUnIgnoreIdentityOutliers**](#un-ignore-identity-outliers) | **POST** `/outliers/unignore` | IAI Identity Outliers Unignore
[**Invoke-BetaUnIgnoreIdentityOutliers**](#un-ignore-identity-outliers) | **POST** `/outliers/unignore` | Iai identity outliers unignore
## export-outliers-zip
@@ -62,7 +62,7 @@ Code | Description | Data Type
```powershell
$Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional)
# IAI Identity Outliers Export
# Iai identity outliers export
try {
Export-BetaOutliersZip
@@ -116,7 +116,7 @@ $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to fi
$Filters = 'snapshotDate ge "2022-02-07T20:13:29.356648026Z"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **snapshotDate**: *ge, le* (optional)
$Sorters = "snapshotDate" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **snapshotDate** (optional)
# IAI Identity Outliers Summary
# Iai identity outliers summary
try {
Get-BetaIdentityOutlierSnapshots
@@ -171,7 +171,7 @@ $Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to fi
$Filters = 'attributes.displayName sw "John" and certStatus eq "false"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **attributes**: *eq, sw, co, in* **firstDetectionDate**: *ge, le* **certStatus**: *eq* **ignored**: *eq* **score**: *ge, le* (optional)
$Sorters = "attributes.displayName,firstDetectionDate,-score" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **firstDetectionDate, attributes, score** (optional)
# IAI Get Identity Outliers
# Iai get identity outliers
try {
Get-BetaIdentityOutliers
@@ -217,7 +217,7 @@ Code | Description | Data Type
```powershell
$Type = "LOW_SIMILARITY" # String | Type of the identity outliers snapshot to filter on (optional)
# IAI Identity Outliers Latest Summary
# Iai identity outliers latest summary
try {
Get-BetaLatestIdentityOutlierSnapshots
@@ -372,7 +372,7 @@ $RequestBody = "MyRequestBody" # String[] |
$RequestBody = @""@ # String[] |
# IAI Identity Outliers Ignore
# Iai identity outliers ignore
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
@@ -481,7 +481,7 @@ $RequestBody = "MyRequestBody" # String[] |
$RequestBody = @""@ # String[] |
# IAI Identity Outliers Unignore
# Iai identity outliers unignore
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody

4
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIPeerGroupStrategiesApi.md
View File

@@ -17,7 +17,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-BetaPeerGroupOutliers**](#get-peer-group-outliers) | **GET** `/peer-group-strategies/{strategy}/identity-outliers` | Identity Outliers List
[**Get-BetaPeerGroupOutliers**](#get-peer-group-outliers) | **GET** `/peer-group-strategies/{strategy}/identity-outliers` | Identity outliers list
## get-peer-group-outliers
@@ -60,7 +60,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
# Identity Outliers List
# Identity outliers list
try {
Get-BetaPeerGroupOutliers -Strategy $Strategy

4
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIRecommendationsApi.md
View File

@@ -17,7 +17,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-BetaRecommendations**](#get-recommendations) | **POST** `/recommendations/request` | Returns Recommendation Based on Object
[**Get-BetaRecommendations**](#get-recommendations) | **POST** `/recommendations/request` | Returns recommendation based on object
[**Get-BetaRecommendationsConfig**](#get-recommendations-config) | **GET** `/recommendations/config` | Get certification recommendation config values
[**Update-BetaRecommendationsConfig**](#update-recommendations-config) | **PUT** `/recommendations/config` | Update certification recommendation config values
@@ -71,7 +71,7 @@ $RecommendationRequestDto = @"{
"includeDebugInformation" : true
}"@
# Returns Recommendation Based on Object
# Returns recommendation based on object
try {
$Result = ConvertFrom-JsonToRecommendationRequestDto -Json $RecommendationRequestDto

4
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIAIRoleMiningApi.md
View File

@@ -21,7 +21,7 @@ Method | HTTP request | Description
[**New-BetaRoleMiningSessions**](#create-role-mining-sessions) | **POST** `/role-mining-sessions` | Create a role mining session
[**Invoke-BetaDownloadRoleMiningPotentialRoleZip**](#download-role-mining-potential-role-zip) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download` | Export (download) details for a potential role in a role mining session
[**Export-BetaRoleMiningPotentialRole**](#export-role-mining-potential-role) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export` | Export (download) details for a potential role in a role mining session
[**Export-BetaRoleMiningPotentialRoleAsync**](#export-role-mining-potential-role-async) | **POST** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async` | Asynchronously export details for a potential role in a role mining session and upload to S3
[**Export-BetaRoleMiningPotentialRoleAsync**](#export-role-mining-potential-role-async) | **POST** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async` | Asynchronously export details for a potential role in a role mining session and upload to s3
[**Export-BetaRoleMiningPotentialRoleStatus**](#export-role-mining-potential-role-status) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}` | Retrieve status of a potential role export job
[**Get-BetaAllPotentialRoleSummaries**](#get-all-potential-role-summaries) | **GET** `/role-mining-potential-roles` | Retrieves all potential role summaries
[**Get-BetaEntitlementDistributionPotentialRole**](#get-entitlement-distribution-potential-role) | **GET** `/role-mining-sessions/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution` | Retrieves entitlement popularity distribution for a potential role in a role mining session
@@ -311,7 +311,7 @@ $RoleMiningPotentialRoleExportRequest = @"{
"includeCommonAccess" : true
}"@
# Asynchronously export details for a potential role in a role mining session and upload to S3
# Asynchronously export details for a potential role in a role mining session and upload to s3
try {
Export-BetaRoleMiningPotentialRoleAsync -SessionId $SessionId -PotentialRoleId $PotentialRoleId

12
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentitiesApi.md
View File

@@ -33,15 +33,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Remove-BetaIdentity**](#delete-identity) | **DELETE** `/identities/{id}` | Delete identity
[**Get-BetaIdentity**](#get-identity) | **GET** `/identities/{id}` | Identity Details
[**Get-BetaIdentity**](#get-identity) | **GET** `/identities/{id}` | Identity details
[**Get-BetaIdentityOwnershipDetails**](#get-identity-ownership-details) | **GET** `/identities/{identityId}/ownership` | Get ownership details
[**Get-BetaRoleAssignment**](#get-role-assignment) | **GET** `/identities/{identityId}/role-assignments/{assignmentId}` | Role assignment details
[**Get-BetaRoleAssignments**](#get-role-assignments) | **GET** `/identities/{identityId}/role-assignments` | List role assignments
[**Get-BetaIdentities**](#list-identities) | **GET** `/identities` | List Identities
[**Get-BetaIdentities**](#list-identities) | **GET** `/identities` | List identities
[**Reset-BetaIdentity**](#reset-identity) | **POST** `/identities/{identityId}/reset` | Reset an identity
[**Send-BetaIdentityVerificationAccountToken**](#send-identity-verification-account-token) | **POST** `/identities/{id}/verification/account/send` | Send password reset email
[**Start-BetaIdentitiesInvite**](#start-identities-invite) | **POST** `/identities/invite` | Invite identities to register
[**Start-BetaIdentityProcessing**](#start-identity-processing) | **POST** `/identities/process` | Process a list of identityIds
[**Start-BetaIdentityProcessing**](#start-identity-processing) | **POST** `/identities/process` | Process a list of identityids
[**Sync-BetahronizeAttributesForIdentity**](#synchronize-attributes-for-identity) | **POST** `/identities/{identityId}/synchronize-attributes` | Attribute synchronization for single identity.
@@ -123,7 +123,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | Identity Id
# Identity Details
# Identity details
try {
Get-BetaIdentity -Id $Id
@@ -324,7 +324,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
# List Identities
# List identities
try {
Get-BetaIdentities
@@ -536,7 +536,7 @@ $ProcessIdentitiesRequest = @"{
"identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ]
}"@
# Process a list of identityIds
# Process a list of identityids
try {
$Result = ConvertFrom-JsonToProcessIdentitiesRequest -Json $ProcessIdentitiesRequest

24
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityAttributesApi.md
View File

@@ -17,12 +17,12 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-BetaIdentityAttribute**](#create-identity-attribute) | **POST** `/identity-attributes` | Create Identity Attribute
[**Remove-BetaIdentityAttribute**](#delete-identity-attribute) | **DELETE** `/identity-attributes/{name}` | Delete Identity Attribute
[**Remove-BetaIdentityAttributesInBulk**](#delete-identity-attributes-in-bulk) | **DELETE** `/identity-attributes/bulk-delete` | Bulk delete Identity Attributes
[**Get-BetaIdentityAttribute**](#get-identity-attribute) | **GET** `/identity-attributes/{name}` | Get Identity Attribute
[**Get-BetaIdentityAttributes**](#list-identity-attributes) | **GET** `/identity-attributes` | List Identity Attributes
[**Send-BetaIdentityAttribute**](#put-identity-attribute) | **PUT** `/identity-attributes/{name}` | Update Identity Attribute
[**New-BetaIdentityAttribute**](#create-identity-attribute) | **POST** `/identity-attributes` | Create identity attribute
[**Remove-BetaIdentityAttribute**](#delete-identity-attribute) | **DELETE** `/identity-attributes/{name}` | Delete identity attribute
[**Remove-BetaIdentityAttributesInBulk**](#delete-identity-attributes-in-bulk) | **DELETE** `/identity-attributes/bulk-delete` | Bulk delete identity attributes
[**Get-BetaIdentityAttribute**](#get-identity-attribute) | **GET** `/identity-attributes/{name}` | Get identity attribute
[**Get-BetaIdentityAttributes**](#list-identity-attributes) | **GET** `/identity-attributes` | List identity attributes
[**Send-BetaIdentityAttribute**](#put-identity-attribute) | **PUT** `/identity-attributes/{name}` | Update identity attribute
## create-identity-attribute
@@ -78,7 +78,7 @@ $IdentityAttribute = @"{
"multi" : false
}"@
# Create Identity Attribute
# Create identity attribute
try {
$Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute
@@ -125,7 +125,7 @@ Code | Description | Data Type
```powershell
$Name = "displayName" # String | The attribute's technical name.
# Delete Identity Attribute
# Delete identity attribute
try {
Remove-BetaIdentityAttribute -Name $Name
@@ -173,7 +173,7 @@ $IdentityAttributeNames = @"{
"ids" : [ "name", "displayName" ]
}"@
# Bulk delete Identity Attributes
# Bulk delete identity attributes
try {
$Result = ConvertFrom-JsonToIdentityAttributeNames -Json $IdentityAttributeNames
@@ -220,7 +220,7 @@ Code | Description | Data Type
```powershell
$Name = "displayName" # String | The attribute's technical name.
# Get Identity Attribute
# Get identity attribute
try {
Get-BetaIdentityAttribute -Name $Name
@@ -271,7 +271,7 @@ $IncludeSilent = $false # Boolean | Include 'silent' attributes in the response.
$SearchableOnly = $false # Boolean | Include only 'searchable' attributes in the response. (optional) (default to $false)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
# List Identity Attributes
# List identity attributes
try {
Get-BetaIdentityAttributes
@@ -340,7 +340,7 @@ $IdentityAttribute = @"{
"multi" : false
}"@
# Update Identity Attribute
# Update identity attribute
try {
$Result = ConvertFrom-JsonToIdentityAttribute -Json $IdentityAttribute

12
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityHistoryApi.md
View File

@@ -18,15 +18,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Compare-BetaIdentitySnapshots**](#compare-identity-snapshots) | **GET** `/historical-identities/{id}/compare` | Gets a difference of count for each access item types for the given identity between 2 snapshots
[**Compare-BetaIdentitySnapshotsAccessType**](#compare-identity-snapshots-access-type) | **GET** `/historical-identities/{id}/compare/{accessType}` | Gets a list of differences of specific accessType for the given identity between 2 snapshots
[**Compare-BetaIdentitySnapshotsAccessType**](#compare-identity-snapshots-access-type) | **GET** `/historical-identities/{id}/compare/{accessType}` | Gets a list of differences of specific accesstype for the given identity between 2 snapshots
[**Get-BetaHistoricalIdentity**](#get-historical-identity) | **GET** `/historical-identities/{id}` | Get latest snapshot of identity
[**Get-BetaHistoricalIdentityEvents**](#get-historical-identity-events) | **GET** `/historical-identities/{id}/events` | Lists all events for the given identity
[**Get-BetaIdentitySnapshot**](#get-identity-snapshot) | **GET** `/historical-identities/{id}/snapshots/{date}` | Gets an identity snapshot at a given date
[**Get-BetaIdentitySnapshotSummary**](#get-identity-snapshot-summary) | **GET** `/historical-identities/{id}/snapshot-summary` | Gets the summary for the event count for a specific identity
[**Get-BetaIdentityStartDate**](#get-identity-start-date) | **GET** `/historical-identities/{id}/start-date` | Gets the start date of the identity
[**Get-BetaHistoricalIdentities**](#list-historical-identities) | **GET** `/historical-identities` | Lists all the identities
[**Get-BetaIdentityAccessItems**](#list-identity-access-items) | **GET** `/historical-identities/{id}/access-items` | List Access Items by Identity
[**Get-BetaIdentitySnapshotAccessItems**](#list-identity-snapshot-access-items) | **GET** `/historical-identities/{id}/snapshots/{date}/access-items` | Get Identity Access Items Snapshot
[**Get-BetaIdentityAccessItems**](#list-identity-access-items) | **GET** `/historical-identities/{id}/access-items` | List access items by identity
[**Get-BetaIdentitySnapshotAccessItems**](#list-identity-snapshot-access-items) | **GET** `/historical-identities/{id}/snapshots/{date}/access-items` | Get identity access items snapshot
[**Get-BetaIdentitySnapshots**](#list-identity-snapshots) | **GET** `/historical-identities/{id}/snapshots` | Lists all the snapshots for the identity
@@ -134,7 +134,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
# Gets a list of differences of specific accessType for the given identity between 2 snapshots
# Gets a list of differences of specific accesstype for the given identity between 2 snapshots
try {
Compare-BetaIdentitySnapshotsAccessType -Id $Id -AccessType $AccessType
@@ -503,7 +503,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
# List Access Items by Identity
# List access items by identity
try {
Get-BetaIdentityAccessItems -Id $Id
@@ -553,7 +553,7 @@ $Id = "8c190e6787aa4ed9a90bd9d5344523fb" # String | Identity ID.
$Date = "2007-03-01T13:00:00Z" # String | Specified date.
$Type = "role" # String | Access item type. (optional)
# Get Identity Access Items Snapshot
# Get identity access items snapshot
try {
Get-BetaIdentitySnapshotAccessItems -Id $Id -Date $Date

36
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaIdentityProfilesApi.md
View File

@@ -28,17 +28,17 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-BetaIdentityProfile**](#create-identity-profile) | **POST** `/identity-profiles` | Create Identity Profile
[**Remove-BetaIdentityProfile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete Identity Profile
[**Remove-BetaIdentityProfiles**](#delete-identity-profiles) | **POST** `/identity-profiles/bulk-delete` | Delete Identity Profiles
[**Export-BetaIdentityProfiles**](#export-identity-profiles) | **GET** `/identity-profiles/export` | Export Identity Profiles
[**New-BetaIdentityProfile**](#create-identity-profile) | **POST** `/identity-profiles` | Create identity profile
[**Remove-BetaIdentityProfile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete identity profile
[**Remove-BetaIdentityProfiles**](#delete-identity-profiles) | **POST** `/identity-profiles/bulk-delete` | Delete identity profiles
[**Export-BetaIdentityProfiles**](#export-identity-profiles) | **GET** `/identity-profiles/export` | Export identity profiles
[**Get-BetaDefaultIdentityAttributeConfig**](#get-default-identity-attribute-config) | **GET** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Default identity attribute config
[**Get-BetaIdentityProfile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Get Identity Profile
[**Import-BetaIdentityProfiles**](#import-identity-profiles) | **POST** `/identity-profiles/import` | Import Identity Profiles
[**Get-BetaIdentityProfiles**](#list-identity-profiles) | **GET** `/identity-profiles` | List Identity Profiles
[**Show-BetaGenerateIdentityPreview**](#show-generate-identity-preview) | **POST** `/identity-profiles/identity-preview` | Generate Identity Profile Preview
[**Get-BetaIdentityProfile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Get identity profile
[**Import-BetaIdentityProfiles**](#import-identity-profiles) | **POST** `/identity-profiles/import` | Import identity profiles
[**Get-BetaIdentityProfiles**](#list-identity-profiles) | **GET** `/identity-profiles` | List identity profiles
[**Show-BetaGenerateIdentityPreview**](#show-generate-identity-preview) | **POST** `/identity-profiles/identity-preview` | Generate identity profile preview
[**Sync-BetaIdentityProfile**](#sync-identity-profile) | **POST** `/identity-profiles/{identity-profile-id}/process-identities` | Process identities under profile
[**Update-BetaIdentityProfile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update Identity Profile
[**Update-BetaIdentityProfile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update identity profile
## create-identity-profile
@@ -121,7 +121,7 @@ $IdentityProfile = @"{
"id" : "id12345"
}"@
# Create Identity Profile
# Create identity profile
try {
$Result = ConvertFrom-JsonToIdentityProfile -Json $IdentityProfile
@@ -170,7 +170,7 @@ Code | Description | Data Type
```powershell
$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID.
# Delete Identity Profile
# Delete identity profile
try {
Remove-BetaIdentityProfile -IdentityProfileId $IdentityProfileId
@@ -223,7 +223,7 @@ $RequestBody = "MyRequestBody" # String[] | Identity Profile bulk delete request
$RequestBody = @""@ # String[] | Identity Profile bulk delete request body.
# Delete Identity Profiles
# Delete identity profiles
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
@@ -278,7 +278,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Filters = 'id eq 8c190e6787aa4ed9a90bd9d5344523fb' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne* **name**: *eq, ne* **priority**: *eq, ne* (optional)
$Sorters = "name,-priority" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority** (optional)
# Export Identity Profiles
# Export identity profiles
try {
Export-BetaIdentityProfiles
@@ -372,7 +372,7 @@ Code | Description | Data Type
```powershell
$IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity profile ID.
# Get Identity Profile
# Get identity profile
try {
Get-BetaIdentityProfile -IdentityProfileId $IdentityProfileId
@@ -479,7 +479,7 @@ Code | Description | Data Type
}"@ # IdentityProfileExportedObject[] | Previously exported Identity Profiles.
# Import Identity Profiles
# Import identity profiles
try {
$Result = ConvertFrom-JsonToIdentityProfileExportedObject -Json $IdentityProfileExportedObject
@@ -534,7 +534,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Filters = 'id eq 8c190e6787aa4ed9a90bd9d5344523fb' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional)
$Sorters = "name,-priority" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional)
# List Identity Profiles
# List identity profiles
try {
Get-BetaIdentityProfiles
@@ -607,7 +607,7 @@ $IdentityPreviewRequest = @"{
}
}"@
# Generate Identity Profile Preview
# Generate identity profile preview
try {
$Result = ConvertFrom-JsonToIdentityPreviewRequest -Json $IdentityPreviewRequest
@@ -720,7 +720,7 @@ $IdentityProfileId = "ef38f94347e94562b5bb8424a56397d8" # String | Identity prof
}"@ # JsonPatchOperation[] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
# Update Identity Profile
# Update identity profile
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation

20
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaLaunchersApi.md
View File

@@ -21,11 +21,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-BetaLauncher**](#create-launcher) | **POST** `/launchers` | Create launcher
[**Remove-BetaLauncher**](#delete-launcher) | **DELETE** `/launchers/{launcherID}` | Delete Launcher
[**Get-BetaLauncher**](#get-launcher) | **GET** `/launchers/{launcherID}` | Get Launcher by ID
[**Get-BetaLaunchers**](#get-launchers) | **GET** `/launchers` | List all Launchers for tenant
[**Send-BetaLauncher**](#put-launcher) | **PUT** `/launchers/{launcherID}` | Replace Launcher
[**Start-BetaLauncher**](#start-launcher) | **POST** `/beta/launchers/{launcherID}/launch` | Launch a Launcher
[**Remove-BetaLauncher**](#delete-launcher) | **DELETE** `/launchers/{launcherID}` | Delete launcher
[**Get-BetaLauncher**](#get-launcher) | **GET** `/launchers/{launcherID}` | Get launcher by id
[**Get-BetaLaunchers**](#get-launchers) | **GET** `/launchers` | List all launchers for tenant
[**Send-BetaLauncher**](#put-launcher) | **PUT** `/launchers/{launcherID}` | Replace launcher
[**Start-BetaLauncher**](#start-launcher) | **POST** `/beta/launchers/{launcherID}/launch` | Launch a launcher
## create-launcher
@@ -117,7 +117,7 @@ Code | Description | Data Type
```powershell
$LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be deleted
# Delete Launcher
# Delete launcher
try {
Remove-BetaLauncher -LauncherID $LauncherID
@@ -163,7 +163,7 @@ Code | Description | Data Type
```powershell
$LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be retrieved
# Get Launcher by ID
# Get launcher by id
try {
Get-BetaLauncher -LauncherID $LauncherID
@@ -213,7 +213,7 @@ $Filters = 'disabled eq "true"' # String | Filter results using the standard syn
$Next = "eyJuZXh0IjoxMjN9Cg==" # String | Pagination marker (optional)
$Limit = 42 # Int32 | Number of Launchers to return (optional) (default to 10)
# List all Launchers for tenant
# List all launchers for tenant
try {
Get-BetaLaunchers
@@ -271,7 +271,7 @@ $LauncherRequest = @"{
"config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}"
}"@
# Replace Launcher
# Replace launcher
try {
$Result = ConvertFrom-JsonToLauncherRequest -Json $LauncherRequest
@@ -318,7 +318,7 @@ Code | Description | Data Type
```powershell
$LauncherID = "e3012408-8b61-4564-ad41-c5ec131c325b" # String | ID of the Launcher to be launched
# Launch a Launcher
# Launch a launcher
try {
Start-BetaLauncher -LauncherID $LauncherID

8
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaLifecycleStatesApi.md
View File

@@ -53,8 +53,8 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-BetaLifecycleStates**](#get-lifecycle-states) | **GET** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Get Lifecycle State
[**Update-BetaLifecycleStates**](#update-lifecycle-states) | **PATCH** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update Lifecycle State
[**Get-BetaLifecycleStates**](#get-lifecycle-states) | **GET** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Get lifecycle state
[**Update-BetaLifecycleStates**](#update-lifecycle-states) | **PATCH** `/identity-profiles/{identity-profile-id}/lifecycle-states/{lifecycle-state-id}` | Update lifecycle state
## get-lifecycle-states
@@ -93,7 +93,7 @@ Code | Description | Data Type
$IdentityProfileId = "2b838de9-db9b-abcf-e646-d4f274ad4238" # String | Identity Profile ID.
$LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle State ID.
# Get Lifecycle State
# Get lifecycle state
try {
Get-BetaLifecycleStates -IdentityProfileId $IdentityProfileId -LifecycleStateId $LifecycleStateId
@@ -150,7 +150,7 @@ $LifecycleStateId = "ef38f94347e94562b5bb8424a56397d8" # String | Lifecycle Stat
}"@ # JsonPatchOperation[] | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption
# Update Lifecycle State
# Update lifecycle state
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation

32
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaMFAConfigurationApi.md
View File

@@ -17,14 +17,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Remove-BetaMFAConfig**](#delete-mfa-config) | **DELETE** `/mfa/{method}/delete` | Delete MFA method configuration
[**Get-BetaMFADuoConfig**](#get-mfa-duo-config) | **GET** `/mfa/duo-web/config` | Configuration of Duo MFA method
[**Get-BetaMFAKbaConfig**](#get-mfa-kba-config) | **GET** `/mfa/kba/config` | Configuration of KBA MFA method
[**Get-BetaMFAOktaConfig**](#get-mfa-okta-config) | **GET** `/mfa/okta-verify/config` | Configuration of Okta MFA method
[**Set-BetaMFADuoConfig**](#set-mfa-duo-config) | **PUT** `/mfa/duo-web/config` | Set Duo MFA configuration
[**Set-BetaMFAKBAConfig**](#set-mfakba-config) | **POST** `/mfa/kba/config/answers` | Set MFA KBA configuration
[**Set-BetaMFAOktaConfig**](#set-mfa-okta-config) | **PUT** `/mfa/okta-verify/config` | Set Okta MFA configuration
[**Test-BetaMFAConfig**](#test-mfa-config) | **GET** `/mfa/{method}/test` | MFA method's test configuration
[**Remove-BetaMFAConfig**](#delete-mfa-config) | **DELETE** `/mfa/{method}/delete` | Delete mfa method configuration
[**Get-BetaMFADuoConfig**](#get-mfa-duo-config) | **GET** `/mfa/duo-web/config` | Configuration of duo mfa method
[**Get-BetaMFAKbaConfig**](#get-mfa-kba-config) | **GET** `/mfa/kba/config` | Configuration of kba mfa method
[**Get-BetaMFAOktaConfig**](#get-mfa-okta-config) | **GET** `/mfa/okta-verify/config` | Configuration of okta mfa method
[**Set-BetaMFADuoConfig**](#set-mfa-duo-config) | **PUT** `/mfa/duo-web/config` | Set duo mfa configuration
[**Set-BetaMFAKBAConfig**](#set-mfakba-config) | **POST** `/mfa/kba/config/answers` | Set mfa kba configuration
[**Set-BetaMFAOktaConfig**](#set-mfa-okta-config) | **PUT** `/mfa/okta-verify/config` | Set okta mfa configuration
[**Test-BetaMFAConfig**](#test-mfa-config) | **GET** `/mfa/{method}/test` | Mfa method's test configuration
## delete-mfa-config
@@ -58,7 +58,7 @@ Code | Description | Data Type
```powershell
$Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'.
# Delete MFA method configuration
# Delete mfa method configuration
try {
Remove-BetaMFAConfig -Method $Method
@@ -101,7 +101,7 @@ Code | Description | Data Type
### Example
```powershell
# Configuration of Duo MFA method
# Configuration of duo mfa method
try {
Get-BetaMFADuoConfig
@@ -146,7 +146,7 @@ Code | Description | Data Type
```powershell
$AllLanguages = $false # Boolean | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional)
# Configuration of KBA MFA method
# Configuration of kba mfa method
try {
Get-BetaMFAKbaConfig
@@ -189,7 +189,7 @@ Code | Description | Data Type
### Example
```powershell
# Configuration of Okta MFA method
# Configuration of okta mfa method
try {
Get-BetaMFAOktaConfig
@@ -244,7 +244,7 @@ $MfaDuoConfig = @"{
"identityAttribute" : "email"
}"@
# Set Duo MFA configuration
# Set duo mfa configuration
try {
$Result = ConvertFrom-JsonToMfaDuoConfig -Json $MfaDuoConfig
@@ -294,7 +294,7 @@ Code | Description | Data Type
}"@ # KbaAnswerRequestItem[] |
# Set MFA KBA configuration
# Set mfa kba configuration
try {
$Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem
@@ -346,7 +346,7 @@ $MfaOktaConfig = @"{
"identityAttribute" : "email"
}"@
# Set Okta MFA configuration
# Set okta mfa configuration
try {
$Result = ConvertFrom-JsonToMfaOktaConfig -Json $MfaOktaConfig
@@ -392,7 +392,7 @@ Code | Description | Data Type
```powershell
$Method = "okta-verify" # String | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'.
# MFA method's test configuration
# Mfa method's test configuration
try {
Test-BetaMFAConfig -Method $Method

20
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaMFAControllerApi.md
View File

@@ -18,11 +18,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-BetaSendToken**](#create-send-token) | **POST** `/mfa/token/send` | Create and send user token
[**Ping-BetaVerificationStatus**](#ping-verification-status) | **POST** `/mfa/{method}/poll` | Polling MFA method by VerificationPollRequest
[**Send-BetaDuoVerifyRequest**](#send-duo-verify-request) | **POST** `/mfa/duo-web/verify` | Verifying authentication via Duo method
[**Send-BetaKbaAnswers**](#send-kba-answers) | **POST** `/mfa/kba/authenticate` | Authenticate KBA provided MFA method
[**Send-BetaOktaVerifyRequest**](#send-okta-verify-request) | **POST** `/mfa/okta-verify/verify` | Verifying authentication via Okta method
[**Send-BetaTokenAuthRequest**](#send-token-auth-request) | **POST** `/mfa/token/authenticate` | Authenticate Token provided MFA method
[**Ping-BetaVerificationStatus**](#ping-verification-status) | **POST** `/mfa/{method}/poll` | Polling mfa method by verificationpollrequest
[**Send-BetaDuoVerifyRequest**](#send-duo-verify-request) | **POST** `/mfa/duo-web/verify` | Verifying authentication via duo method
[**Send-BetaKbaAnswers**](#send-kba-answers) | **POST** `/mfa/kba/authenticate` | Authenticate kba provided mfa method
[**Send-BetaOktaVerifyRequest**](#send-okta-verify-request) | **POST** `/mfa/okta-verify/verify` | Verifying authentication via okta method
[**Send-BetaTokenAuthRequest**](#send-token-auth-request) | **POST** `/mfa/token/authenticate` | Authenticate token provided mfa method
## create-send-token
@@ -109,7 +109,7 @@ $VerificationPollRequest = @"{
"requestId" : "089899f13a8f4da7824996191587bab9"
}"@
# Polling MFA method by VerificationPollRequest
# Polling mfa method by verificationpollrequest
try {
$Result = ConvertFrom-JsonToVerificationPollRequest -Json $VerificationPollRequest
@@ -158,7 +158,7 @@ $DuoVerificationRequest = @"{
"userId" : "2c9180947f0ef465017f215cbcfd004b"
}"@
# Verifying authentication via Duo method
# Verifying authentication via duo method
try {
$Result = ConvertFrom-JsonToDuoVerificationRequest -Json $DuoVerificationRequest
@@ -208,7 +208,7 @@ Code | Description | Data Type
}"@ # KbaAnswerRequestItem[] |
# Authenticate KBA provided MFA method
# Authenticate kba provided mfa method
try {
$Result = ConvertFrom-JsonToKbaAnswerRequestItem -Json $KbaAnswerRequestItem
@@ -256,7 +256,7 @@ $OktaVerificationRequest = @"{
"userId" : "example@mail.com"
}"@
# Verifying authentication via Okta method
# Verifying authentication via okta method
try {
$Result = ConvertFrom-JsonToOktaVerificationRequest -Json $OktaVerificationRequest
@@ -306,7 +306,7 @@ $TokenAuthRequest = @"{
"token" : "12345"
}"@
# Authenticate Token provided MFA method
# Authenticate token provided mfa method
try {
$Result = ConvertFrom-JsonToTokenAuthRequest -Json $TokenAuthRequest

4
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaManagedClientsApi.md
View File

@@ -19,7 +19,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-BetaManagedClientStatus**](#get-managed-client-status) | **GET** `/managed-clients/{id}/status` | Specified Managed Client Status.
[**Get-BetaManagedClientStatus**](#get-managed-client-status) | **GET** `/managed-clients/{id}/status` | Specified managed client status.
[**Update-BetaManagedClientStatus**](#update-managed-client-status) | **POST** `/managed-clients/{id}/status` | Handle status request from client
@@ -60,7 +60,7 @@ Code | Description | Data Type
$Id = "aClientId" # String | ID of the Managed Client Status to get
$Type = "CCG" # ManagedClientType | Type of the Managed Client Status to get
# Specified Managed Client Status.
# Specified managed client status.
try {
Get-BetaManagedClientStatus -Id $Id -Type $Type

8
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaManagedClustersApi.md
View File

@@ -20,8 +20,8 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-BetaClientLogConfiguration**](#get-client-log-configuration) | **GET** `/managed-clusters/{id}/log-config` | Get managed cluster's log configuration
[**Get-BetaManagedCluster**](#get-managed-cluster) | **GET** `/managed-clusters/{id}` | Get a specified ManagedCluster.
[**Get-BetaManagedClusters**](#get-managed-clusters) | **GET** `/managed-clusters` | Retrieve all Managed Clusters.
[**Get-BetaManagedCluster**](#get-managed-cluster) | **GET** `/managed-clusters/{id}` | Get a specified managedcluster.
[**Get-BetaManagedClusters**](#get-managed-clusters) | **GET** `/managed-clusters` | Retrieve all managed clusters.
[**Send-BetaClientLogConfiguration**](#put-client-log-configuration) | **PUT** `/managed-clusters/{id}/log-config` | Update managed cluster's log configuration
@@ -109,7 +109,7 @@ Code | Description | Data Type
```powershell
$Id = "aClusterId" # String | ID of the ManagedCluster to get
# Get a specified ManagedCluster.
# Get a specified managedcluster.
try {
Get-BetaManagedCluster -Id $Id
@@ -163,7 +163,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = 'operational eq operation' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **operational**: *eq* (optional)
# Retrieve all Managed Clusters.
# Retrieve all managed clusters.
try {
Get-BetaManagedClusters

52
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaMultiHostIntegrationApi.md
View File

@@ -20,19 +20,19 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-BetaMultiHostIntegration**](#create-multi-host-integration) | **POST** `/multihosts` | Create Multi-Host Integration
[**New-BetaSourcesWithinMultiHost**](#create-sources-within-multi-host) | **POST** `/multihosts/{multihostId}` | Create Sources Within Multi-Host Integration
[**Remove-BetaMultiHost**](#delete-multi-host) | **DELETE** `/multihosts/{multihostId}` | Delete Multi-Host Integration
[**Get-BetaAcctAggregationGroups**](#get-acct-aggregation-groups) | **GET** `/multihosts/{multihostId}/acctAggregationGroups` | Get Account Aggregation Groups Within Multi-Host Integration ID
[**Get-BetaEntitlementAggregationGroups**](#get-entitlement-aggregation-groups) | **GET** `/multihosts/{multiHostId}/entitlementAggregationGroups` | Get Entitlement Aggregation Groups Within Multi-Host Integration ID
[**Get-BetaMultiHostIntegrations**](#get-multi-host-integrations) | **GET** `/multihosts/{multihostId}` | Get Multi-Host Integration By ID
[**Get-BetaMultiHostIntegrationsList**](#get-multi-host-integrations-list) | **GET** `/multihosts` | List All Existing Multi-Host Integrations
[**Get-BetaMultiHostSourceCreationErrors**](#get-multi-host-source-creation-errors) | **GET** `/multihosts/{multiHostId}/sources/errors` | List Multi-Host Source Creation Errors
[**Get-BetaMultihostIntegrationTypes**](#get-multihost-integration-types) | **GET** `/multihosts/types` | List Multi-Host Integration Types
[**Get-BetaSourcesWithinMultiHost**](#get-sources-within-multi-host) | **GET** `/multihosts/{multihostId}/sources` | List Sources Within Multi-Host Integration
[**Test-BetaConnectionMultiHostSources**](#test-connection-multi-host-sources) | **POST** `/multihosts/{multihostId}/sources/testConnection` | Test Configuration For Multi-Host Integration
[**Test-BetaSourceConnectionMultihost**](#test-source-connection-multihost) | **GET** `/multihosts/{multihostId}/sources/{sourceId}/testConnection` | Test Configuration For Multi-Host Integration's Single Source
[**Update-BetaMultiHostSources**](#update-multi-host-sources) | **PATCH** `/multihosts/{multihostId}` | Update Multi-Host Integration
[**New-BetaMultiHostIntegration**](#create-multi-host-integration) | **POST** `/multihosts` | Create multi-host integration
[**New-BetaSourcesWithinMultiHost**](#create-sources-within-multi-host) | **POST** `/multihosts/{multihostId}` | Create sources within multi-host integration
[**Remove-BetaMultiHost**](#delete-multi-host) | **DELETE** `/multihosts/{multihostId}` | Delete multi-host integration
[**Get-BetaAcctAggregationGroups**](#get-acct-aggregation-groups) | **GET** `/multihosts/{multihostId}/acctAggregationGroups` | Get account aggregation groups within multi-host integration id
[**Get-BetaEntitlementAggregationGroups**](#get-entitlement-aggregation-groups) | **GET** `/multihosts/{multiHostId}/entitlementAggregationGroups` | Get entitlement aggregation groups within multi-host integration id
[**Get-BetaMultiHostIntegrations**](#get-multi-host-integrations) | **GET** `/multihosts/{multihostId}` | Get multi-host integration by id
[**Get-BetaMultiHostIntegrationsList**](#get-multi-host-integrations-list) | **GET** `/multihosts` | List all existing multi-host integrations
[**Get-BetaMultiHostSourceCreationErrors**](#get-multi-host-source-creation-errors) | **GET** `/multihosts/{multiHostId}/sources/errors` | List multi-host source creation errors
[**Get-BetaMultihostIntegrationTypes**](#get-multihost-integration-types) | **GET** `/multihosts/types` | List multi-host integration types
[**Get-BetaSourcesWithinMultiHost**](#get-sources-within-multi-host) | **GET** `/multihosts/{multihostId}/sources` | List sources within multi-host integration
[**Test-BetaConnectionMultiHostSources**](#test-connection-multi-host-sources) | **POST** `/multihosts/{multihostId}/sources/testConnection` | Test configuration for multi-host integration
[**Test-BetaSourceConnectionMultihost**](#test-source-connection-multihost) | **GET** `/multihosts/{multihostId}/sources/{sourceId}/testConnection` | Test configuration for multi-host integration's single source
[**Update-BetaMultiHostSources**](#update-multi-host-sources) | **PATCH** `/multihosts/{multihostId}` | Update multi-host integration
## create-multi-host-integration
@@ -94,7 +94,7 @@ $MultiHostIntegrationsCreate = @"{
"modified" : "2024-01-23T18:08:50.897Z"
}"@
# Create Multi-Host Integration
# Create multi-host integration
try {
$Result = ConvertFrom-JsonToMultiHostIntegrationsCreate -Json $MultiHostIntegrationsCreate
@@ -157,7 +157,7 @@ $MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Hos
}"@ # MultiHostIntegrationsCreateSources[] | The specifics of the sources to create within Multi-Host Integration.
# Create Sources Within Multi-Host Integration
# Create sources within multi-host integration
try {
$Result = ConvertFrom-JsonToMultiHostIntegrationsCreateSources -Json $MultiHostIntegrationsCreateSources
@@ -206,7 +206,7 @@ Code | Description | Data Type
```powershell
$MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of Multi-Host Integration to delete.
# Delete Multi-Host Integration
# Delete multi-host integration
try {
Remove-BetaMultiHost -MultihostId $MultihostId
@@ -254,7 +254,7 @@ Code | Description | Data Type
```powershell
$MultihostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update
# Get Account Aggregation Groups Within Multi-Host Integration ID
# Get account aggregation groups within multi-host integration id
try {
Get-BetaAcctAggregationGroups -MultihostId $MultihostId
@@ -302,7 +302,7 @@ Code | Description | Data Type
```powershell
$MultiHostId = "aMultiHostId" # String | ID of the Multi-Host Integration to update
# Get Entitlement Aggregation Groups Within Multi-Host Integration ID
# Get entitlement aggregation groups within multi-host integration id
try {
Get-BetaEntitlementAggregationGroups -MultiHostId $MultiHostId
@@ -350,7 +350,7 @@ Code | Description | Data Type
```powershell
$MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration.
# Get Multi-Host Integration By ID
# Get multi-host integration by id
try {
Get-BetaMultiHostIntegrations -MultihostId $MultihostId
@@ -408,7 +408,7 @@ $Filters = 'id eq 2c91808b6ef1d43e016efba0ce470904' # String | Filter results us
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$ForSubadmin = "5168015d32f890ca15812c9180835d2e" # String | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity or SOURCE_SUBADMIN identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional)
# List All Existing Multi-Host Integrations
# List all existing multi-host integrations
try {
Get-BetaMultiHostIntegrationsList
@@ -456,7 +456,7 @@ Code | Description | Data Type
```powershell
$MultiHostId = "004091cb79b04636b88662afa50a4440" # String | ID of the Multi-Host Integration
# List Multi-Host Source Creation Errors
# List multi-host source creation errors
try {
Get-BetaMultiHostSourceCreationErrors -MultiHostId $MultiHostId
@@ -502,7 +502,7 @@ Code | Description | Data Type
### Example
```powershell
# List Multi-Host Integration Types
# List multi-host integration types
try {
Get-BetaMultihostIntegrationTypes
@@ -560,7 +560,7 @@ $Sorters = "name" # String | Sort results using the standard syntax described in
$Filters = 'id eq 2c91808b6ef1d43e016efba0ce470904' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *in* (optional)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
# List Sources Within Multi-Host Integration
# List sources within multi-host integration
try {
Get-BetaSourcesWithinMultiHost -MultihostId $MultihostId
@@ -608,7 +608,7 @@ Code | Description | Data Type
```powershell
$MultihostId = "2c91808568c529c60168cca6f90c1324" # String | ID of the Multi-Host Integration
# Test Configuration For Multi-Host Integration
# Test configuration for multi-host integration
try {
Test-BetaConnectionMultiHostSources -MultihostId $MultihostId
@@ -658,7 +658,7 @@ Code | Description | Data Type
$MultihostId = "2c91808568c529c60168cca6f90c1326" # String | ID of the Multi-Host Integration
$SourceId = "2c91808568c529f60168cca6f90c1324" # String | ID of the source within the Multi-Host Integration
# Test Configuration For Multi-Host Integration's Single Source
# Test configuration for multi-host integration's single source
try {
Test-BetaSourceConnectionMultihost -MultihostId $MultihostId -SourceId $SourceId
@@ -709,7 +709,7 @@ $MultihostId = "anId" # String | ID of the Multi-Host Integration to update.
$UpdateMultiHostSourcesRequestInner = @"[{op=add, path=/description, value=MDK Multi-Host Integration 222 description}]"@ # UpdateMultiHostSourcesRequestInner[] | This endpoint allows you to update a Multi-Host Integration.
# Update Multi-Host Integration
# Update multi-host integration
try {
$Result = ConvertFrom-JsonToUpdateMultiHostSourcesRequestInner -Json $UpdateMultiHostSourcesRequestInner

116
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaNonEmployeeLifecycleManagementApi.md
View File

@@ -48,38 +48,38 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Approve-BetaNonEmployeeRequest**](#approve-non-employee-request) | **POST** `/non-employee-approvals/{id}/approve` | Approve a Non-Employee Request
[**New-BetaNonEmployeeRecord**](#create-non-employee-record) | **POST** `/non-employee-records` | Create Non-Employee Record
[**New-BetaNonEmployeeRequest**](#create-non-employee-request) | **POST** `/non-employee-requests` | Create Non-Employee Request
[**New-BetaNonEmployeeSource**](#create-non-employee-source) | **POST** `/non-employee-sources` | Create Non-Employee Source
[**New-BetaNonEmployeeSourceSchemaAttributes**](#create-non-employee-source-schema-attributes) | **POST** `/non-employee-sources/{sourceId}/schema-attributes` | Create Non-Employee Source Schema Attribute
[**Remove-BetaNonEmployeeRecord**](#delete-non-employee-record) | **DELETE** `/non-employee-records/{id}` | Delete Non-Employee Record
[**Remove-BetaNonEmployeeRecordInBulk**](#delete-non-employee-record-in-bulk) | **POST** `/non-employee-records/bulk-delete` | Delete Multiple Non-Employee Records
[**Remove-BetaNonEmployeeRequest**](#delete-non-employee-request) | **DELETE** `/non-employee-requests/{id}` | Delete Non-Employee Request
[**Remove-BetaNonEmployeeSchemaAttribute**](#delete-non-employee-schema-attribute) | **DELETE** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Delete Non-Employee Source's Schema Attribute
[**Remove-BetaNonEmployeeSource**](#delete-non-employee-source) | **DELETE** `/non-employee-sources/{sourceId}` | Delete Non-Employee Source
[**Approve-BetaNonEmployeeRequest**](#approve-non-employee-request) | **POST** `/non-employee-approvals/{id}/approve` | Approve a non-employee request
[**New-BetaNonEmployeeRecord**](#create-non-employee-record) | **POST** `/non-employee-records` | Create non-employee record
[**New-BetaNonEmployeeRequest**](#create-non-employee-request) | **POST** `/non-employee-requests` | Create non-employee request
[**New-BetaNonEmployeeSource**](#create-non-employee-source) | **POST** `/non-employee-sources` | Create non-employee source
[**New-BetaNonEmployeeSourceSchemaAttributes**](#create-non-employee-source-schema-attributes) | **POST** `/non-employee-sources/{sourceId}/schema-attributes` | Create non-employee source schema attribute
[**Remove-BetaNonEmployeeRecord**](#delete-non-employee-record) | **DELETE** `/non-employee-records/{id}` | Delete non-employee record
[**Remove-BetaNonEmployeeRecordInBulk**](#delete-non-employee-record-in-bulk) | **POST** `/non-employee-records/bulk-delete` | Delete multiple non-employee records
[**Remove-BetaNonEmployeeRequest**](#delete-non-employee-request) | **DELETE** `/non-employee-requests/{id}` | Delete non-employee request
[**Remove-BetaNonEmployeeSchemaAttribute**](#delete-non-employee-schema-attribute) | **DELETE** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Delete non-employee source's schema attribute
[**Remove-BetaNonEmployeeSource**](#delete-non-employee-source) | **DELETE** `/non-employee-sources/{sourceId}` | Delete non-employee source
[**Remove-BetaNonEmployeeSourceSchemaAttributes**](#delete-non-employee-source-schema-attributes) | **DELETE** `/non-employee-sources/{sourceId}/schema-attributes` | Delete all custom schema attributes
[**Export-BetaNonEmployeeRecords**](#export-non-employee-records) | **GET** `/non-employee-sources/{id}/non-employees/download` | Exports Non-Employee Records to CSV
[**Export-BetaNonEmployeeSourceSchemaTemplate**](#export-non-employee-source-schema-template) | **GET** `/non-employee-sources/{id}/schema-attributes-template/download` | Exports Source Schema Template
[**Export-BetaNonEmployeeRecords**](#export-non-employee-records) | **GET** `/non-employee-sources/{id}/non-employees/download` | Exports non-employee records to csv
[**Export-BetaNonEmployeeSourceSchemaTemplate**](#export-non-employee-source-schema-template) | **GET** `/non-employee-sources/{id}/schema-attributes-template/download` | Exports source schema template
[**Get-BetaNonEmployeeApproval**](#get-non-employee-approval) | **GET** `/non-employee-approvals/{id}` | Get a non-employee approval item detail
[**Get-BetaNonEmployeeApprovalSummary**](#get-non-employee-approval-summary) | **GET** `/non-employee-approvals/summary/{requested-for}` | Get Summary of Non-Employee Approval Requests
[**Get-BetaNonEmployeeApprovalSummary**](#get-non-employee-approval-summary) | **GET** `/non-employee-approvals/summary/{requested-for}` | Get summary of non-employee approval requests
[**Get-BetaNonEmployeeBulkUploadStatus**](#get-non-employee-bulk-upload-status) | **GET** `/non-employee-sources/{id}/non-employee-bulk-upload/status` | Bulk upload status on source
[**Get-BetaNonEmployeeRecord**](#get-non-employee-record) | **GET** `/non-employee-records/{id}` | Get a Non-Employee Record
[**Get-BetaNonEmployeeRequest**](#get-non-employee-request) | **GET** `/non-employee-requests/{id}` | Get a Non-Employee Request
[**Get-BetaNonEmployeeRequestSummary**](#get-non-employee-request-summary) | **GET** `/non-employee-requests/summary/{requested-for}` | Get Summary of Non-Employee Requests
[**Get-BetaNonEmployeeSchemaAttribute**](#get-non-employee-schema-attribute) | **GET** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Get Schema Attribute Non-Employee Source
[**Get-BetaNonEmployeeSource**](#get-non-employee-source) | **GET** `/non-employee-sources/{sourceId}` | Get a Non-Employee Source
[**Get-BetaNonEmployeeSourceSchemaAttributes**](#get-non-employee-source-schema-attributes) | **GET** `/non-employee-sources/{sourceId}/schema-attributes` | List Schema Attributes Non-Employee Source
[**Import-BetaNonEmployeeRecordsInBulk**](#import-non-employee-records-in-bulk) | **POST** `/non-employee-sources/{id}/non-employee-bulk-upload` | Imports, or Updates, Non-Employee Records
[**Get-BetaNonEmployeeApproval**](#list-non-employee-approval) | **GET** `/non-employee-approvals` | Get List of Non-Employee Approval Requests
[**Get-BetaNonEmployeeRecords**](#list-non-employee-records) | **GET** `/non-employee-records` | List Non-Employee Records
[**Get-BetaNonEmployeeRequests**](#list-non-employee-requests) | **GET** `/non-employee-requests` | List Non-Employee Requests
[**Get-BetaNonEmployeeSources**](#list-non-employee-sources) | **GET** `/non-employee-sources` | List Non-Employee Sources
[**Update-BetaNonEmployeeRecord**](#patch-non-employee-record) | **PATCH** `/non-employee-records/{id}` | Patch Non-Employee Record
[**Update-BetaNonEmployeeSchemaAttribute**](#patch-non-employee-schema-attribute) | **PATCH** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Patch Non-Employee Source's Schema Attribute
[**Update-BetaNonEmployeeSource**](#patch-non-employee-source) | **PATCH** `/non-employee-sources/{sourceId}` | Patch a Non-Employee Source
[**Deny-BetaNonEmployeeRequest**](#reject-non-employee-request) | **POST** `/non-employee-approvals/{id}/reject` | Reject a Non-Employee Request
[**Update-BetaNonEmployeeRecord**](#update-non-employee-record) | **PUT** `/non-employee-records/{id}` | Update Non-Employee Record
[**Get-BetaNonEmployeeRecord**](#get-non-employee-record) | **GET** `/non-employee-records/{id}` | Get a non-employee record
[**Get-BetaNonEmployeeRequest**](#get-non-employee-request) | **GET** `/non-employee-requests/{id}` | Get a non-employee request
[**Get-BetaNonEmployeeRequestSummary**](#get-non-employee-request-summary) | **GET** `/non-employee-requests/summary/{requested-for}` | Get summary of non-employee requests
[**Get-BetaNonEmployeeSchemaAttribute**](#get-non-employee-schema-attribute) | **GET** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Get schema attribute non-employee source
[**Get-BetaNonEmployeeSource**](#get-non-employee-source) | **GET** `/non-employee-sources/{sourceId}` | Get a non-employee source
[**Get-BetaNonEmployeeSourceSchemaAttributes**](#get-non-employee-source-schema-attributes) | **GET** `/non-employee-sources/{sourceId}/schema-attributes` | List schema attributes non-employee source
[**Import-BetaNonEmployeeRecordsInBulk**](#import-non-employee-records-in-bulk) | **POST** `/non-employee-sources/{id}/non-employee-bulk-upload` | Imports, or updates, non-employee records
[**Get-BetaNonEmployeeApproval**](#list-non-employee-approval) | **GET** `/non-employee-approvals` | Get list of non-employee approval requests
[**Get-BetaNonEmployeeRecords**](#list-non-employee-records) | **GET** `/non-employee-records` | List non-employee records
[**Get-BetaNonEmployeeRequests**](#list-non-employee-requests) | **GET** `/non-employee-requests` | List non-employee requests
[**Get-BetaNonEmployeeSources**](#list-non-employee-sources) | **GET** `/non-employee-sources` | List non-employee sources
[**Update-BetaNonEmployeeRecord**](#patch-non-employee-record) | **PATCH** `/non-employee-records/{id}` | Patch non-employee record
[**Update-BetaNonEmployeeSchemaAttribute**](#patch-non-employee-schema-attribute) | **PATCH** `/non-employee-sources/{sourceId}/schema-attributes/{attributeId}` | Patch non-employee source's schema attribute
[**Update-BetaNonEmployeeSource**](#patch-non-employee-source) | **PATCH** `/non-employee-sources/{sourceId}` | Patch a non-employee source
[**Deny-BetaNonEmployeeRequest**](#reject-non-employee-request) | **POST** `/non-employee-approvals/{id}/reject` | Reject a non-employee request
[**Update-BetaNonEmployeeRecord**](#update-non-employee-record) | **PUT** `/non-employee-records/{id}` | Update non-employee record
## approve-non-employee-request
@@ -117,7 +117,7 @@ $NonEmployeeApprovalDecision = @"{
"comment" : "comment"
}"@
# Approve a Non-Employee Request
# Approve a non-employee request
try {
$Result = ConvertFrom-JsonToNonEmployeeApprovalDecision -Json $NonEmployeeApprovalDecision
@@ -178,7 +178,7 @@ $NonEmployeeRequestBody = @"{
"startDate" : "2020-03-24T00:00:00-05:00"
}"@
# Create Non-Employee Record
# Create non-employee record
try {
$Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody
@@ -237,7 +237,7 @@ $NonEmployeeRequestBody = @"{
"startDate" : "2020-03-24T00:00:00-05:00"
}"@
# Create Non-Employee Request
# Create non-employee request
try {
$Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody
@@ -308,7 +308,7 @@ $NonEmployeeSourceRequestBody = @"{
} ]
}"@
# Create Non-Employee Source
# Create non-employee source
try {
$Result = ConvertFrom-JsonToNonEmployeeSourceRequestBody -Json $NonEmployeeSourceRequestBody
@@ -363,7 +363,7 @@ $NonEmployeeSchemaAttributeBody = @"{
"required" : true
}"@
# Create Non-Employee Source Schema Attribute
# Create non-employee source schema attribute
try {
$Result = ConvertFrom-JsonToNonEmployeeSchemaAttributeBody -Json $NonEmployeeSchemaAttributeBody
@@ -409,7 +409,7 @@ Code | Description | Data Type
```powershell
$Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee record id (UUID)
# Delete Non-Employee Record
# Delete non-employee record
try {
Remove-BetaNonEmployeeRecord -Id $Id
@@ -456,7 +456,7 @@ Code | Description | Data Type
```powershell
$DeleteNonEmployeeRecordInBulkRequest = @""@
# Delete Multiple Non-Employee Records
# Delete multiple non-employee records
try {
$Result = ConvertFrom-JsonToDeleteNonEmployeeRecordInBulkRequest -Json $DeleteNonEmployeeRecordInBulkRequest
@@ -503,7 +503,7 @@ Code | Description | Data Type
```powershell
$Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee request id in the UUID format
# Delete Non-Employee Request
# Delete non-employee request
try {
Remove-BetaNonEmployeeRequest -Id $Id
@@ -551,7 +551,7 @@ Code | Description | Data Type
$AttributeId = "2c91808b6ef1d43e016efba0ce470904" # String | The Schema Attribute Id (UUID)
$SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id
# Delete Non-Employee Source's Schema Attribute
# Delete non-employee source's schema attribute
try {
Remove-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId
@@ -596,7 +596,7 @@ Code | Description | Data Type
```powershell
$SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | Source Id
# Delete Non-Employee Source
# Delete non-employee source
try {
Remove-BetaNonEmployeeSource -SourceId $SourceId
@@ -687,7 +687,7 @@ Code | Description | Data Type
```powershell
$Id = "2c918085842e69ae018432d22ccb212f" # String | Source Id (UUID)
# Exports Non-Employee Records to CSV
# Exports non-employee records to csv
try {
Export-BetaNonEmployeeRecords -Id $Id
@@ -735,7 +735,7 @@ Code | Description | Data Type
```powershell
$Id = "2c918085842e69ae018432d22ccb212f" # String | Source Id (UUID)
# Exports Source Schema Template
# Exports source schema template
try {
Export-BetaNonEmployeeSourceSchemaTemplate -Id $Id
@@ -827,7 +827,7 @@ Code | Description | Data Type
```powershell
$RequestedFor = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # String | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use ""me"" instead to indicate the current user.
# Get Summary of Non-Employee Approval Requests
# Get summary of non-employee approval requests
try {
Get-BetaNonEmployeeApprovalSummary -RequestedFor $RequestedFor
@@ -918,7 +918,7 @@ Code | Description | Data Type
```powershell
$Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee record id (UUID)
# Get a Non-Employee Record
# Get a non-employee record
try {
Get-BetaNonEmployeeRecord -Id $Id
@@ -964,7 +964,7 @@ Code | Description | Data Type
```powershell
$Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-Employee request id (UUID)
# Get a Non-Employee Request
# Get a non-employee request
try {
Get-BetaNonEmployeeRequest -Id $Id
@@ -1009,7 +1009,7 @@ Code | Description | Data Type
```powershell
$RequestedFor = "ac10d20a-841e-1e7d-8184-32d2e22c0179" # String | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use ""me"" instead to indicate the current user.
# Get Summary of Non-Employee Requests
# Get summary of non-employee requests
try {
Get-BetaNonEmployeeRequestSummary -RequestedFor $RequestedFor
@@ -1056,7 +1056,7 @@ Code | Description | Data Type
$AttributeId = "2c918085842e69ae018432d22ccb212f" # String | The Schema Attribute Id (UUID)
$SourceId = "2c918085842e69ae018432d22ccb212f" # String | The Source id
# Get Schema Attribute Non-Employee Source
# Get schema attribute non-employee source
try {
Get-BetaNonEmployeeSchemaAttribute -AttributeId $AttributeId -SourceId $SourceId
@@ -1101,7 +1101,7 @@ Code | Description | Data Type
```powershell
$SourceId = "2c91808b7c28b350017c2a2ec5790aa1" # String | Source Id
# Get a Non-Employee Source
# Get a non-employee source
try {
Get-BetaNonEmployeeSource -SourceId $SourceId
@@ -1147,7 +1147,7 @@ Code | Description | Data Type
```powershell
$SourceId = "2c918085842e69ae018432d22ccb212f" # String | The Source id
# List Schema Attributes Non-Employee Source
# List schema attributes non-employee source
try {
Get-BetaNonEmployeeSourceSchemaAttributes -SourceId $SourceId
@@ -1197,7 +1197,7 @@ Code | Description | Data Type
$Id = "e136567de87e4d029e60b3c3c55db56d" # String | Source Id (UUID)
$Data = # System.IO.FileInfo |
# Imports, or Updates, Non-Employee Records
# Imports, or updates, non-employee records
try {
Import-BetaNonEmployeeRecordsInBulk -Id $Id -Data $Data
@@ -1252,7 +1252,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Filters = 'approvalStatus eq "PENDING"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **approvalStatus**: *eq* (optional)
$Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, modified** (optional)
# Get List of Non-Employee Approval Requests
# Get list of non-employee approval requests
try {
Get-BetaNonEmployeeApproval
@@ -1305,7 +1305,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Sorters = "accountName,sourceId" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, accountName, sourceId, manager, firstName, lastName, email, phone, startDate, endDate, created, modified** (optional)
$Filters = 'sourceId eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional)
# List Non-Employee Records
# List non-employee records
try {
Get-BetaNonEmployeeRecords
@@ -1360,7 +1360,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Sorters = "approvalStatus,firstName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created, approvalStatus, firstName, lastName, email, phone, accountName, startDate, endDate** (optional)
$Filters = 'sourceId eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **sourceId**: *eq* (optional)
# List Non-Employee Requests
# List non-employee requests
try {
Get-BetaNonEmployeeRequests -RequestedFor $RequestedFor
@@ -1417,7 +1417,7 @@ $RequestedFor = "me" # String | Identity the request was made for. Use 'me' to i
$NonEmployeeCount = $false # Boolean | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to $false)
$Sorters = "name,created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, sourceId** (optional)
# List Non-Employee Sources
# List non-employee sources
try {
Get-BetaNonEmployeeSources
@@ -1470,7 +1470,7 @@ $Id = "2c91808b6ef1d43e016efba0ce470904" # String | Non-employee record id (UUID
}"@ # JsonPatchOperation[] | A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields.
# Patch Non-Employee Record
# Patch non-employee record
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
@@ -1527,7 +1527,7 @@ $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | The Source id
}"@ # JsonPatchOperation[] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'.
# Patch Non-Employee Source's Schema Attribute
# Patch non-employee source's schema attribute
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
@@ -1580,7 +1580,7 @@ $SourceId = "2c91808b6ef1d43e016efba0ce470904" # String | Source Id
}"@ # JsonPatchOperation[] | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
# Patch a Non-Employee Source
# Patch a non-employee source
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
@@ -1630,7 +1630,7 @@ $NonEmployeeRejectApprovalDecision = @"{
"comment" : "comment"
}"@
# Reject a Non-Employee Request
# Reject a non-employee request
try {
$Result = ConvertFrom-JsonToNonEmployeeRejectApprovalDecision -Json $NonEmployeeRejectApprovalDecision
@@ -1692,7 +1692,7 @@ $NonEmployeeRequestBody = @"{
"startDate" : "2020-03-24T00:00:00-05:00"
}"@
# Update Non-Employee Record
# Update non-employee record
try {
$Result = ConvertFrom-JsonToNonEmployeeRequestBody -Json $NonEmployeeRequestBody

60
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaNotificationsApi.md
View File

@@ -17,21 +17,21 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-BetaDomainDkim**](#create-domain-dkim) | **POST** `/verified-domains` | Verify domain address via DKIM
[**New-BetaNotificationTemplate**](#create-notification-template) | **POST** `/notification-templates` | Create Notification Template
[**New-BetaVerifiedFromAddress**](#create-verified-from-address) | **POST** `/verified-from-addresses` | Create Verified From Address
[**Remove-BetaNotificationTemplatesInBulk**](#delete-notification-templates-in-bulk) | **POST** `/notification-templates/bulk-delete` | Bulk Delete Notification Templates
[**Remove-BetaVerifiedFromAddress**](#delete-verified-from-address) | **DELETE** `/verified-from-addresses/{id}` | Delete Verified From Address
[**Get-BetaDkimAttributes**](#get-dkim-attributes) | **GET** `/verified-domains` | Get DKIM Attributes
[**Get-BetaMailFromAttributes**](#get-mail-from-attributes) | **GET** `/mail-from-attributes/{identityId}` | Get MAIL FROM Attributes
[**Get-BetaNotificationTemplate**](#get-notification-template) | **GET** `/notification-templates/{id}` | Get Notification Template By Id
[**Get-BetaNotificationsTemplateContext**](#get-notifications-template-context) | **GET** `/notification-template-context` | Get Notification Template Context
[**Get-BetaFromAddresses**](#list-from-addresses) | **GET** `/verified-from-addresses` | List From Addresses
[**Get-BetaNotificationPreferences**](#list-notification-preferences) | **GET** `/notification-preferences/{key}` | List Notification Preferences for tenant.
[**Get-BetaNotificationTemplateDefaults**](#list-notification-template-defaults) | **GET** `/notification-template-defaults` | List Notification Template Defaults
[**Get-BetaNotificationTemplates**](#list-notification-templates) | **GET** `/notification-templates` | List Notification Templates
[**Send-BetaMailFromAttributes**](#put-mail-from-attributes) | **PUT** `/mail-from-attributes` | Change MAIL FROM domain
[**Send-BetaTestNotification**](#send-test-notification) | **POST** `/send-test-notification` | Send Test Notification
[**New-BetaDomainDkim**](#create-domain-dkim) | **POST** `/verified-domains` | Verify domain address via dkim
[**New-BetaNotificationTemplate**](#create-notification-template) | **POST** `/notification-templates` | Create notification template
[**New-BetaVerifiedFromAddress**](#create-verified-from-address) | **POST** `/verified-from-addresses` | Create verified from address
[**Remove-BetaNotificationTemplatesInBulk**](#delete-notification-templates-in-bulk) | **POST** `/notification-templates/bulk-delete` | Bulk delete notification templates
[**Remove-BetaVerifiedFromAddress**](#delete-verified-from-address) | **DELETE** `/verified-from-addresses/{id}` | Delete verified from address
[**Get-BetaDkimAttributes**](#get-dkim-attributes) | **GET** `/verified-domains` | Get dkim attributes
[**Get-BetaMailFromAttributes**](#get-mail-from-attributes) | **GET** `/mail-from-attributes/{identityId}` | Get mail from attributes
[**Get-BetaNotificationTemplate**](#get-notification-template) | **GET** `/notification-templates/{id}` | Get notification template by id
[**Get-BetaNotificationsTemplateContext**](#get-notifications-template-context) | **GET** `/notification-template-context` | Get notification template context
[**Get-BetaFromAddresses**](#list-from-addresses) | **GET** `/verified-from-addresses` | List from addresses
[**Get-BetaNotificationPreferences**](#list-notification-preferences) | **GET** `/notification-preferences/{key}` | List notification preferences for tenant.
[**Get-BetaNotificationTemplateDefaults**](#list-notification-template-defaults) | **GET** `/notification-template-defaults` | List notification template defaults
[**Get-BetaNotificationTemplates**](#list-notification-templates) | **GET** `/notification-templates` | List notification templates
[**Send-BetaMailFromAttributes**](#put-mail-from-attributes) | **PUT** `/mail-from-attributes` | Change mail from domain
[**Send-BetaTestNotification**](#send-test-notification) | **POST** `/send-test-notification` | Send test notification
## create-domain-dkim
@@ -68,7 +68,7 @@ $DomainAddress = @"{
"domain" : "sailpoint.com"
}"@
# Verify domain address via DKIM
# Verify domain address via dkim
try {
$Result = ConvertFrom-JsonToDomainAddress -Json $DomainAddress
@@ -133,7 +133,7 @@ $TemplateDto = @"{
"key" : "cloud_manual_work_item_summary"
}"@
# Create Notification Template
# Create notification template
try {
$Result = ConvertFrom-JsonToTemplateDto -Json $TemplateDto
@@ -184,7 +184,7 @@ $EmailStatusDto = @"{
"email" : "sender@example.com"
}"@
# Create Verified From Address
# Create verified from address
try {
$Result = ConvertFrom-JsonToEmailStatusDto -Json $EmailStatusDto
@@ -235,7 +235,7 @@ Code | Description | Data Type
}"@ # TemplateBulkDeleteDto[] |
# Bulk Delete Notification Templates
# Bulk delete notification templates
try {
$Result = ConvertFrom-JsonToTemplateBulkDeleteDto -Json $TemplateBulkDeleteDto
@@ -282,7 +282,7 @@ Code | Description | Data Type
```powershell
$Id = "MyId" # String |
# Delete Verified From Address
# Delete verified from address
try {
Remove-BetaVerifiedFromAddress -Id $Id
@@ -325,7 +325,7 @@ Code | Description | Data Type
### Example
```powershell
# Get DKIM Attributes
# Get dkim attributes
try {
Get-BetaDkimAttributes
@@ -370,7 +370,7 @@ Code | Description | Data Type
```powershell
$IdentityId = "bobsmith@sailpoint.com" # String | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status
# Get MAIL FROM Attributes
# Get mail from attributes
try {
Get-BetaMailFromAttributes -IdentityId $IdentityId
@@ -415,7 +415,7 @@ Code | Description | Data Type
```powershell
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Notification Template
# Get Notification Template By Id
# Get notification template by id
try {
Get-BetaNotificationTemplate -Id $Id
@@ -459,7 +459,7 @@ Code | Description | Data Type
### Example
```powershell
# Get Notification Template Context
# Get notification template context
try {
Get-BetaNotificationsTemplateContext
@@ -511,7 +511,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Filters = 'email eq "john.doe@company.com"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **email**: *eq, ge, le, sw* (optional)
$Sorters = "email" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **email** (optional)
# List From Addresses
# List from addresses
try {
Get-BetaFromAddresses
@@ -557,7 +557,7 @@ Code | Description | Data Type
```powershell
$Key = "cloud_manual_work_item_summary" # String | The notification key.
# List Notification Preferences for tenant.
# List notification preferences for tenant.
try {
Get-BetaNotificationPreferences -Key $Key
@@ -606,7 +606,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Filters = 'key eq "cloud_manual_work_item_summary"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional)
# List Notification Template Defaults
# List notification template defaults
try {
Get-BetaNotificationTemplateDefaults
@@ -655,7 +655,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Filters = 'medium eq "EMAIL"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq, in, sw* **medium**: *eq, sw* **locale**: *eq, sw* (optional)
# List Notification Templates
# List notification templates
try {
Get-BetaNotificationTemplates
@@ -703,7 +703,7 @@ $MailFromAttributesDto = @"{
"mailFromDomain" : "example.sailpoint.com"
}"@
# Change MAIL FROM domain
# Change mail from domain
try {
$Result = ConvertFrom-JsonToMailFromAttributesDto -Json $MailFromAttributesDto
@@ -754,7 +754,7 @@ $SendTestNotificationRequestDto = @"{
"key" : "cloud_manual_work_item_summary"
}"@
# Send Test Notification
# Send test notification
try {
$Result = ConvertFrom-JsonToSendTestNotificationRequestDto -Json $SendTestNotificationRequestDto

20
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaOAuthClientsApi.md
View File

@@ -20,11 +20,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-BetaOauthClient**](#create-oauth-client) | **POST** `/oauth-clients` | Create OAuth Client
[**Remove-BetaOauthClient**](#delete-oauth-client) | **DELETE** `/oauth-clients/{id}` | Delete OAuth Client
[**Get-BetaOauthClient**](#get-oauth-client) | **GET** `/oauth-clients/{id}` | Get OAuth Client
[**Get-BetaOauthClients**](#list-oauth-clients) | **GET** `/oauth-clients` | List OAuth Clients
[**Update-BetaOauthClient**](#patch-oauth-client) | **PATCH** `/oauth-clients/{id}` | Patch OAuth Client
[**New-BetaOauthClient**](#create-oauth-client) | **POST** `/oauth-clients` | Create oauth client
[**Remove-BetaOauthClient**](#delete-oauth-client) | **DELETE** `/oauth-clients/{id}` | Delete oauth client
[**Get-BetaOauthClient**](#get-oauth-client) | **GET** `/oauth-clients/{id}` | Get oauth client
[**Get-BetaOauthClients**](#list-oauth-clients) | **GET** `/oauth-clients` | List oauth clients
[**Update-BetaOauthClient**](#patch-oauth-client) | **PATCH** `/oauth-clients/{id}` | Patch oauth client
## create-oauth-client
@@ -74,7 +74,7 @@ $CreateOAuthClientRequest = @"{
"claimsSupported" : false
}"@
# Create OAuth Client
# Create oauth client
try {
$Result = ConvertFrom-JsonToCreateOAuthClientRequest -Json $CreateOAuthClientRequest
@@ -121,7 +121,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id
# Delete OAuth Client
# Delete oauth client
try {
Remove-BetaOauthClient -Id $Id
@@ -167,7 +167,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id
# Get OAuth Client
# Get oauth client
try {
Get-BetaOauthClient -Id $Id
@@ -212,7 +212,7 @@ Code | Description | Data Type
```powershell
$Filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional)
# List OAuth Clients
# List oauth clients
try {
Get-BetaOauthClients
@@ -267,7 +267,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The OAuth client id
}"@ # JsonPatchOperation[] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported
# Patch OAuth Client
# Patch oauth client
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation

8
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaOrgConfigApi.md
View File

@@ -19,9 +19,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-BetaOrgConfig**](#get-org-config) | **GET** `/org-config` | Get Org configuration settings
[**Get-BetaOrgConfig**](#get-org-config) | **GET** `/org-config` | Get org configuration settings
[**Get-BetaValidTimeZones**](#get-valid-time-zones) | **GET** `/org-config/valid-time-zones` | Get list of time zones
[**Update-BetaOrgConfig**](#patch-org-config) | **PATCH** `/org-config` | Patch an Org configuration property
[**Update-BetaOrgConfig**](#patch-org-config) | **PATCH** `/org-config` | Patch an org configuration property
## get-org-config
@@ -54,7 +54,7 @@ Code | Description | Data Type
### Example
```powershell
# Get Org configuration settings
# Get org configuration settings
try {
Get-BetaOrgConfig
@@ -148,7 +148,7 @@ Code | Description | Data Type
}"@ # JsonPatchOperation[] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
# Patch an Org configuration property
# Patch an org configuration property
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation

12
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordConfigurationApi.md
View File

@@ -23,9 +23,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-BetaPasswordOrgConfig**](#create-password-org-config) | **POST** `/password-org-config` | Create Password Org Config
[**Get-BetaPasswordOrgConfig**](#get-password-org-config) | **GET** `/password-org-config` | Get Password Org Config
[**Send-BetaPasswordOrgConfig**](#put-password-org-config) | **PUT** `/password-org-config` | Update Password Org Config
[**New-BetaPasswordOrgConfig**](#create-password-org-config) | **POST** `/password-org-config` | Create password org config
[**Get-BetaPasswordOrgConfig**](#get-password-org-config) | **GET** `/password-org-config` | Get password org config
[**Send-BetaPasswordOrgConfig**](#put-password-org-config) | **PUT** `/password-org-config` | Update password org config
## create-password-org-config
@@ -66,7 +66,7 @@ $PasswordOrgConfig = @"{
"customInstructionsEnabled" : true
}"@
# Create Password Org Config
# Create password org config
try {
$Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig
@@ -110,7 +110,7 @@ Code | Description | Data Type
### Example
```powershell
# Get Password Org Config
# Get password org config
try {
Get-BetaPasswordOrgConfig
@@ -162,7 +162,7 @@ $PasswordOrgConfig = @"{
"customInstructionsEnabled" : true
}"@
# Update Password Org Config
# Update password org config
try {
$Result = ConvertFrom-JsonToPasswordOrgConfig -Json $PasswordOrgConfig

8
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordDictionaryApi.md
View File

@@ -64,8 +64,8 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-BetaPasswordDictionary**](#get-password-dictionary) | **GET** `/password-dictionary` | Get Password Dictionary
[**Send-BetaPasswordDictionary**](#put-password-dictionary) | **PUT** `/password-dictionary` | Update Password Dictionary
[**Get-BetaPasswordDictionary**](#get-password-dictionary) | **GET** `/password-dictionary` | Get password dictionary
[**Send-BetaPasswordDictionary**](#put-password-dictionary) | **PUT** `/password-dictionary` | Update password dictionary
## get-password-dictionary
@@ -126,7 +126,7 @@ Code | Description | Data Type
### Example
```powershell
# Get Password Dictionary
# Get password dictionary
try {
Get-BetaPasswordDictionary
@@ -201,7 +201,7 @@ Code | Description | Data Type
```powershell
$File = # System.IO.FileInfo | (optional)
# Update Password Dictionary
# Update password dictionary
try {
Send-BetaPasswordDictionary

12
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordManagementApi.md
View File

@@ -42,9 +42,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-BetaDigitToken**](#create-digit-token) | **POST** `/generate-password-reset-token/digit` | Generate a digit token
[**Get-BetaIdentityPasswordChangeStatus**](#get-identity-password-change-status) | **GET** `/password-change-status/{id}` | Get Password Change Request Status
[**Search-BetaPasswordInfo**](#query-password-info) | **POST** `/query-password-info` | Query Password Info
[**Set-BetaIdentityPassword**](#set-identity-password) | **POST** `/set-password` | Set Identity's Password
[**Get-BetaIdentityPasswordChangeStatus**](#get-identity-password-change-status) | **GET** `/password-change-status/{id}` | Get password change request status
[**Search-BetaPasswordInfo**](#query-password-info) | **POST** `/query-password-info` | Query password info
[**Set-BetaIdentityPassword**](#set-identity-password) | **POST** `/set-password` | Set identity's password
## create-digit-token
@@ -128,7 +128,7 @@ Code | Description | Data Type
```powershell
$Id = "MyId" # String |
# Get Password Change Request Status
# Get password change request status
try {
Get-BetaIdentityPasswordChangeStatus -Id $Id
@@ -184,7 +184,7 @@ $PasswordInfoQueryDTO = @"{
"userName" : "Abby.Smith"
}"@
# Query Password Info
# Query password info
try {
$Result = ConvertFrom-JsonToPasswordInfoQueryDTO -Json $PasswordInfoQueryDTO
@@ -279,7 +279,7 @@ $PasswordChangeRequest = @"{
"encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A=="
}"@
# Set Identity's Password
# Set identity's password
try {
$Result = ConvertFrom-JsonToPasswordChangeRequest -Json $PasswordChangeRequest

20
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordPoliciesApi.md
View File

@@ -26,11 +26,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-BetaPasswordPolicy**](#create-password-policy) | **POST** `/password-policies` | Create Password Policy
[**Remove-BetaPasswordPolicy**](#delete-password-policy) | **DELETE** `/password-policies/{id}` | Delete Password Policy by ID
[**Get-BetaPasswordPolicyById**](#get-password-policy-by-id) | **GET** `/password-policies/{id}` | Get Password Policy by ID
[**Get-BetaPasswordPolicies**](#list-password-policies) | **GET** `/password-policies` | List Password Policies
[**Set-BetaPasswordPolicy**](#set-password-policy) | **PUT** `/password-policies/{id}` | Update Password Policy by ID
[**New-BetaPasswordPolicy**](#create-password-policy) | **POST** `/password-policies` | Create password policy
[**Remove-BetaPasswordPolicy**](#delete-password-policy) | **DELETE** `/password-policies/{id}` | Delete password policy by id
[**Get-BetaPasswordPolicyById**](#get-password-policy-by-id) | **GET** `/password-policies/{id}` | Get password policy by id
[**Get-BetaPasswordPolicies**](#list-password-policies) | **GET** `/password-policies` | List password policies
[**Set-BetaPasswordPolicy**](#set-password-policy) | **PUT** `/password-policies/{id}` | Update password policy by id
## create-password-policy
@@ -97,7 +97,7 @@ $PasswordPolicyV3Dto = @"{
"maxLength" : 25
}"@
# Create Password Policy
# Create password policy
try {
$Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto
@@ -144,7 +144,7 @@ Code | Description | Data Type
```powershell
$Id = "ff808081838d9e9d01838da6a03e0002" # String | The ID of password policy to delete.
# Delete Password Policy by ID
# Delete password policy by id
try {
Remove-BetaPasswordPolicy -Id $Id
@@ -190,7 +190,7 @@ Code | Description | Data Type
```powershell
$Id = "ff808081838d9e9d01838da6a03e0005" # String | The ID of password policy to retrieve.
# Get Password Policy by ID
# Get password policy by id
try {
Get-BetaPasswordPolicyById -Id $Id
@@ -240,7 +240,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
# List Password Policies
# List password policies
try {
Get-BetaPasswordPolicies
@@ -320,7 +320,7 @@ $PasswordPolicyV3Dto = @"{
"maxLength" : 25
}"@
# Update Password Policy by ID
# Update password policy by id
try {
$Result = ConvertFrom-JsonToPasswordPolicyV3Dto -Json $PasswordPolicyV3Dto

20
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPasswordSyncGroupsApi.md
View File

@@ -49,11 +49,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-BetaPasswordSyncGroup**](#create-password-sync-group) | **POST** `/password-sync-groups` | Create Password Sync Group
[**Remove-BetaPasswordSyncGroup**](#delete-password-sync-group) | **DELETE** `/password-sync-groups/{id}` | Delete Password Sync Group by ID
[**Get-BetaPasswordSyncGroup**](#get-password-sync-group) | **GET** `/password-sync-groups/{id}` | Get Password Sync Group by ID
[**Get-BetaPasswordSyncGroups**](#get-password-sync-groups) | **GET** `/password-sync-groups` | Get Password Sync Group List
[**Update-BetaPasswordSyncGroup**](#update-password-sync-group) | **PUT** `/password-sync-groups/{id}` | Update Password Sync Group by ID
[**New-BetaPasswordSyncGroup**](#create-password-sync-group) | **POST** `/password-sync-groups` | Create password sync group
[**Remove-BetaPasswordSyncGroup**](#delete-password-sync-group) | **DELETE** `/password-sync-groups/{id}` | Delete password sync group by id
[**Get-BetaPasswordSyncGroup**](#get-password-sync-group) | **GET** `/password-sync-groups/{id}` | Get password sync group by id
[**Get-BetaPasswordSyncGroups**](#get-password-sync-groups) | **GET** `/password-sync-groups` | Get password sync group list
[**Update-BetaPasswordSyncGroup**](#update-password-sync-group) | **PUT** `/password-sync-groups/{id}` | Update password sync group by id
## create-password-sync-group
@@ -94,7 +94,7 @@ $PasswordSyncGroup = @"{
"sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ]
}"@
# Create Password Sync Group
# Create password sync group
try {
$Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup
@@ -140,7 +140,7 @@ Code | Description | Data Type
```powershell
$Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to delete.
# Delete Password Sync Group by ID
# Delete password sync group by id
try {
Remove-BetaPasswordSyncGroup -Id $Id
@@ -186,7 +186,7 @@ Code | Description | Data Type
```powershell
$Id = "6881f631-3bd5-4213-9c75-8e05cc3e35dd" # String | The ID of password sync group to retrieve.
# Get Password Sync Group by ID
# Get password sync group by id
try {
Get-BetaPasswordSyncGroup -Id $Id
@@ -235,7 +235,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
# Get Password Sync Group List
# Get password sync group list
try {
Get-BetaPasswordSyncGroups
@@ -290,7 +290,7 @@ $PasswordSyncGroup = @"{
"sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ]
}"@
# Update Password Sync Group by ID
# Update password sync group by id
try {
$Result = ConvertFrom-JsonToPasswordSyncGroup -Json $PasswordSyncGroup

16
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPersonalAccessTokensApi.md
View File

@@ -28,10 +28,10 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-BetaPersonalAccessToken**](#create-personal-access-token) | **POST** `/personal-access-tokens` | Create Personal Access Token
[**Remove-BetaPersonalAccessToken**](#delete-personal-access-token) | **DELETE** `/personal-access-tokens/{id}` | Delete Personal Access Token
[**Get-BetaPersonalAccessTokens**](#list-personal-access-tokens) | **GET** `/personal-access-tokens` | List Personal Access Tokens
[**Update-BetaPersonalAccessToken**](#patch-personal-access-token) | **PATCH** `/personal-access-tokens/{id}` | Patch Personal Access Token
[**New-BetaPersonalAccessToken**](#create-personal-access-token) | **POST** `/personal-access-tokens` | Create personal access token
[**Remove-BetaPersonalAccessToken**](#delete-personal-access-token) | **DELETE** `/personal-access-tokens/{id}` | Delete personal access token
[**Get-BetaPersonalAccessTokens**](#list-personal-access-tokens) | **GET** `/personal-access-tokens` | List personal access tokens
[**Update-BetaPersonalAccessToken**](#patch-personal-access-token) | **PATCH** `/personal-access-tokens/{id}` | Patch personal access token
## create-personal-access-token
@@ -69,7 +69,7 @@ $CreatePersonalAccessTokenRequest = @"{
"name" : "NodeJS Integration"
}"@
# Create Personal Access Token
# Create personal access token
try {
$Result = ConvertFrom-JsonToCreatePersonalAccessTokenRequest -Json $CreatePersonalAccessTokenRequest
@@ -116,7 +116,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The personal access token id
# Delete Personal Access Token
# Delete personal access token
try {
Remove-BetaPersonalAccessToken -Id $Id
@@ -163,7 +163,7 @@ Code | Description | Data Type
$OwnerId = "2c9180867b50d088017b554662fb281e" # String | The identity ID of the owner whose personal access tokens should be listed. If ""me"", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional)
$Filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **lastUsed**: *le, isnull* (optional)
# List Personal Access Tokens
# List personal access tokens
try {
Get-BetaPersonalAccessTokens
@@ -216,7 +216,7 @@ $Id = "ef38f94347e94562b5bb8424a56397d8" # String | The Personal Access Token id
}"@ # JsonPatchOperation[] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope
# Patch Personal Access Token
# Patch personal access token
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation

8
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaPublicIdentitiesConfigApi.md
View File

@@ -27,8 +27,8 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-BetaPublicIdentityConfig**](#get-public-identity-config) | **GET** `/public-identities-config` | Get Public Identity Config
[**Update-BetaPublicIdentityConfig**](#update-public-identity-config) | **PUT** `/public-identities-config` | Update Public Identity Config
[**Get-BetaPublicIdentityConfig**](#get-public-identity-config) | **GET** `/public-identities-config` | Get public identity config
[**Update-BetaPublicIdentityConfig**](#update-public-identity-config) | **PUT** `/public-identities-config` | Update public identity config
## get-public-identity-config
@@ -63,7 +63,7 @@ Code | Description | Data Type
### Example
```powershell
# Get Public Identity Config
# Get public identity config
try {
Get-BetaPublicIdentityConfig
@@ -125,7 +125,7 @@ $PublicIdentityConfig = @"{
}
}"@
# Update Public Identity Config
# Update public identity config
try {
$Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig

4
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRequestableObjectsApi.md
View File

@@ -20,7 +20,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-BetaRequestableObjects**](#list-requestable-objects) | **GET** `/requestable-objects` | Requestable Objects List
[**Get-BetaRequestableObjects**](#list-requestable-objects) | **GET** `/requestable-objects` | Requestable objects list
## list-requestable-objects
@@ -75,7 +75,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Filters = 'name sw "bob"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional)
$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name** (optional)
# Requestable Objects List
# Requestable objects list
try {
Get-BetaRequestableObjects

32
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaRolesApi.md
View File

@@ -54,14 +54,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-BetaRole**](#create-role) | **POST** `/roles` | Create a Role
[**Remove-BetaBulkRoles**](#delete-bulk-roles) | **POST** `/roles/bulk-delete` | Delete Role(s)
[**Remove-BetaRole**](#delete-role) | **DELETE** `/roles/{id}` | Delete a Role
[**Get-BetaRole**](#get-role) | **GET** `/roles/{id}` | Get a Role
[**Get-BetaRoleAssignedIdentities**](#get-role-assigned-identities) | **GET** `/roles/{id}/assigned-identities` | Identities assigned a Role
[**Get-BetaRoleEntitlements**](#get-role-entitlements) | **GET** `/roles/{id}/entitlements` | List Role's Entitlements
[**Get-BetaRoles**](#list-roles) | **GET** `/roles` | List Roles
[**Update-BetaRole**](#patch-role) | **PATCH** `/roles/{id}` | Patch a specified Role
[**New-BetaRole**](#create-role) | **POST** `/roles` | Create a role
[**Remove-BetaBulkRoles**](#delete-bulk-roles) | **POST** `/roles/bulk-delete` | Delete role(s)
[**Remove-BetaRole**](#delete-role) | **DELETE** `/roles/{id}` | Delete a role
[**Get-BetaRole**](#get-role) | **GET** `/roles/{id}` | Get a role
[**Get-BetaRoleAssignedIdentities**](#get-role-assigned-identities) | **GET** `/roles/{id}/assigned-identities` | Identities assigned a role
[**Get-BetaRoleEntitlements**](#get-role-entitlements) | **GET** `/roles/{id}/entitlements` | List role's entitlements
[**Get-BetaRoles**](#list-roles) | **GET** `/roles` | List roles
[**Update-BetaRole**](#patch-role) | **PATCH** `/roles/{id}` | Patch a specified role
## create-role
@@ -259,7 +259,7 @@ $Role = @"{
"requestable" : true
}"@
# Create a Role
# Create a role
try {
$Result = ConvertFrom-JsonToRole -Json $Role
@@ -310,7 +310,7 @@ $RoleBulkDeleteRequest = @"{
"roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ]
}"@
# Delete Role(s)
# Delete role(s)
try {
$Result = ConvertFrom-JsonToRoleBulkDeleteRequest -Json $RoleBulkDeleteRequest
@@ -358,7 +358,7 @@ Code | Description | Data Type
```powershell
$Id = "2c91808a7813090a017814121e121518" # String | ID of the Role
# Delete a Role
# Delete a role
try {
Remove-BetaRole -Id $Id
@@ -404,7 +404,7 @@ Code | Description | Data Type
```powershell
$Id = "2c91808a7813090a017814121e121518" # String | ID of the Role
# Get a Role
# Get a role
try {
Get-BetaRole -Id $Id
@@ -459,7 +459,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Filters = 'name sw Joe' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **aliasName**: *eq, sw* **email**: *eq, sw* **name**: *eq, sw, co* (optional)
$Sorters = "aliasName,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, aliasName, email** (optional)
# Identities assigned a Role
# Identities assigned a role
try {
Get-BetaRoleAssignedIdentities -Id $Id
@@ -514,7 +514,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Filters = 'attribute eq "memberOf"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional)
$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional)
# List Role's Entitlements
# List role's entitlements
try {
Get-BetaRoleEntitlements -Id $Id
@@ -575,7 +575,7 @@ $Sorters = "name,-modified" # String | Sort results using the standard syntax de
$ForSegmentIds = "0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d" # String | If present and not empty, additionally filters Roles to those which are assigned to the Segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional)
$IncludeUnsegmented = $false # Boolean | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to $true)
# List Roles
# List roles
try {
Get-BetaRoles
@@ -647,7 +647,7 @@ $Id = "2c91808a7813090a017814121e121518" # String | ID of the Role to patch
}"@ # JsonPatchOperation[] |
# Patch a specified Role
# Patch a specified role
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation

28
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSIMIntegrationsApi.md
View File

@@ -24,13 +24,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-BetaSIMIntegration**](#create-sim-integration) | **POST** `/sim-integrations` | Create new SIM integration
[**Remove-BetaSIMIntegration**](#delete-sim-integration) | **DELETE** `/sim-integrations/{id}` | Delete a SIM integration
[**Get-BetaSIMIntegration**](#get-sim-integration) | **GET** `/sim-integrations/{id}` | Get a SIM integration details.
[**Get-BetaSIMIntegrations**](#get-sim-integrations) | **GET** `/sim-integrations` | List the existing SIM integrations.
[**Update-BetaBeforeProvisioningRule**](#patch-before-provisioning-rule) | **PATCH** `/sim-integrations/{id}/beforeProvisioningRule` | Patch a SIM beforeProvisioningRule attribute.
[**Update-BetaSIMAttributes**](#patch-sim-attributes) | **PATCH** `/sim-integrations/{id}` | Patch a SIM attribute.
[**Send-BetaSIMIntegration**](#put-sim-integration) | **PUT** `/sim-integrations/{id}` | Update an existing SIM integration
[**New-BetaSIMIntegration**](#create-sim-integration) | **POST** `/sim-integrations` | Create new sim integration
[**Remove-BetaSIMIntegration**](#delete-sim-integration) | **DELETE** `/sim-integrations/{id}` | Delete a sim integration
[**Get-BetaSIMIntegration**](#get-sim-integration) | **GET** `/sim-integrations/{id}` | Get a sim integration details.
[**Get-BetaSIMIntegrations**](#get-sim-integrations) | **GET** `/sim-integrations` | List the existing sim integrations.
[**Update-BetaBeforeProvisioningRule**](#patch-before-provisioning-rule) | **PATCH** `/sim-integrations/{id}/beforeProvisioningRule` | Patch a sim beforeprovisioningrule attribute.
[**Update-BetaSIMAttributes**](#patch-sim-attributes) | **PATCH** `/sim-integrations/{id}` | Patch a sim attribute.
[**Send-BetaSIMIntegration**](#put-sim-integration) | **PUT** `/sim-integrations/{id}` | Update an existing sim integration
## create-sim-integration
@@ -82,7 +82,7 @@ $SimIntegrationDetails = @"{
}
}"@
# Create new SIM integration
# Create new sim integration
try {
$Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails
@@ -129,7 +129,7 @@ Code | Description | Data Type
```powershell
$Id = "12345" # String | The id of the integration to delete.
# Delete a SIM integration
# Delete a sim integration
try {
Remove-BetaSIMIntegration -Id $Id
@@ -175,7 +175,7 @@ Code | Description | Data Type
```powershell
$Id = "12345" # String | The id of the integration.
# Get a SIM integration details.
# Get a sim integration details.
try {
Get-BetaSIMIntegration -Id $Id
@@ -219,7 +219,7 @@ Code | Description | Data Type
### Example
```powershell
# List the existing SIM integrations.
# List the existing sim integrations.
try {
Get-BetaSIMIntegrations
@@ -267,7 +267,7 @@ Code | Description | Data Type
$Id = "12345" # String | SIM integration id
$JsonPatch = @""[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]""@
# Patch a SIM beforeProvisioningRule attribute.
# Patch a sim beforeprovisioningrule attribute.
try {
$Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch
@@ -316,7 +316,7 @@ Code | Description | Data Type
$Id = "12345" # String | SIM integration id
$JsonPatch = @""[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]""@
# Patch a SIM attribute.
# Patch a sim attribute.
try {
$Result = ConvertFrom-JsonToJsonPatch -Json $JsonPatch
@@ -382,7 +382,7 @@ $SimIntegrationDetails = @"{
}
}"@
# Update an existing SIM integration
# Update an existing sim integration
try {
$Result = ConvertFrom-JsonToSimIntegrationDetails -Json $SimIntegrationDetails

44
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSODPoliciesApi.md
View File

@@ -43,22 +43,22 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-BetaSodPolicy**](#create-sod-policy) | **POST** `/sod-policies` | Create SOD policy
[**Remove-BetaSodPolicy**](#delete-sod-policy) | **DELETE** `/sod-policies/{id}` | Delete SOD policy by ID
[**Remove-BetaSodPolicySchedule**](#delete-sod-policy-schedule) | **DELETE** `/sod-policies/{id}/schedule` | Delete SOD policy schedule
[**New-BetaSodPolicy**](#create-sod-policy) | **POST** `/sod-policies` | Create sod policy
[**Remove-BetaSodPolicy**](#delete-sod-policy) | **DELETE** `/sod-policies/{id}` | Delete sod policy by id
[**Remove-BetaSodPolicySchedule**](#delete-sod-policy-schedule) | **DELETE** `/sod-policies/{id}/schedule` | Delete sod policy schedule
[**Get-BetaCustomViolationReport**](#get-custom-violation-report) | **GET** `/sod-violation-report/{reportResultId}/download/{fileName}` | Download custom violation report
[**Get-BetaDefaultViolationReport**](#get-default-violation-report) | **GET** `/sod-violation-report/{reportResultId}/download` | Download violation report
[**Get-BetaSodAllReportRunStatus**](#get-sod-all-report-run-status) | **GET** `/sod-violation-report` | Get multi-report run task status
[**Get-BetaSodPolicy**](#get-sod-policy) | **GET** `/sod-policies/{id}` | Get SOD policy by ID
[**Get-BetaSodPolicySchedule**](#get-sod-policy-schedule) | **GET** `/sod-policies/{id}/schedule` | Get SOD policy schedule
[**Get-BetaSodPolicy**](#get-sod-policy) | **GET** `/sod-policies/{id}` | Get sod policy by id
[**Get-BetaSodPolicySchedule**](#get-sod-policy-schedule) | **GET** `/sod-policies/{id}/schedule` | Get sod policy schedule
[**Get-BetaSodViolationReportRunStatus**](#get-sod-violation-report-run-status) | **GET** `/sod-policies/sod-violation-report-status/{reportResultId}` | Get violation report run status
[**Get-BetaSodViolationReportStatus**](#get-sod-violation-report-status) | **GET** `/sod-policies/{id}/violation-report` | Get SOD violation report status
[**Get-BetaSodPolicies**](#list-sod-policies) | **GET** `/sod-policies` | List SOD policies
[**Update-BetaSodPolicy**](#patch-sod-policy) | **PATCH** `/sod-policies/{id}` | Patch a SOD policy
[**Send-BetaPolicySchedule**](#put-policy-schedule) | **PUT** `/sod-policies/{id}/schedule` | Update SOD Policy schedule
[**Send-BetaSodPolicy**](#put-sod-policy) | **PUT** `/sod-policies/{id}` | Update SOD policy by ID
[**Get-BetaSodViolationReportStatus**](#get-sod-violation-report-status) | **GET** `/sod-policies/{id}/violation-report` | Get sod violation report status
[**Get-BetaSodPolicies**](#list-sod-policies) | **GET** `/sod-policies` | List sod policies
[**Update-BetaSodPolicy**](#patch-sod-policy) | **PATCH** `/sod-policies/{id}` | Patch a sod policy
[**Send-BetaPolicySchedule**](#put-policy-schedule) | **PUT** `/sod-policies/{id}/schedule` | Update sod policy schedule
[**Send-BetaSodPolicy**](#put-sod-policy) | **PUT** `/sod-policies/{id}` | Update sod policy by id
[**Start-BetaSodAllPoliciesForOrg**](#start-sod-all-policies-for-org) | **POST** `/sod-violation-report/run` | Runs all policies for org
[**Start-BetaSodPolicy**](#start-sod-policy) | **POST** `/sod-policies/{id}/violation-report/run` | Runs SOD policy violation report
[**Start-BetaSodPolicy**](#start-sod-policy) | **POST** `/sod-policies/{id}/violation-report/run` | Runs sod policy violation report
## create-sod-policy
@@ -151,7 +151,7 @@ $SodPolicy = @"{
"externalPolicyReference" : "XYZ policy"
}"@
# Create SOD policy
# Create sod policy
try {
$Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy
@@ -204,7 +204,7 @@ Code | Description | Data Type
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD Policy to delete.
$Logical = $true # Boolean | Indicates whether this is a soft delete (logical true) or a hard delete. (optional) (default to $true)
# Delete SOD policy by ID
# Delete sod policy by id
try {
Remove-BetaSodPolicy -Id $Id
@@ -254,7 +254,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the SOD policy the schedule must be deleted for.
# Delete SOD policy schedule
# Delete sod policy schedule
try {
Remove-BetaSodPolicySchedule -Id $Id
@@ -453,7 +453,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve.
# Get SOD policy by ID
# Get sod policy by id
try {
Get-BetaSodPolicy -Id $Id
@@ -502,7 +502,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve.
# Get SOD policy schedule
# Get sod policy schedule
try {
Get-BetaSodPolicySchedule -Id $Id
@@ -602,7 +602,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve.
# Get SOD violation report status
# Get sod violation report status
try {
Get-BetaSodViolationReportStatus -Id $Id
@@ -659,7 +659,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Filters = 'id eq "bc693f07e7b645539626c25954c58554"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in* **state**: *eq, in* (optional)
$Sorters = "id,name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, description** (optional)
# List SOD policies
# List sod policies
try {
Get-BetaSodPolicies
@@ -714,7 +714,7 @@ $RequestBody = # SystemCollectionsHashtable[] | A list of SOD Policy update ope
$RequestBody = @"[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}]"@ # SystemCollectionsHashtable[] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria
# Patch a SOD policy
# Patch a sod policy
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
@@ -851,7 +851,7 @@ $SodPolicySchedule = @"{
"emailEmptyResults" : false
}"@
# Update SOD Policy schedule
# Update sod policy schedule
try {
$Result = ConvertFrom-JsonToSodPolicySchedule -Json $SodPolicySchedule
@@ -959,7 +959,7 @@ $SodPolicy = @"{
"externalPolicyReference" : "XYZ policy"
}"@
# Update SOD policy by ID
# Update sod policy by id
try {
$Result = ConvertFrom-JsonToSodPolicy -Json $SodPolicy
@@ -1061,7 +1061,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The SOD policy ID to run.
# Runs SOD policy violation report
# Runs sod policy violation report
try {
Start-BetaSodPolicy -Id $Id

4
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSODViolationsApi.md
View File

@@ -35,7 +35,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Start-BetaPredictSodViolations**](#start-predict-sod-violations) | **POST** `/sod-violations/predict` | Predict SOD violations for identity.
[**Start-BetaPredictSodViolations**](#start-predict-sod-violations) | **POST** `/sod-violations/predict` | Predict sod violations for identity.
## start-predict-sod-violations
@@ -86,7 +86,7 @@ $IdentityWithNewAccess = @"{
} ]
}"@
# Predict SOD violations for identity.
# Predict sod violations for identity.
try {
$Result = ConvertFrom-JsonToIdentityWithNewAccess -Json $IdentityWithNewAccess

4
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSPConfigApi.md
View File

@@ -23,7 +23,7 @@ Method | HTTP request | Description
[**Get-BetaSpConfigImport**](#get-sp-config-import) | **GET** `/sp-config/import/{id}/download` | Download import job result
[**Get-BetaSpConfigImportStatus**](#get-sp-config-import-status) | **GET** `/sp-config/import/{id}` | Get import job status
[**Import-BetaSpConfig**](#import-sp-config) | **POST** `/sp-config/import` | Initiates configuration objects import job
[**Get-BetaSpConfigObjects**](#list-sp-config-objects) | **GET** `/sp-config/config-objects` | List Config Objects
[**Get-BetaSpConfigObjects**](#list-sp-config-objects) | **GET** `/sp-config/config-objects` | List config objects
## export-sp-config
@@ -357,7 +357,7 @@ Code | Description | Data Type
### Example
```powershell
# List Config Objects
# List config objects
try {
Get-BetaSpConfigObjects

20
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSearchAttributeConfigurationApi.md
View File

@@ -35,11 +35,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-BetaSearchAttributeConfig**](#create-search-attribute-config) | **POST** `/accounts/search-attribute-config` | Create Extended Search Attributes
[**Remove-BetaSearchAttributeConfig**](#delete-search-attribute-config) | **DELETE** `/accounts/search-attribute-config/{name}` | Delete Extended Search Attribute
[**Get-BetaSearchAttributeConfig**](#get-search-attribute-config) | **GET** `/accounts/search-attribute-config` | List Extended Search Attributes
[**Get-BetaSingleSearchAttributeConfig**](#get-single-search-attribute-config) | **GET** `/accounts/search-attribute-config/{name}` | Get Extended Search Attribute
[**Update-BetaSearchAttributeConfig**](#patch-search-attribute-config) | **PATCH** `/accounts/search-attribute-config/{name}` | Update Extended Search Attribute
[**New-BetaSearchAttributeConfig**](#create-search-attribute-config) | **POST** `/accounts/search-attribute-config` | Create extended search attributes
[**Remove-BetaSearchAttributeConfig**](#delete-search-attribute-config) | **DELETE** `/accounts/search-attribute-config/{name}` | Delete extended search attribute
[**Get-BetaSearchAttributeConfig**](#get-search-attribute-config) | **GET** `/accounts/search-attribute-config` | List extended search attributes
[**Get-BetaSingleSearchAttributeConfig**](#get-single-search-attribute-config) | **GET** `/accounts/search-attribute-config/{name}` | Get extended search attribute
[**Update-BetaSearchAttributeConfig**](#patch-search-attribute-config) | **PATCH** `/accounts/search-attribute-config/{name}` | Update extended search attribute
## create-search-attribute-config
@@ -82,7 +82,7 @@ $SearchAttributeConfig = @"{
}
}"@
# Create Extended Search Attributes
# Create extended search attributes
try {
$Result = ConvertFrom-JsonToSearchAttributeConfig -Json $SearchAttributeConfig
@@ -128,7 +128,7 @@ Code | Description | Data Type
```powershell
$Name = "newMailAttribute" # String | Name of the extended search attribute configuration to delete.
# Delete Extended Search Attribute
# Delete extended search attribute
try {
Remove-BetaSearchAttributeConfig -Name $Name
@@ -176,7 +176,7 @@ Code | Description | Data Type
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
# List Extended Search Attributes
# List extended search attributes
try {
Get-BetaSearchAttributeConfig
@@ -222,7 +222,7 @@ Code | Description | Data Type
```powershell
$Name = "newMailAttribute" # String | Name of the extended search attribute configuration to get.
# Get Extended Search Attribute
# Get extended search attribute
try {
Get-BetaSingleSearchAttributeConfig -Name $Name
@@ -277,7 +277,7 @@ $Name = "promotedMailAttribute" # String | Name of the extended search attribute
}"@ # JsonPatchOperation[] |
# Update Extended Search Attribute
# Update extended search attribute
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation

20
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSegmentsApi.md
View File

@@ -34,11 +34,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-BetaSegment**](#create-segment) | **POST** `/segments` | Create Segment
[**Remove-BetaSegment**](#delete-segment) | **DELETE** `/segments/{id}` | Delete Segment by ID
[**Get-BetaSegment**](#get-segment) | **GET** `/segments/{id}` | Get Segment by ID
[**Get-BetaSegments**](#list-segments) | **GET** `/segments` | List Segments
[**Update-BetaSegment**](#patch-segment) | **PATCH** `/segments/{id}` | Update Segment
[**New-BetaSegment**](#create-segment) | **POST** `/segments` | Create segment
[**Remove-BetaSegment**](#delete-segment) | **DELETE** `/segments/{id}` | Delete segment by id
[**Get-BetaSegment**](#get-segment) | **GET** `/segments/{id}` | Get segment by id
[**Get-BetaSegments**](#list-segments) | **GET** `/segments` | List segments
[**Update-BetaSegment**](#patch-segment) | **PATCH** `/segments/{id}` | Update segment
## create-segment
@@ -97,7 +97,7 @@ $Segment = @"{
"id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"
}"@
# Create Segment
# Create segment
try {
$Result = ConvertFrom-JsonToSegment -Json $Segment
@@ -146,7 +146,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to delete.
# Delete Segment by ID
# Delete segment by id
try {
Remove-BetaSegment -Id $Id
@@ -193,7 +193,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The segment ID to retrieve.
# Get Segment by ID
# Get segment by id
try {
Get-BetaSegment -Id $Id
@@ -243,7 +243,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
# List Segments
# List segments
try {
Get-BetaSegments
@@ -295,7 +295,7 @@ $RequestBody = # SystemCollectionsHashtable[] | A list of segment update operat
$RequestBody = @"[{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}]"@ # SystemCollectionsHashtable[] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active
# Update Segment
# Update segment
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody

32
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaServiceDeskIntegrationApi.md
View File

@@ -41,15 +41,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-BetaServiceDeskIntegration**](#create-service-desk-integration) | **POST** `/service-desk-integrations` | Create new Service Desk integration
[**Remove-BetaServiceDeskIntegration**](#delete-service-desk-integration) | **DELETE** `/service-desk-integrations/{id}` | Delete a Service Desk integration
[**Get-BetaServiceDeskIntegration**](#get-service-desk-integration) | **GET** `/service-desk-integrations/{id}` | Get a Service Desk integration
[**Get-BetaServiceDeskIntegrationList**](#get-service-desk-integration-list) | **GET** `/service-desk-integrations` | List existing Service Desk integrations
[**Get-BetaServiceDeskIntegrationTemplate**](#get-service-desk-integration-template) | **GET** `/service-desk-integrations/templates/{scriptName}` | Service Desk integration template by scriptName
[**Get-BetaServiceDeskIntegrationTypes**](#get-service-desk-integration-types) | **GET** `/service-desk-integrations/types` | List Service Desk integration types
[**New-BetaServiceDeskIntegration**](#create-service-desk-integration) | **POST** `/service-desk-integrations` | Create new service desk integration
[**Remove-BetaServiceDeskIntegration**](#delete-service-desk-integration) | **DELETE** `/service-desk-integrations/{id}` | Delete a service desk integration
[**Get-BetaServiceDeskIntegration**](#get-service-desk-integration) | **GET** `/service-desk-integrations/{id}` | Get a service desk integration
[**Get-BetaServiceDeskIntegrationList**](#get-service-desk-integration-list) | **GET** `/service-desk-integrations` | List existing service desk integrations
[**Get-BetaServiceDeskIntegrationTemplate**](#get-service-desk-integration-template) | **GET** `/service-desk-integrations/templates/{scriptName}` | Service desk integration template by scriptname
[**Get-BetaServiceDeskIntegrationTypes**](#get-service-desk-integration-types) | **GET** `/service-desk-integrations/types` | List service desk integration types
[**Get-BetaStatusCheckDetails**](#get-status-check-details) | **GET** `/service-desk-integrations/status-check-configuration` | Get the time check configuration
[**Update-BetaServiceDeskIntegration**](#patch-service-desk-integration) | **PATCH** `/service-desk-integrations/{id}` | Patch a Service Desk Integration
[**Send-BetaServiceDeskIntegration**](#put-service-desk-integration) | **PUT** `/service-desk-integrations/{id}` | Update a Service Desk integration
[**Update-BetaServiceDeskIntegration**](#patch-service-desk-integration) | **PATCH** `/service-desk-integrations/{id}` | Patch a service desk integration
[**Send-BetaServiceDeskIntegration**](#put-service-desk-integration) | **PUT** `/service-desk-integrations/{id}` | Update a service desk integration
[**Update-BetaStatusCheckDetails**](#update-status-check-details) | **PUT** `/service-desk-integrations/status-check-configuration` | Update the time check configuration
@@ -115,7 +115,7 @@ $ServiceDeskIntegrationDto = @"{
"beforeProvisioningRule" : ""
}"@
# Create new Service Desk integration
# Create new service desk integration
try {
$Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto
@@ -162,7 +162,7 @@ Code | Description | Data Type
```powershell
$Id = "anId" # String | ID of Service Desk integration to delete
# Delete a Service Desk integration
# Delete a service desk integration
try {
Remove-BetaServiceDeskIntegration -Id $Id
@@ -208,7 +208,7 @@ Code | Description | Data Type
```powershell
$Id = "anId" # String | ID of the Service Desk integration to get
# Get a Service Desk integration
# Get a service desk integration
try {
Get-BetaServiceDeskIntegration -Id $Id
@@ -262,7 +262,7 @@ $Sorters = "name" # String | Sort results using the standard syntax described in
$Filters = 'id eq 2c91808b6ef1d43e016efba0ce470904' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
# List existing Service Desk integrations
# List existing service desk integrations
try {
Get-BetaServiceDeskIntegrationList
@@ -308,7 +308,7 @@ Code | Description | Data Type
```powershell
$ScriptName = "aScriptName" # String | The scriptName value of the Service Desk integration template to get
# Service Desk integration template by scriptName
# Service desk integration template by scriptname
try {
Get-BetaServiceDeskIntegrationTemplate -ScriptName $ScriptName
@@ -352,7 +352,7 @@ Code | Description | Data Type
### Example
```powershell
# List Service Desk integration types
# List service desk integration types
try {
Get-BetaServiceDeskIntegrationTypes
@@ -449,7 +449,7 @@ $Id = "anId" # String | ID of the Service Desk integration to update
}"@ # JsonPatchOperation[] | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed.
# Patch a Service Desk Integration
# Patch a service desk integration
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
@@ -528,7 +528,7 @@ $ServiceDeskIntegrationDto = @"{
"beforeProvisioningRule" : ""
}"@
# Update a Service Desk integration
# Update a service desk integration
try {
$Result = ConvertFrom-JsonToServiceDeskIntegrationDto -Json $ServiceDeskIntegrationDto

128
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSourcesApi.md
View File

@@ -74,49 +74,49 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-BetaProvisioningPolicy**](#create-provisioning-policy) | **POST** `/sources/{sourceId}/provisioning-policies` | Create Provisioning Policy
[**New-BetaSource**](#create-source) | **POST** `/sources` | Creates a source in IdentityNow.
[**New-BetaSourceSchema**](#create-source-schema) | **POST** `/sources/{sourceId}/schemas` | Create Schema on Source
[**Remove-Beta**](#delete) | **DELETE** `/sources/{id}` | Delete Source by ID
[**Remove-BetaAccountsAsync**](#delete-accounts-async) | **POST** `/sources/{sourceId}/remove-accounts` | Remove All Accounts in a Source
[**Remove-BetaNativeChangeDetectionConfig**](#delete-native-change-detection-config) | **DELETE** `/sources/{sourceId}/native-change-detection-config` | Delete Native Change Detection Configuration
[**Remove-BetaProvisioningPolicy**](#delete-provisioning-policy) | **DELETE** `/sources/{sourceId}/provisioning-policies/{usageType}` | Delete Provisioning Policy by UsageType
[**Remove-BetaSourceSchema**](#delete-source-schema) | **DELETE** `/sources/{sourceId}/schemas/{schemaId}` | Delete Source Schema by ID
[**Get-BetaCorrelationConfig**](#get-correlation-config) | **GET** `/sources/{sourceId}/correlation-config` | Get Source Correlation Configuration
[**Get-BetaNativeChangeDetectionConfig**](#get-native-change-detection-config) | **GET** `/sources/{sourceId}/native-change-detection-config` | Native Change Detection Configuration
[**Get-BetaProvisioningPolicy**](#get-provisioning-policy) | **GET** `/sources/{sourceId}/provisioning-policies/{usageType}` | Get Provisioning Policy by UsageType
[**Get-BetaSource**](#get-source) | **GET** `/sources/{id}` | Get Source by ID
[**New-BetaProvisioningPolicy**](#create-provisioning-policy) | **POST** `/sources/{sourceId}/provisioning-policies` | Create provisioning policy
[**New-BetaSource**](#create-source) | **POST** `/sources` | Creates a source in identitynow.
[**New-BetaSourceSchema**](#create-source-schema) | **POST** `/sources/{sourceId}/schemas` | Create schema on source
[**Remove-Beta**](#delete) | **DELETE** `/sources/{id}` | Delete source by id
[**Remove-BetaAccountsAsync**](#delete-accounts-async) | **POST** `/sources/{sourceId}/remove-accounts` | Remove all accounts in a source
[**Remove-BetaNativeChangeDetectionConfig**](#delete-native-change-detection-config) | **DELETE** `/sources/{sourceId}/native-change-detection-config` | Delete native change detection configuration
[**Remove-BetaProvisioningPolicy**](#delete-provisioning-policy) | **DELETE** `/sources/{sourceId}/provisioning-policies/{usageType}` | Delete provisioning policy by usagetype
[**Remove-BetaSourceSchema**](#delete-source-schema) | **DELETE** `/sources/{sourceId}/schemas/{schemaId}` | Delete source schema by id
[**Get-BetaCorrelationConfig**](#get-correlation-config) | **GET** `/sources/{sourceId}/correlation-config` | Get source correlation configuration
[**Get-BetaNativeChangeDetectionConfig**](#get-native-change-detection-config) | **GET** `/sources/{sourceId}/native-change-detection-config` | Native change detection configuration
[**Get-BetaProvisioningPolicy**](#get-provisioning-policy) | **GET** `/sources/{sourceId}/provisioning-policies/{usageType}` | Get provisioning policy by usagetype
[**Get-BetaSource**](#get-source) | **GET** `/sources/{id}` | Get source by id
[**Get-BetaSourceAccountsSchema**](#get-source-accounts-schema) | **GET** `/sources/{sourceId}/schemas/accounts` | Downloads source accounts schema template
[**Get-BetaSourceAttrSyncConfig**](#get-source-attr-sync-config) | **GET** `/sources/{id}/attribute-sync-config` | Attribute Sync Config
[**Get-BetaSourceAttrSyncConfig**](#get-source-attr-sync-config) | **GET** `/sources/{id}/attribute-sync-config` | Attribute sync config
[**Get-BetaSourceConfig**](#get-source-config) | **GET** `/sources/{id}/connectors/source-config` | Gets source config with language translations
[**Get-BetaSourceEntitlementRequestConfig**](#get-source-entitlement-request-config) | **GET** `/sources/{sourceId}/entitlement-request-config` | Get Source Entitlement Request Configuration
[**Get-BetaSourceEntitlementRequestConfig**](#get-source-entitlement-request-config) | **GET** `/sources/{sourceId}/entitlement-request-config` | Get source entitlement request configuration
[**Get-BetaSourceEntitlementsSchema**](#get-source-entitlements-schema) | **GET** `/sources/{sourceId}/schemas/entitlements` | Downloads source entitlements schema template
[**Get-BetaSourceSchema**](#get-source-schema) | **GET** `/sources/{sourceId}/schemas/{schemaId}` | Get Source Schema by ID
[**Get-BetaSourceSchemas**](#get-source-schemas) | **GET** `/sources/{sourceId}/schemas` | List Schemas on Source
[**Import-BetaAccounts**](#import-accounts) | **POST** `/sources/{sourceId}/load-accounts` | Account Aggregation
[**Import-BetaEntitlements**](#import-entitlements) | **POST** `/sources/{sourceId}/load-entitlements` | Entitlement Aggregation
[**Get-BetaSourceSchema**](#get-source-schema) | **GET** `/sources/{sourceId}/schemas/{schemaId}` | Get source schema by id
[**Get-BetaSourceSchemas**](#get-source-schemas) | **GET** `/sources/{sourceId}/schemas` | List schemas on source
[**Import-BetaAccounts**](#import-accounts) | **POST** `/sources/{sourceId}/load-accounts` | Account aggregation
[**Import-BetaEntitlements**](#import-entitlements) | **POST** `/sources/{sourceId}/load-entitlements` | Entitlement aggregation
[**Import-BetaSourceAccountsSchema**](#import-source-accounts-schema) | **POST** `/sources/{sourceId}/schemas/accounts` | Uploads source accounts schema template
[**Import-BetaSourceConnectorFile**](#import-source-connector-file) | **POST** `/sources/{sourceId}/upload-connector-file` | Upload connector file to source
[**Import-BetaSourceEntitlementsSchema**](#import-source-entitlements-schema) | **POST** `/sources/{sourceId}/schemas/entitlements` | Uploads source entitlements schema template
[**Import-BetaUncorrelatedAccounts**](#import-uncorrelated-accounts) | **POST** `/sources/{sourceId}/load-uncorrelated-accounts` | Process Uncorrelated Accounts
[**Get-BetaProvisioningPolicies**](#list-provisioning-policies) | **GET** `/sources/{sourceId}/provisioning-policies` | Lists ProvisioningPolicies
[**Get-BetaSources**](#list-sources) | **GET** `/sources` | Lists all sources in IdentityNow.
[**Import-BetaUncorrelatedAccounts**](#import-uncorrelated-accounts) | **POST** `/sources/{sourceId}/load-uncorrelated-accounts` | Process uncorrelated accounts
[**Get-BetaProvisioningPolicies**](#list-provisioning-policies) | **GET** `/sources/{sourceId}/provisioning-policies` | Lists provisioningpolicies
[**Get-BetaSources**](#list-sources) | **GET** `/sources` | Lists all sources in identitynow.
[**Receive-BetaResourceObjects**](#peek-resource-objects) | **POST** `/sources/{sourceId}/connector/peek-resource-objects` | Peek source connector's resource objects
[**Ping-BetaCluster**](#ping-cluster) | **POST** `/sources/{sourceId}/connector/ping-cluster` | Ping cluster for source connector
[**Send-BetaCorrelationConfig**](#put-correlation-config) | **PUT** `/sources/{sourceId}/correlation-config` | Update Source Correlation Configuration
[**Send-BetaNativeChangeDetectionConfig**](#put-native-change-detection-config) | **PUT** `/sources/{sourceId}/native-change-detection-config` | Update Native Change Detection Configuration
[**Send-BetaProvisioningPolicy**](#put-provisioning-policy) | **PUT** `/sources/{sourceId}/provisioning-policies/{usageType}` | Update Provisioning Policy by UsageType
[**Send-BetaSource**](#put-source) | **PUT** `/sources/{id}` | Update Source (Full)
[**Send-BetaSourceAttrSyncConfig**](#put-source-attr-sync-config) | **PUT** `/sources/{id}/attribute-sync-config` | Update Attribute Sync Config
[**Send-BetaSourceSchema**](#put-source-schema) | **PUT** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Full)
[**Send-BetaCorrelationConfig**](#put-correlation-config) | **PUT** `/sources/{sourceId}/correlation-config` | Update source correlation configuration
[**Send-BetaNativeChangeDetectionConfig**](#put-native-change-detection-config) | **PUT** `/sources/{sourceId}/native-change-detection-config` | Update native change detection configuration
[**Send-BetaProvisioningPolicy**](#put-provisioning-policy) | **PUT** `/sources/{sourceId}/provisioning-policies/{usageType}` | Update provisioning policy by usagetype
[**Send-BetaSource**](#put-source) | **PUT** `/sources/{id}` | Update source (full)
[**Send-BetaSourceAttrSyncConfig**](#put-source-attr-sync-config) | **PUT** `/sources/{id}/attribute-sync-config` | Update attribute sync config
[**Send-BetaSourceSchema**](#put-source-schema) | **PUT** `/sources/{sourceId}/schemas/{schemaId}` | Update source schema (full)
[**Sync-BetaAttributesForSource**](#sync-attributes-for-source) | **POST** `/sources/{sourceId}/synchronize-attributes` | Synchronize single source attributes.
[**Test-BetaSourceConfiguration**](#test-source-configuration) | **POST** `/sources/{sourceId}/connector/test-configuration` | Test configuration for source connector
[**Test-BetaSourceConnection**](#test-source-connection) | **POST** `/sources/{sourceId}/connector/check-connection` | Check connection for source connector.
[**Update-BetaProvisioningPoliciesInBulk**](#update-provisioning-policies-in-bulk) | **POST** `/sources/{sourceId}/provisioning-policies/bulk-update` | Bulk Update Provisioning Policies
[**Update-BetaProvisioningPolicy**](#update-provisioning-policy) | **PATCH** `/sources/{sourceId}/provisioning-policies/{usageType}` | Partial update of Provisioning Policy
[**Update-BetaSource**](#update-source) | **PATCH** `/sources/{id}` | Update Source (Partial)
[**Update-BetaSourceEntitlementRequestConfig**](#update-source-entitlement-request-config) | **PUT** `/sources/{sourceId}/entitlement-request-config` | Update Source Entitlement Request Configuration
[**Update-BetaSourceSchema**](#update-source-schema) | **PATCH** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Partial)
[**Update-BetaProvisioningPoliciesInBulk**](#update-provisioning-policies-in-bulk) | **POST** `/sources/{sourceId}/provisioning-policies/bulk-update` | Bulk update provisioning policies
[**Update-BetaProvisioningPolicy**](#update-provisioning-policy) | **PATCH** `/sources/{sourceId}/provisioning-policies/{usageType}` | Partial update of provisioning policy
[**Update-BetaSource**](#update-source) | **PATCH** `/sources/{id}` | Update source (partial)
[**Update-BetaSourceEntitlementRequestConfig**](#update-source-entitlement-request-config) | **PUT** `/sources/{sourceId}/entitlement-request-config` | Update source entitlement request configuration
[**Update-BetaSourceSchema**](#update-source-schema) | **PATCH** `/sources/{sourceId}/schemas/{schemaId}` | Update source schema (partial)
## create-provisioning-policy
@@ -194,7 +194,7 @@ $ProvisioningPolicyDto = @"{
"usageType" : "CREATE"
}"@
# Create Provisioning Policy
# Create provisioning policy
try {
$Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto
@@ -325,7 +325,7 @@ $Source = @"{
}"@
$ProvisionAsCsv = $false # Boolean | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional)
# Creates a source in IdentityNow.
# Creates a source in identitynow.
try {
$Result = ConvertFrom-JsonToSource -Json $Source
@@ -406,7 +406,7 @@ $Schema = @"{
"identityAttribute" : "sAMAccountName"
}"@
# Create Schema on Source
# Create schema on source
try {
$Result = ConvertFrom-JsonToSchema -Json $Schema
@@ -455,7 +455,7 @@ Code | Description | Data Type
```powershell
$Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID.
# Delete Source by ID
# Delete source by id
try {
Remove-Beta -Id $Id
@@ -506,7 +506,7 @@ Code | Description | Data Type
```powershell
$SourceId = "ebbf35756e1140699ce52b233121384a" # String | The source id
# Remove All Accounts in a Source
# Remove all accounts in a source
try {
Remove-BetaAccountsAsync -SourceId $SourceId
@@ -553,7 +553,7 @@ Code | Description | Data Type
```powershell
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The source id
# Delete Native Change Detection Configuration
# Delete native change detection configuration
try {
Remove-BetaNativeChangeDetectionConfig -SourceId $SourceId
@@ -601,7 +601,7 @@ Code | Description | Data Type
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID.
$UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
# Delete Provisioning Policy by UsageType
# Delete provisioning policy by usagetype
try {
Remove-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType
@@ -649,7 +649,7 @@ Code | Description | Data Type
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID.
$SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema ID.
# Delete Source Schema by ID
# Delete source schema by id
try {
Remove-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId
@@ -695,7 +695,7 @@ Code | Description | Data Type
```powershell
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The source id
# Get Source Correlation Configuration
# Get source correlation configuration
try {
Get-BetaCorrelationConfig -SourceId $SourceId
@@ -742,7 +742,7 @@ Code | Description | Data Type
```powershell
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The source id
# Native Change Detection Configuration
# Native change detection configuration
try {
Get-BetaNativeChangeDetectionConfig -SourceId $SourceId
@@ -790,7 +790,7 @@ Code | Description | Data Type
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID.
$UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
# Get Provisioning Policy by UsageType
# Get provisioning policy by usagetype
try {
Get-BetaProvisioningPolicy -SourceId $SourceId -UsageType $UsageType
@@ -837,7 +837,7 @@ Code | Description | Data Type
```powershell
$Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID.
# Get Source by ID
# Get source by id
try {
Get-BetaSource -Id $Id
@@ -930,7 +930,7 @@ Code | Description | Data Type
```powershell
$Id = "2c9180835d191a86015d28455b4a2329" # String | The source id
# Attribute Sync Config
# Attribute sync config
try {
Get-BetaSourceAttrSyncConfig -Id $Id
@@ -1029,7 +1029,7 @@ Code | Description | Data Type
```powershell
$SourceId = "8c190e6787aa4ed9a90bd9d5344523fb" # String | The Source id
# Get Source Entitlement Request Configuration
# Get source entitlement request configuration
try {
Get-BetaSourceEntitlementRequestConfig -SourceId $SourceId
@@ -1126,7 +1126,7 @@ Code | Description | Data Type
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source ID.
$SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema ID.
# Get Source Schema by ID
# Get source schema by id
try {
Get-BetaSourceSchema -SourceId $SourceId -SchemaId $SchemaId
@@ -1176,7 +1176,7 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | Source ID.
$IncludeTypes = "group" # String | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional)
$IncludeNames = "account" # String | A comma-separated list of schema names to filter result. (optional)
# List Schemas on Source
# List schemas on source
try {
Get-BetaSourceSchemas -SourceId $SourceId
@@ -1228,7 +1228,7 @@ $SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id
$File = # System.IO.FileInfo | The CSV file containing the source accounts to aggregate. (optional)
$DisableOptimization = "true" # String | Use this flag to reprocess every account whether or not the data has changed. (optional)
# Account Aggregation
# Account aggregation
try {
Import-BetaAccounts -SourceId $SourceId
@@ -1278,7 +1278,7 @@ Code | Description | Data Type
$SourceId = "ef38f94347e94562b5bb8424a56397d8" # String | Source Id
$File = # System.IO.FileInfo | The CSV file containing the source entitlements to aggregate. (optional)
# Entitlement Aggregation
# Entitlement aggregation
try {
Import-BetaEntitlements -SourceId $SourceId
@@ -1469,7 +1469,7 @@ Code | Description | Data Type
$SourceId = "75dbec1ebe154d5785da27b95e1dd5d7" # String | Source Id
$File = # System.IO.FileInfo | (optional)
# Process Uncorrelated Accounts
# Process uncorrelated accounts
try {
Import-BetaUncorrelatedAccounts -SourceId $SourceId
@@ -1515,7 +1515,7 @@ Code | Description | Data Type
```powershell
$SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id
# Lists ProvisioningPolicies
# Lists provisioningpolicies
try {
Get-BetaProvisioningPolicies -SourceId $SourceId
@@ -1575,7 +1575,7 @@ $Sorters = "name" # String | Sort results using the standard syntax described in
$ForSubadmin = "name" # String | Filter the returned list of sources for the identity specified by the parameter, which is the id of an identity with the role SOURCE_SUBADMIN. By convention, the value **me** indicates the identity id of the current user. Subadmins may only view Sources which they are able to administer; all other Sources will be filtered out when this parameter is set. If the current user is a SOURCE_SUBADMIN but fails to pass a valid value for this parameter, a 403 Forbidden is returned. (optional)
$IncludeIDNSource = $true # Boolean | Include the IdentityNow source in the response. (optional) (default to $false)
# Lists all sources in IdentityNow.
# Lists all sources in identitynow.
try {
Get-BetaSources
@@ -1743,7 +1743,7 @@ $CorrelationConfig = @"{
"id" : "2c9180835d191a86015d28455b4a2329"
}"@
# Update Source Correlation Configuration
# Update source correlation configuration
try {
$Result = ConvertFrom-JsonToCorrelationConfig -Json $CorrelationConfig
@@ -1801,7 +1801,7 @@ $NativeChangeDetectionConfig = @"{
"enabled" : true
}"@
# Update Native Change Detection Configuration
# Update native change detection configuration
try {
$Result = ConvertFrom-JsonToNativeChangeDetectionConfig -Json $NativeChangeDetectionConfig
@@ -1893,7 +1893,7 @@ $ProvisioningPolicyDto = @"{
"usageType" : "CREATE"
}"@
# Update Provisioning Policy by UsageType
# Update provisioning policy by usagetype
try {
$Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto
@@ -2038,7 +2038,7 @@ $Source = @"{
"since" : "2021-09-28T15:48:29.3801666300Z"
}"@
# Update Source (Full)
# Update source (full)
try {
$Result = ConvertFrom-JsonToSource -Json $Source
@@ -2106,7 +2106,7 @@ $AttrSyncSourceConfig = @"{
}
}"@
# Update Attribute Sync Config
# Update attribute sync config
try {
$Result = ConvertFrom-JsonToAttrSyncSourceConfig -Json $AttrSyncSourceConfig
@@ -2195,7 +2195,7 @@ $Schema = @"{
"identityAttribute" : "sAMAccountName"
}"@
# Update Source Schema (Full)
# Update source schema (full)
try {
$Result = ConvertFrom-JsonToSchema -Json $Schema
@@ -2425,7 +2425,7 @@ $SourceId = "2c9180835d191a86015d28455b4a2329" # String | The Source id.
}"@ # ProvisioningPolicyDto[] |
# Bulk Update Provisioning Policies
# Bulk update provisioning policies
try {
$Result = ConvertFrom-JsonToProvisioningPolicyDto -Json $ProvisioningPolicyDto
@@ -2483,7 +2483,7 @@ $UsageType = "CREATE" # UsageType | The type of provisioning policy usage. In I
}"@ # JsonPatchOperation[] | The JSONPatch payload used to update the schema.
# Partial update of Provisioning Policy
# Partial update of provisioning policy
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
@@ -2553,7 +2553,7 @@ $Id = "2c9180835d191a86015d28455b4a2329" # String | Source ID.
}"@ # JsonPatchOperation[] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC).
# Update Source (Partial)
# Update source (partial)
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
@@ -2629,7 +2629,7 @@ $SourceEntitlementRequestConfig = @"{
}
}"@
# Update Source Entitlement Request Configuration
# Update source entitlement request configuration
try {
$Result = ConvertFrom-JsonToSourceEntitlementRequestConfig -Json $SourceEntitlementRequestConfig
@@ -2714,7 +2714,7 @@ $SchemaId = "2c9180835d191a86015d28455b4a2329" # String | The Schema id.
}"@ # JsonPatchOperation[] | The JSONPatch payload used to update the schema.
# Update Source Schema (Partial)
# Update source schema (partial)
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation

71
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaSuggestedEntitlementDescriptionApi.md
View File

@@ -20,13 +20,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-BetaSedBatchStats**](#get-sed-batch-stats) | **GET** `/suggested-entitlement-description-batches/{batchId}/stats` | Submit Sed Batch Stats Request
[**Get-BetaSedBatches**](#get-sed-batches) | **GET** `/suggested-entitlement-description-batches` | List Sed Batch Request
[**Get-BetaSeds**](#list-seds) | **GET** `/suggested-entitlement-descriptions` | List Suggested Entitlement Descriptions
[**Update-BetaSed**](#patch-sed) | **PATCH** `/suggested-entitlement-descriptions` | Patch Suggested Entitlement Description
[**Submit-BetaSedApproval**](#submit-sed-approval) | **POST** `/suggested-entitlement-description-approvals` | Submit Bulk Approval Request
[**Submit-BetaSedAssignment**](#submit-sed-assignment) | **POST** `/suggested-entitlement-description-assignments` | Submit Sed Assignment Request
[**Submit-BetaSedBatchRequest**](#submit-sed-batch-request) | **POST** `/suggested-entitlement-description-batches` | Submit Sed Batch Request
[**Get-BetaSedBatchStats**](#get-sed-batch-stats) | **GET** `/suggested-entitlement-description-batches/{batchId}/stats` | Submit sed batch stats request
[**Get-BetaSedBatches**](#get-sed-batches) | **GET** `/suggested-entitlement-description-batches` | List Sed Batch Record
[**Get-BetaSeds**](#list-seds) | **GET** `/suggested-entitlement-descriptions` | List suggested entitlement descriptions
[**Update-BetaSed**](#patch-sed) | **PATCH** `/suggested-entitlement-descriptions` | Patch suggested entitlement description
[**Submit-BetaSedApproval**](#submit-sed-approval) | **POST** `/suggested-entitlement-description-approvals` | Submit bulk approval request
[**Submit-BetaSedAssignment**](#submit-sed-assignment) | **POST** `/suggested-entitlement-description-assignments` | Submit sed assignment request
[**Submit-BetaSedBatchRequest**](#submit-sed-batch-request) | **POST** `/suggested-entitlement-description-batches` | Submit sed batch request
## get-sed-batch-stats
@@ -65,7 +65,7 @@ Code | Description | Data Type
```powershell
$BatchId = "8c190e67-87aa-4ed9-a90b-d9d5344523fb" # String | Batch Id
# Submit Sed Batch Stats Request
# Submit sed batch stats request
try {
Get-BetaSedBatchStats -BatchId $BatchId
@@ -81,21 +81,26 @@ try {
## get-sed-batches
List Sed Batches.
API responses with Sed Batch Status
API responses with Sed Batch Records
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-sed-batches)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Query | Offset | **Int64** | (optional) (default to 0) | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0.
Query | Limit | **Int64** | (optional) (default to 250) | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used.
Query | Count | **Boolean** | (optional) (default to $false) | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used.
Query | CountOnly | **Boolean** | (optional) (default to $false) | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array.
Query | Status | **String** | (optional) | Batch Status
### Return type
[**SedBatchStatus**](../models/sed-batch-status)
[**Sed[]**](../models/sed)
### Responses
Code | Description | Data Type
------------- | ------------- | -------------
200 | Status of batch | SedBatchStatus
200 | List of Sed Batch Records | Sed[]
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
@@ -109,14 +114,19 @@ Code | Description | Data Type
### Example
```powershell
$Offset = 0 # Int64 | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0)
$Limit = 250 # Int64 | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250)
$Count = $true # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). Since requesting a total count can have a performance impact, it is recommended not to send `count=true` if that value will not be used. (optional) (default to $false)
$CountOnly = $true # Boolean | If `true` it will populate the `X-Total-Count` response header with the number of results that would be returned if `limit` and `offset` were ignored. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to $false)
$Status = "completed, failed, submitted, materialized, failed" # String | Batch Status (optional)
# List Sed Batch Request
# List Sed Batch Record
try {
Get-BetaSedBatches
# Below is a request that includes all optional parameters
# Get-BetaSedBatches
# Get-BetaSedBatches -Offset $Offset -Limit $Limit -Count $Count -CountOnly $CountOnly -Status $Status
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaSedBatches"
Write-Host $_.ErrorDetails
@@ -182,7 +192,7 @@ $CountOnly = $false # Boolean | If `true` it will populate the `X-Total-Count` r
$RequestedByAnyone = $false # Boolean | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional)
$ShowPendingStatusOnly = $false # Boolean | Will limit records to items that are in ""suggested"" or ""approved"" status (optional)
# List Suggested Entitlement Descriptions
# List suggested entitlement descriptions
try {
Get-BetaSeds
@@ -235,7 +245,7 @@ $Id = "ebab396f-0af1-4050-89b7-dafc63ec70e7" # String | id is sed id
}"@ # SedPatch[] | Sed Patch Request
# Patch Suggested Entitlement Description
# Patch suggested entitlement description
try {
$Result = ConvertFrom-JsonToSedPatch -Json $SedPatch
@@ -286,7 +296,7 @@ Code | Description | Data Type
}"@ # SedApproval[] | Sed Approval
# Submit Bulk Approval Request
# Submit bulk approval request
try {
$Result = ConvertFrom-JsonToSedApproval -Json $SedApproval
@@ -340,7 +350,7 @@ $SedAssignment = @"{
"items" : [ "016629d1-1d25-463f-97f3-0c6686846650", "016629d1-1d25-463f-97f3-0c6686846650" ]
}"@
# Submit Sed Assignment Request
# Submit sed assignment request
try {
$Result = ConvertFrom-JsonToSedAssignment -Json $SedAssignment
@@ -391,10 +401,33 @@ Code | Description | Data Type
```powershell
$SedBatchRequest = @"{
"entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ],
"seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ]
"seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ],
"searchCriteria" : {
"key" : {
"indices" : [ "entitlements" ],
"query" : {
"query" : "status:active"
},
"textQuery" : {
"terms" : [ "admin", "user" ],
"matchAny" : true,
"fields" : [ "role", "name" ]
},
"searchAfter" : [ "12345", "67890" ],
"filters" : {
"status" : {
"type" : "TERMS",
"terms" : [ "active", "inactive" ]
}
},
"sort" : [ "name:asc", "createdAt:desc" ],
"queryType" : "TEXT",
"includeNested" : true
}
}
}"@
# Submit Sed Batch Request
# Submit sed batch request
try {
Submit-BetaSedBatchRequest

32
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTaggedObjectsApi.md
View File

@@ -70,14 +70,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Remove-BetaTaggedObject**](#delete-tagged-object) | **DELETE** `/tagged-objects/{type}/{id}` | Delete Object Tags
[**Remove-BetaTagsToManyObject**](#delete-tags-to-many-object) | **POST** `/tagged-objects/bulk-remove` | Remove Tags from Multiple Objects
[**Get-BetaTaggedObject**](#get-tagged-object) | **GET** `/tagged-objects/{type}/{id}` | Get Tagged Object
[**Get-BetaTaggedObjects**](#list-tagged-objects) | **GET** `/tagged-objects` | List Tagged Objects
[**Get-BetaTaggedObjectsByType**](#list-tagged-objects-by-type) | **GET** `/tagged-objects/{type}` | List Tagged Objects by Type
[**Send-BetaTaggedObject**](#put-tagged-object) | **PUT** `/tagged-objects/{type}/{id}` | Update Tagged Object
[**Set-BetaTagToObject**](#set-tag-to-object) | **POST** `/tagged-objects` | Add Tag to Object
[**Set-BetaTagsToManyObjects**](#set-tags-to-many-objects) | **POST** `/tagged-objects/bulk-add` | Tag Multiple Objects
[**Remove-BetaTaggedObject**](#delete-tagged-object) | **DELETE** `/tagged-objects/{type}/{id}` | Delete object tags
[**Remove-BetaTagsToManyObject**](#delete-tags-to-many-object) | **POST** `/tagged-objects/bulk-remove` | Remove tags from multiple objects
[**Get-BetaTaggedObject**](#get-tagged-object) | **GET** `/tagged-objects/{type}/{id}` | Get tagged object
[**Get-BetaTaggedObjects**](#list-tagged-objects) | **GET** `/tagged-objects` | List tagged objects
[**Get-BetaTaggedObjectsByType**](#list-tagged-objects-by-type) | **GET** `/tagged-objects/{type}` | List tagged objects by type
[**Send-BetaTaggedObject**](#put-tagged-object) | **PUT** `/tagged-objects/{type}/{id}` | Update tagged object
[**Set-BetaTagToObject**](#set-tag-to-object) | **POST** `/tagged-objects` | Add tag to object
[**Set-BetaTagsToManyObjects**](#set-tags-to-many-objects) | **POST** `/tagged-objects/bulk-add` | Tag multiple objects
## delete-tagged-object
@@ -113,7 +113,7 @@ Code | Description | Data Type
$Type = "ACCESS_PROFILE" # String | The type of object to delete tags from.
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object to delete tags from.
# Delete Object Tags
# Delete object tags
try {
Remove-BetaTaggedObject -Type $Type -Id $Id
@@ -172,7 +172,7 @@ $BulkTaggedObject = @"{
"tags" : [ "BU_FINANCE", "PCI" ]
}"@
# Remove Tags from Multiple Objects
# Remove tags from multiple objects
try {
$Result = ConvertFrom-JsonToBulkTaggedObject -Json $BulkTaggedObject
@@ -220,7 +220,7 @@ Code | Description | Data Type
$Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve.
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve.
# Get Tagged Object
# Get tagged object
try {
Get-BetaTaggedObject -Type $Type -Id $Id
@@ -273,7 +273,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = 'tagName eq "BU_FINANCE"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq, in* **objectRef.type**: *eq, in* **tagName**: *eq, in* (optional)
# List Tagged Objects
# List tagged objects
try {
Get-BetaTaggedObjects
@@ -328,7 +328,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = 'objectRef.id eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **objectRef.id**: *eq* **objectRef.type**: *eq* (optional)
# List Tagged Objects by Type
# List tagged objects by type
try {
Get-BetaTaggedObjectsByType -Type $Type
@@ -384,7 +384,7 @@ $TaggedObject = @"{
"tags" : [ "BU_FINANCE", "PCI" ]
}"@
# Update Tagged Object
# Update tagged object
try {
$Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject
@@ -439,7 +439,7 @@ $TaggedObject = @"{
"tags" : [ "BU_FINANCE", "PCI" ]
}"@
# Add Tag to Object
# Add tag to object
try {
$Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject
@@ -499,7 +499,7 @@ $BulkTaggedObject = @"{
"tags" : [ "BU_FINANCE", "PCI" ]
}"@
# Tag Multiple Objects
# Tag multiple objects
try {
$Result = ConvertFrom-JsonToBulkTaggedObject -Json $BulkTaggedObject

16
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTagsApi.md
View File

@@ -17,10 +17,10 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-BetaTag**](#create-tag) | **POST** `/tags` | Create Tag
[**Remove-BetaTagById**](#delete-tag-by-id) | **DELETE** `/tags/{id}` | Delete Tag
[**Get-BetaTagById**](#get-tag-by-id) | **GET** `/tags/{id}` | Get Tag By Id
[**Get-BetaTags**](#list-tags) | **GET** `/tags` | List Tags
[**New-BetaTag**](#create-tag) | **POST** `/tags` | Create tag
[**Remove-BetaTagById**](#delete-tag-by-id) | **DELETE** `/tags/{id}` | Delete tag
[**Get-BetaTagById**](#get-tag-by-id) | **GET** `/tags/{id}` | Get tag by id
[**Get-BetaTags**](#list-tags) | **GET** `/tags` | List tags
## create-tag
@@ -70,7 +70,7 @@ $Tag = @"{
"id" : "449ecdc0-d4ff-4341-acf6-92f6f7ce604f"
}"@
# Create Tag
# Create tag
try {
$Result = ConvertFrom-JsonToTag -Json $Tag
@@ -119,7 +119,7 @@ Code | Description | Data Type
```powershell
$Id = "329d96cf-3bdb-40a9-988a-b5037ab89022" # String | The ID of the object reference to delete.
# Delete Tag
# Delete tag
try {
Remove-BetaTagById -Id $Id
@@ -167,7 +167,7 @@ Code | Description | Data Type
```powershell
$Id = "329d96cf-3bdb-40a9-988a-b5037ab89022" # String | The ID of the object reference to retrieve.
# Get Tag By Id
# Get tag by id
try {
Get-BetaTagById -Id $Id
@@ -222,7 +222,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Filters = 'id eq "27462f54-61c7-4140-b5da-d5dbe27fc6db"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* (optional)
$Sorters = "name,-modified" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified** (optional)
# List Tags
# List tags
try {
Get-BetaTags

20
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTaskManagementApi.md
View File

@@ -17,11 +17,11 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-BetaPendingTaskHeaders**](#get-pending-task-headers) | **HEAD** `/task-status/pending-tasks` | Retrieve Pending Task List Headers
[**Get-BetaPendingTasks**](#get-pending-tasks) | **GET** `/task-status/pending-tasks` | Retrieve Pending Task Status List
[**Get-BetaTaskStatus**](#get-task-status) | **GET** `/task-status/{id}` | Get Task Status by ID
[**Get-BetaTaskStatusList**](#get-task-status-list) | **GET** `/task-status` | Retrieve Task Status List
[**Update-BetaTaskStatus**](#update-task-status) | **PATCH** `/task-status/{id}` | Update Task Status by ID
[**Get-BetaPendingTaskHeaders**](#get-pending-task-headers) | **HEAD** `/task-status/pending-tasks` | Retrieve pending task list headers
[**Get-BetaPendingTasks**](#get-pending-tasks) | **GET** `/task-status/pending-tasks` | Retrieve pending task status list
[**Get-BetaTaskStatus**](#get-task-status) | **GET** `/task-status/{id}` | Get task status by id
[**Get-BetaTaskStatusList**](#get-task-status-list) | **GET** `/task-status` | Retrieve task status list
[**Update-BetaTaskStatus**](#update-task-status) | **PATCH** `/task-status/{id}` | Update task status by id
## get-pending-task-headers
@@ -60,7 +60,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
# Retrieve Pending Task List Headers
# Retrieve pending task list headers
try {
Get-BetaPendingTaskHeaders
@@ -110,7 +110,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
# Retrieve Pending Task Status List
# Retrieve pending task status list
try {
Get-BetaPendingTasks
@@ -156,7 +156,7 @@ Code | Description | Data Type
```powershell
$Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID.
# Get Task Status by ID
# Get task status by id
try {
Get-BetaTaskStatus -Id $Id
@@ -211,7 +211,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Filters = 'completionStatus eq "Success"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **sourceId**: *eq, in* **completionStatus**: *eq, in* **type**: *eq, in* (optional)
$Sorters = "-created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **created** (optional)
# Retrieve Task Status List
# Retrieve task status list
try {
Get-BetaTaskStatusList
@@ -264,7 +264,7 @@ $Id = "00eebcf881994e419d72e757fd30dc0e" # String | Task ID.
}"@ # JsonPatchOperation[] | The JSONPatch payload used to update the object.
# Update Task Status by ID
# Update task status by id
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation

4
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTenantApi.md
View File

@@ -17,7 +17,7 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-BetaTenant**](#get-tenant) | **GET** `/tenant` | Get Tenant Information.
[**Get-BetaTenant**](#get-tenant) | **GET** `/tenant` | Get tenant information.
## get-tenant
@@ -50,7 +50,7 @@ Code | Description | Data Type
### Example
```powershell
# Get Tenant Information.
# Get tenant information.
try {
Get-BetaTenant

4
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTransformsApi.md
View File

@@ -24,7 +24,7 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**New-BetaTransform**](#create-transform) | **POST** `/transforms` | Create transform
[**Remove-BetaTransform**](#delete-transform) | **DELETE** `/transforms/{id}` | Delete a transform
[**Get-BetaTransform**](#get-transform) | **GET** `/transforms/{id}` | Transform by ID
[**Get-BetaTransform**](#get-transform) | **GET** `/transforms/{id}` | Transform by id
[**Get-BetaTransforms**](#list-transforms) | **GET** `/transforms` | List transforms
[**Update-BetaTransform**](#update-transform) | **PUT** `/transforms/{id}` | Update a transform
@@ -176,7 +176,7 @@ Code | Description | Data Type
```powershell
$Id = "2cd78adghjkja34jh2b1hkjhasuecd" # String | ID of the transform to retrieve
# Transform by ID
# Transform by id
try {
Get-BetaTransform -Id $Id

40
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTriggersApi.md
View File

@@ -58,16 +58,16 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Complete-BetaTriggerInvocation**](#complete-trigger-invocation) | **POST** `/trigger-invocations/{id}/complete` | Complete Trigger Invocation
[**New-BetaSubscription**](#create-subscription) | **POST** `/trigger-subscriptions` | Create a Subscription
[**Remove-BetaSubscription**](#delete-subscription) | **DELETE** `/trigger-subscriptions/{id}` | Delete a Subscription
[**Get-BetaSubscriptions**](#list-subscriptions) | **GET** `/trigger-subscriptions` | List Subscriptions
[**Get-BetaTriggerInvocationStatus**](#list-trigger-invocation-status) | **GET** `/trigger-invocations/status` | List Latest Invocation Statuses
[**Get-BetaTriggers**](#list-triggers) | **GET** `/triggers` | List Triggers
[**Update-BetaSubscription**](#patch-subscription) | **PATCH** `/trigger-subscriptions/{id}` | Patch a Subscription
[**Start-BetaTestTriggerInvocation**](#start-test-trigger-invocation) | **POST** `/trigger-invocations/test` | Start a Test Invocation
[**Test-BetaSubscriptionFilter**](#test-subscription-filter) | **POST** `/trigger-subscriptions/validate-filter` | Validate a Subscription Filter
[**Update-BetaSubscription**](#update-subscription) | **PUT** `/trigger-subscriptions/{id}` | Update a Subscription
[**Complete-BetaTriggerInvocation**](#complete-trigger-invocation) | **POST** `/trigger-invocations/{id}/complete` | Complete trigger invocation
[**New-BetaSubscription**](#create-subscription) | **POST** `/trigger-subscriptions` | Create a subscription
[**Remove-BetaSubscription**](#delete-subscription) | **DELETE** `/trigger-subscriptions/{id}` | Delete a subscription
[**Get-BetaSubscriptions**](#list-subscriptions) | **GET** `/trigger-subscriptions` | List subscriptions
[**Get-BetaTriggerInvocationStatus**](#list-trigger-invocation-status) | **GET** `/trigger-invocations/status` | List latest invocation statuses
[**Get-BetaTriggers**](#list-triggers) | **GET** `/triggers` | List triggers
[**Update-BetaSubscription**](#patch-subscription) | **PATCH** `/trigger-subscriptions/{id}` | Patch a subscription
[**Start-BetaTestTriggerInvocation**](#start-test-trigger-invocation) | **POST** `/trigger-invocations/test` | Start a test invocation
[**Test-BetaSubscriptionFilter**](#test-subscription-filter) | **POST** `/trigger-subscriptions/validate-filter` | Validate a subscription filter
[**Update-BetaSubscription**](#update-subscription) | **PUT** `/trigger-subscriptions/{id}` | Update a subscription
## complete-trigger-invocation
@@ -109,7 +109,7 @@ $CompleteInvocation = @"{
"error" : "Access request is denied."
}"@
# Complete Trigger Invocation
# Complete trigger invocation
try {
$Result = ConvertFrom-JsonToCompleteInvocation -Json $CompleteInvocation
@@ -181,7 +181,7 @@ $SubscriptionPostRequest = @"{
"enabled" : true
}"@
# Create a Subscription
# Create a subscription
try {
$Result = ConvertFrom-JsonToSubscriptionPostRequest -Json $SubscriptionPostRequest
@@ -228,7 +228,7 @@ Code | Description | Data Type
```powershell
$Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | Subscription ID
# Delete a Subscription
# Delete a subscription
try {
Remove-BetaSubscription -Id $Id
@@ -281,7 +281,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Filters = 'id eq "12cff757-c0c0-413b-8ad7-2a47956d1e89"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* **triggerId**: *eq* **type**: *eq, le* (optional)
$Sorters = "triggerName" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, triggerName** (optional)
# List Subscriptions
# List subscriptions
try {
Get-BetaSubscriptions
@@ -336,7 +336,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Filters = 'triggerId eq "idn:access-request-dynamic-approver"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **triggerId**: *eq* **subscriptionId**: *eq* (optional)
$Sorters = "created" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **triggerId, subscriptionName, created, completed** (optional)
# List Latest Invocation Statuses
# List latest invocation statuses
try {
Get-BetaTriggerInvocationStatus
@@ -389,7 +389,7 @@ $Count = $true # Boolean | If *true* it will populate the *X-Total-Count* respon
$Filters = 'id eq "idn:access-request-post-approval"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ge, le* (optional)
$Sorters = "name" # String | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name** (optional)
# List Triggers
# List triggers
try {
Get-BetaTriggers
@@ -440,7 +440,7 @@ $Id = "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde" # String | ID of the Subscription t
$SubscriptionPatchRequestInner = @""@ # SubscriptionPatchRequestInner[] |
# Patch a Subscription
# Patch a subscription
try {
$Result = ConvertFrom-JsonToSubscriptionPatchRequestInner -Json $SubscriptionPatchRequestInner
@@ -496,7 +496,7 @@ $TestInvocation = @"{
}
}"@
# Start a Test Invocation
# Start a test invocation
try {
$Result = ConvertFrom-JsonToTestInvocation -Json $TestInvocation
@@ -548,7 +548,7 @@ $ValidateFilterInputDto = @"{
}
}"@
# Validate a Subscription Filter
# Validate a subscription filter
try {
$Result = ConvertFrom-JsonToValidateFilterInputDto -Json $ValidateFilterInputDto
@@ -629,7 +629,7 @@ $SubscriptionPutRequest = @"{
"enabled" : true
}"@
# Update a Subscription
# Update a subscription
try {
$Result = ConvertFrom-JsonToSubscriptionPutRequest -Json $SubscriptionPutRequest

8
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaUIMetadataApi.md
View File

@@ -18,8 +18,8 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Get-BetaTenantUiMetadata**](#get-tenant-ui-metadata) | **GET** `/ui-metadata/tenant` | Get a tenant UI metadata
[**Set-BetaTenantUiMetadata**](#set-tenant-ui-metadata) | **PUT** `/ui-metadata/tenant` | Update tenant UI metadata
[**Get-BetaTenantUiMetadata**](#get-tenant-ui-metadata) | **GET** `/ui-metadata/tenant` | Get a tenant ui metadata
[**Set-BetaTenantUiMetadata**](#set-tenant-ui-metadata) | **PUT** `/ui-metadata/tenant` | Update tenant ui metadata
## get-tenant-ui-metadata
@@ -53,7 +53,7 @@ Code | Description | Data Type
### Example
```powershell
# Get a tenant UI metadata
# Get a tenant ui metadata
try {
Get-BetaTenantUiMetadata
@@ -104,7 +104,7 @@ $TenantUiMetadataItemUpdateRequest = @"{
"iframeWhiteList" : "http://example.com http://example2.com"
}"@
# Update tenant UI metadata
# Update tenant ui metadata
try {
$Result = ConvertFrom-JsonToTenantUiMetadataItemUpdateRequest -Json $TenantUiMetadataItemUpdateRequest

12
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaVendorConnectorMappingsApi.md
View File

@@ -21,9 +21,9 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-BetaVendorConnectorMapping**](#create-vendor-connector-mapping) | **POST** `/vendor-connector-mappings` | Create Vendor Connector Mapping
[**Remove-BetaVendorConnectorMapping**](#delete-vendor-connector-mapping) | **DELETE** `/vendor-connector-mappings` | Delete Vendor Connector Mapping
[**Get-BetaVendorConnectorMappings**](#get-vendor-connector-mappings) | **GET** `/vendor-connector-mappings` | List Vendor Connector Mappings
[**New-BetaVendorConnectorMapping**](#create-vendor-connector-mapping) | **POST** `/vendor-connector-mappings` | Create vendor connector mapping
[**Remove-BetaVendorConnectorMapping**](#delete-vendor-connector-mapping) | **DELETE** `/vendor-connector-mappings` | Delete vendor connector mapping
[**Get-BetaVendorConnectorMappings**](#get-vendor-connector-mappings) | **GET** `/vendor-connector-mappings` | List vendor connector mappings
## create-vendor-connector-mapping
@@ -81,7 +81,7 @@ $VendorConnectorMapping = @"{
}
}"@
# Create Vendor Connector Mapping
# Create vendor connector mapping
try {
$Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping
@@ -151,7 +151,7 @@ $VendorConnectorMapping = @"{
}
}"@
# Delete Vendor Connector Mapping
# Delete vendor connector mapping
try {
$Result = ConvertFrom-JsonToVendorConnectorMapping -Json $VendorConnectorMapping
@@ -197,7 +197,7 @@ Code | Description | Data Type
### Example
```powershell
# List Vendor Connector Mappings
# List vendor connector mappings
try {
Get-BetaVendorConnectorMappings

52
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkItemsApi.md
View File

@@ -31,19 +31,19 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Approve-BetaApprovalItem**](#approve-approval-item) | **POST** `/work-items/{id}/approve/{approvalItemId}` | Approve an Approval Item
[**Approve-BetaApprovalItemsInBulk**](#approve-approval-items-in-bulk) | **POST** `/work-items/bulk-approve/{id}` | Bulk approve Approval Items
[**Complete-BetaWorkItem**](#complete-work-item) | **POST** `/work-items/{id}` | Complete a Work Item
[**Get-BetaCompletedWorkItems**](#get-completed-work-items) | **GET** `/work-items/completed` | Completed Work Items
[**Get-BetaCountCompletedWorkItems**](#get-count-completed-work-items) | **GET** `/work-items/completed/count` | Count Completed Work Items
[**Get-BetaCountWorkItems**](#get-count-work-items) | **GET** `/work-items/count` | Count Work Items
[**Get-BetaWorkItem**](#get-work-item) | **GET** `/work-items/{id}` | Get a Work Item
[**Get-BetaWorkItemsSummary**](#get-work-items-summary) | **GET** `/work-items/summary` | Work Items Summary
[**Get-BetaWorkItems**](#list-work-items) | **GET** `/work-items` | List Work Items
[**Deny-BetaApprovalItem**](#reject-approval-item) | **POST** `/work-items/{id}/reject/{approvalItemId}` | Reject an Approval Item
[**Deny-BetaApprovalItemsInBulk**](#reject-approval-items-in-bulk) | **POST** `/work-items/bulk-reject/{id}` | Bulk reject Approval Items
[**Submit-BetaAccountSelection**](#submit-account-selection) | **POST** `/work-items/{id}/submit-account-selection` | Submit Account Selections
[**Submit-BetaForwardWorkItem**](#submit-forward-work-item) | **POST** `/work-items/{id}/forward` | Forward a Work Item
[**Approve-BetaApprovalItem**](#approve-approval-item) | **POST** `/work-items/{id}/approve/{approvalItemId}` | Approve an approval item
[**Approve-BetaApprovalItemsInBulk**](#approve-approval-items-in-bulk) | **POST** `/work-items/bulk-approve/{id}` | Bulk approve approval items
[**Complete-BetaWorkItem**](#complete-work-item) | **POST** `/work-items/{id}` | Complete a work item
[**Get-BetaCompletedWorkItems**](#get-completed-work-items) | **GET** `/work-items/completed` | Completed work items
[**Get-BetaCountCompletedWorkItems**](#get-count-completed-work-items) | **GET** `/work-items/completed/count` | Count completed work items
[**Get-BetaCountWorkItems**](#get-count-work-items) | **GET** `/work-items/count` | Count work items
[**Get-BetaWorkItem**](#get-work-item) | **GET** `/work-items/{id}` | Get a work item
[**Get-BetaWorkItemsSummary**](#get-work-items-summary) | **GET** `/work-items/summary` | Work items summary
[**Get-BetaWorkItems**](#list-work-items) | **GET** `/work-items` | List work items
[**Deny-BetaApprovalItem**](#reject-approval-item) | **POST** `/work-items/{id}/reject/{approvalItemId}` | Reject an approval item
[**Deny-BetaApprovalItemsInBulk**](#reject-approval-items-in-bulk) | **POST** `/work-items/bulk-reject/{id}` | Bulk reject approval items
[**Submit-BetaAccountSelection**](#submit-account-selection) | **POST** `/work-items/{id}/submit-account-selection` | Submit account selections
[**Submit-BetaForwardWorkItem**](#submit-forward-work-item) | **POST** `/work-items/{id}/forward` | Forward a work item
## approve-approval-item
@@ -83,7 +83,7 @@ Code | Description | Data Type
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
$ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item.
# Approve an Approval Item
# Approve an approval item
try {
Approve-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId
@@ -132,7 +132,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
# Bulk approve Approval Items
# Bulk approve approval items
try {
Approve-BetaApprovalItemsInBulk -Id $Id
@@ -183,7 +183,7 @@ Code | Description | Data Type
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
$Body = "MyBody" # String | Body is the request payload to create form definition request (optional)
# Complete a Work Item
# Complete a work item
try {
Complete-BetaWorkItem -Id $Id
@@ -238,7 +238,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
# Completed Work Items
# Completed work items
try {
Get-BetaCompletedWorkItems
@@ -291,7 +291,7 @@ $OwnerId = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the work item own
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
# Count Completed Work Items
# Count completed work items
try {
Get-BetaCountCompletedWorkItems
@@ -340,7 +340,7 @@ Code | Description | Data Type
```powershell
$OwnerId = "2c91808571bcfcf80171c23e4b4221fc" # String | ID of the work item owner. (optional)
# Count Work Items
# Count work items
try {
Get-BetaCountWorkItems
@@ -391,7 +391,7 @@ Code | Description | Data Type
$Id = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item.
$OwnerId = "2c9180835d191a86015d28455b4a2329" # String | ID of the work item owner. (optional)
# Get a Work Item
# Get a work item
try {
Get-BetaWorkItem -Id $Id
@@ -440,7 +440,7 @@ Code | Description | Data Type
```powershell
$OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional)
# Work Items Summary
# Work items summary
try {
Get-BetaWorkItemsSummary
@@ -495,7 +495,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$OwnerId = "ef38f94347e94562b5bb8424a56397d8" # String | ID of the work item owner. (optional)
# List Work Items
# List work items
try {
Get-BetaWorkItems
@@ -546,7 +546,7 @@ Code | Description | Data Type
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
$ApprovalItemId = "1211bcaa32112bcef6122adb21cef1ac" # String | The ID of the approval item.
# Reject an Approval Item
# Reject an approval item
try {
Deny-BetaApprovalItem -Id $Id -ApprovalItemId $ApprovalItemId
@@ -595,7 +595,7 @@ Code | Description | Data Type
```powershell
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
# Bulk reject Approval Items
# Bulk reject approval items
try {
Deny-BetaApprovalItemsInBulk -Id $Id
@@ -646,7 +646,7 @@ Code | Description | Data Type
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the work item
$RequestBody = @{ key_example = } # System.Collections.Hashtable | Account Selection Data map, keyed on fieldName
# Submit Account Selections
# Submit account selections
try {
$Result = ConvertFrom-JsonToRequestBody -Json $RequestBody
@@ -701,7 +701,7 @@ $WorkItemForward = @"{
"sendNotifications" : true
}"@
# Forward a Work Item
# Forward a work item
try {
$Result = ConvertFrom-JsonToWorkItemForward -Json $WorkItemForward

36
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkReassignmentApi.md
View File

@@ -27,15 +27,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**New-BetaReassignmentConfiguration**](#create-reassignment-configuration) | **POST** `/reassignment-configurations` | Create a Reassignment Configuration
[**Remove-BetaReassignmentConfiguration**](#delete-reassignment-configuration) | **DELETE** `/reassignment-configurations/{identityId}/{configType}` | Delete Reassignment Configuration
[**Get-BetaEvaluateReassignmentConfiguration**](#get-evaluate-reassignment-configuration) | **GET** `/reassignment-configurations/{identityId}/evaluate/{configType}` | Evaluate Reassignment Configuration
[**Get-BetaReassignmentConfigTypes**](#get-reassignment-config-types) | **GET** `/reassignment-configurations/types` | List Reassignment Config Types
[**Get-BetaReassignmentConfiguration**](#get-reassignment-configuration) | **GET** `/reassignment-configurations/{identityId}` | Get Reassignment Configuration
[**Get-BetaTenantConfigConfiguration**](#get-tenant-config-configuration) | **GET** `/reassignment-configurations/tenant-config` | Get Tenant-wide Reassignment Configuration settings
[**Get-BetaReassignmentConfigurations**](#list-reassignment-configurations) | **GET** `/reassignment-configurations` | List Reassignment Configurations
[**Send-BetaReassignmentConfig**](#put-reassignment-config) | **PUT** `/reassignment-configurations/{identityId}` | Update Reassignment Configuration
[**Send-BetaTenantConfiguration**](#put-tenant-configuration) | **PUT** `/reassignment-configurations/tenant-config` | Update Tenant-wide Reassignment Configuration settings
[**New-BetaReassignmentConfiguration**](#create-reassignment-configuration) | **POST** `/reassignment-configurations` | Create a reassignment configuration
[**Remove-BetaReassignmentConfiguration**](#delete-reassignment-configuration) | **DELETE** `/reassignment-configurations/{identityId}/{configType}` | Delete reassignment configuration
[**Get-BetaEvaluateReassignmentConfiguration**](#get-evaluate-reassignment-configuration) | **GET** `/reassignment-configurations/{identityId}/evaluate/{configType}` | Evaluate reassignment configuration
[**Get-BetaReassignmentConfigTypes**](#get-reassignment-config-types) | **GET** `/reassignment-configurations/types` | List reassignment config types
[**Get-BetaReassignmentConfiguration**](#get-reassignment-configuration) | **GET** `/reassignment-configurations/{identityId}` | Get reassignment configuration
[**Get-BetaTenantConfigConfiguration**](#get-tenant-config-configuration) | **GET** `/reassignment-configurations/tenant-config` | Get tenant-wide reassignment configuration settings
[**Get-BetaReassignmentConfigurations**](#list-reassignment-configurations) | **GET** `/reassignment-configurations` | List reassignment configurations
[**Send-BetaReassignmentConfig**](#put-reassignment-config) | **PUT** `/reassignment-configurations/{identityId}` | Update reassignment configuration
[**Send-BetaTenantConfiguration**](#put-tenant-configuration) | **PUT** `/reassignment-configurations/tenant-config` | Update tenant-wide reassignment configuration settings
## create-reassignment-configuration
@@ -75,7 +75,7 @@ $ConfigurationItemRequest = @"{
"startDate" : "2022-07-21T11:13:12.345Z"
}"@
# Create a Reassignment Configuration
# Create a reassignment configuration
try {
$Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest
@@ -123,7 +123,7 @@ Code | Description | Data Type
$IdentityId = "2c91808781a71ddb0181b9090b5c504e" # String | unique identity id
$ConfigType = "ACCESS_REQUESTS" # ConfigTypeEnum |
# Delete Reassignment Configuration
# Delete reassignment configuration
try {
Remove-BetaReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType
@@ -174,7 +174,7 @@ $ExclusionFilters = "MyExclusionFilters" # String[] | Exclusion filters that dis
$ExclusionFilters = @"SELF_REVIEW_DELEGATION"@ # String[] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional)
# Evaluate Reassignment Configuration
# Evaluate reassignment configuration
try {
Get-BetaEvaluateReassignmentConfiguration -IdentityId $IdentityId -ConfigType $ConfigType
@@ -217,7 +217,7 @@ Code | Description | Data Type
### Example
```powershell
# List Reassignment Config Types
# List reassignment config types
try {
Get-BetaReassignmentConfigTypes
@@ -263,7 +263,7 @@ Code | Description | Data Type
```powershell
$IdentityId = "2c91808781a71ddb0181b9090b5c504f" # String | unique identity id
# Get Reassignment Configuration
# Get reassignment configuration
try {
Get-BetaReassignmentConfiguration -IdentityId $IdentityId
@@ -307,7 +307,7 @@ Code | Description | Data Type
### Example
```powershell
# Get Tenant-wide Reassignment Configuration settings
# Get tenant-wide reassignment configuration settings
try {
Get-BetaTenantConfigConfiguration
@@ -355,7 +355,7 @@ Code | Description | Data Type
$Limit = 20 # Int32 | Max number of results to return. (optional) (default to 20)
$Offset = 10 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional)
# List Reassignment Configurations
# List reassignment configurations
try {
Get-BetaReassignmentConfigurations
@@ -408,7 +408,7 @@ $ConfigurationItemRequest = @"{
"startDate" : "2022-07-21T11:13:12.345Z"
}"@
# Update Reassignment Configuration
# Update reassignment configuration
try {
$Result = ConvertFrom-JsonToConfigurationItemRequest -Json $ConfigurationItemRequest
@@ -458,7 +458,7 @@ $TenantConfigurationRequest = @"{
}
}"@
# Update Tenant-wide Reassignment Configuration settings
# Update tenant-wide reassignment configuration settings
try {
$Result = ConvertFrom-JsonToTenantConfigurationRequest -Json $TenantConfigurationRequest

72
docs/tools/sdk/powershell/Reference/Beta/Methods/BetaWorkflowsApi.md
View File

@@ -18,24 +18,24 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**Suspend-BetaWorkflowExecution**](#cancel-workflow-execution) | **POST** `/workflow-executions/{id}/cancel` | Cancel Workflow Execution by ID
[**New-BetaWorkflow**](#create-workflow) | **POST** `/workflows` | Create Workflow
[**Remove-BetaWorkflow**](#delete-workflow) | **DELETE** `/workflows/{id}` | Delete Workflow By Id
[**Get-BetaWorkflow**](#get-workflow) | **GET** `/workflows/{id}` | Get Workflow By Id
[**Get-BetaWorkflowExecution**](#get-workflow-execution) | **GET** `/workflow-executions/{id}` | Get Workflow Execution
[**Get-BetaWorkflowExecutionHistory**](#get-workflow-execution-history) | **GET** `/workflow-executions/{id}/history` | Get Workflow Execution History
[**Get-BetaWorkflowExecutions**](#get-workflow-executions) | **GET** `/workflows/{id}/executions` | List Workflow Executions
[**Get-BetaCompleteWorkflowLibrary**](#list-complete-workflow-library) | **GET** `/workflow-library` | List Complete Workflow Library
[**Get-BetaWorkflowLibraryActions**](#list-workflow-library-actions) | **GET** `/workflow-library/actions` | List Workflow Library Actions
[**Get-BetaWorkflowLibraryOperators**](#list-workflow-library-operators) | **GET** `/workflow-library/operators` | List Workflow Library Operators
[**Get-BetaWorkflowLibraryTriggers**](#list-workflow-library-triggers) | **GET** `/workflow-library/triggers` | List Workflow Library Triggers
[**Get-BetaWorkflows**](#list-workflows) | **GET** `/workflows` | List Workflows
[**Update-BetaWorkflow**](#patch-workflow) | **PATCH** `/workflows/{id}` | Patch Workflow
[**Submit-BetaExternalExecuteWorkflow**](#post-external-execute-workflow) | **POST** `/workflows/execute/external/{id}` | Execute Workflow via External Trigger
[**Submit-BetaWorkflowExternalTrigger**](#post-workflow-external-trigger) | **POST** `/workflows/{id}/external/oauth-clients` | Generate External Trigger OAuth Client
[**Send-BetaWorkflow**](#put-workflow) | **PUT** `/workflows/{id}` | Update Workflow
[**Test-BetaExternalExecuteWorkflow**](#test-external-execute-workflow) | **POST** `/workflows/execute/external/{id}/test` | Test Workflow via External Trigger
[**Test-BetaWorkflow**](#test-workflow) | **POST** `/workflows/{id}/test` | Test Workflow By Id
[**Suspend-BetaWorkflowExecution**](#cancel-workflow-execution) | **POST** `/workflow-executions/{id}/cancel` | Cancel workflow execution by id
[**New-BetaWorkflow**](#create-workflow) | **POST** `/workflows` | Create workflow
[**Remove-BetaWorkflow**](#delete-workflow) | **DELETE** `/workflows/{id}` | Delete workflow by id
[**Get-BetaWorkflow**](#get-workflow) | **GET** `/workflows/{id}` | Get workflow by id
[**Get-BetaWorkflowExecution**](#get-workflow-execution) | **GET** `/workflow-executions/{id}` | Get workflow execution
[**Get-BetaWorkflowExecutionHistory**](#get-workflow-execution-history) | **GET** `/workflow-executions/{id}/history` | Get workflow execution history
[**Get-BetaWorkflowExecutions**](#get-workflow-executions) | **GET** `/workflows/{id}/executions` | List workflow executions
[**Get-BetaCompleteWorkflowLibrary**](#list-complete-workflow-library) | **GET** `/workflow-library` | List complete workflow library
[**Get-BetaWorkflowLibraryActions**](#list-workflow-library-actions) | **GET** `/workflow-library/actions` | List workflow library actions
[**Get-BetaWorkflowLibraryOperators**](#list-workflow-library-operators) | **GET** `/workflow-library/operators` | List workflow library operators
[**Get-BetaWorkflowLibraryTriggers**](#list-workflow-library-triggers) | **GET** `/workflow-library/triggers` | List workflow library triggers
[**Get-BetaWorkflows**](#list-workflows) | **GET** `/workflows` | List workflows
[**Update-BetaWorkflow**](#patch-workflow) | **PATCH** `/workflows/{id}` | Patch workflow
[**Submit-BetaExternalExecuteWorkflow**](#post-external-execute-workflow) | **POST** `/workflows/execute/external/{id}` | Execute workflow via external trigger
[**Submit-BetaWorkflowExternalTrigger**](#post-workflow-external-trigger) | **POST** `/workflows/{id}/external/oauth-clients` | Generate external trigger oauth client
[**Send-BetaWorkflow**](#put-workflow) | **PUT** `/workflows/{id}` | Update workflow
[**Test-BetaExternalExecuteWorkflow**](#test-external-execute-workflow) | **POST** `/workflows/execute/external/{id}/test` | Test workflow via external trigger
[**Test-BetaWorkflow**](#test-workflow) | **POST** `/workflows/{id}/test` | Test workflow by id
## cancel-workflow-execution
@@ -70,7 +70,7 @@ Code | Description | Data Type
```powershell
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | The workflow execution ID
# Cancel Workflow Execution by ID
# Cancel workflow execution by id
try {
Suspend-BetaWorkflowExecution -Id $Id
@@ -115,7 +115,7 @@ Code | Description | Data Type
```powershell
$CreateWorkflowRequest = @"{name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}}"@
# Create Workflow
# Create workflow
try {
$Result = ConvertFrom-JsonToCreateWorkflowRequest -Json $CreateWorkflowRequest
@@ -161,7 +161,7 @@ Code | Description | Data Type
```powershell
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow
# Delete Workflow By Id
# Delete workflow by id
try {
Remove-BetaWorkflow -Id $Id
@@ -208,7 +208,7 @@ Code | Description | Data Type
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow
$WorkflowMetrics = $false # Boolean | disable workflow metrics (optional) (default to $true)
# Get Workflow By Id
# Get workflow by id
try {
Get-BetaWorkflow -Id $Id
@@ -254,7 +254,7 @@ Code | Description | Data Type
```powershell
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Workflow execution ID.
# Get Workflow Execution
# Get workflow execution
try {
Get-BetaWorkflowExecution -Id $Id
@@ -300,7 +300,7 @@ Code | Description | Data Type
```powershell
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow execution
# Get Workflow Execution History
# Get workflow execution history
try {
Get-BetaWorkflowExecutionHistory -Id $Id
@@ -364,7 +364,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = 'status eq "Failed"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **startTime**: *eq, lt, le, gt, ge* **status**: *eq* (optional)
# List Workflow Executions
# List workflow executions
try {
Get-BetaWorkflowExecutions -Id $Id
@@ -411,7 +411,7 @@ Code | Description | Data Type
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
# List Complete Workflow Library
# List complete workflow library
try {
Get-BetaCompleteWorkflowLibrary
@@ -460,7 +460,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Filters = 'id eq "sp:create-campaign"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional)
# List Workflow Library Actions
# List workflow library actions
try {
Get-BetaWorkflowLibraryActions
@@ -503,7 +503,7 @@ Code | Description | Data Type
### Example
```powershell
# List Workflow Library Operators
# List workflow library operators
try {
Get-BetaWorkflowLibraryOperators
@@ -552,7 +552,7 @@ $Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Col
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Filters = 'id eq "idn:identity-attributes-changed"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq* (optional)
# List Workflow Library Triggers
# List workflow library triggers
try {
Get-BetaWorkflowLibraryTriggers
@@ -603,7 +603,7 @@ $Offset = 0 # Int32 | Offset into the full result set. Usually specified with *l
$TriggerId = "idn:identity-created" # String | Trigger ID (optional)
$ConnectorInstanceId = "28541fec-bb81-4ad4-88ef-0f7d213adcad" # String | Connector Instance ID (optional)
# List Workflows
# List workflows
try {
Get-BetaWorkflows
@@ -655,7 +655,7 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Workflow
}"@ # JsonPatchOperation[] |
# Patch Workflow
# Patch workflow
try {
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
@@ -703,7 +703,7 @@ Code | Description | Data Type
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow
$PostExternalExecuteWorkflowRequest = @""@
# Execute Workflow via External Trigger
# Execute workflow via external trigger
try {
Submit-BetaExternalExecuteWorkflow -Id $Id
@@ -748,7 +748,7 @@ Code | Description | Data Type
```powershell
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow
# Generate External Trigger OAuth Client
# Generate external trigger oauth client
try {
Submit-BetaWorkflowExternalTrigger -Id $Id
@@ -834,7 +834,7 @@ $WorkflowBody = @"{
"enabled" : false
}"@
# Update Workflow
# Update workflow
try {
$Result = ConvertFrom-JsonToWorkflowBody -Json $WorkflowBody
@@ -882,7 +882,7 @@ Code | Description | Data Type
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow
$TestExternalExecuteWorkflowRequest = @""@
# Test Workflow via External Trigger
# Test workflow via external trigger
try {
Test-BetaExternalExecuteWorkflow -Id $Id
@@ -931,7 +931,7 @@ Code | Description | Data Type
$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the workflow
$TestWorkflowRequest = @"{input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}}"@
# Test Workflow By Id
# Test workflow by id
try {
$Result = ConvertFrom-JsonToTestWorkflowRequest -Json $TestWorkflowRequest