Update to powershell SDK docs: 13207859154

2025-12-07 12:27:47 +00:00 · 2025-02-07 20:53:08 +00:00
parent fea17715f4
commit 09ed592191
244 changed files with 12907 additions and 6931 deletions
--- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaNotificationsApi.md
+++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaNotificationsApi.md
@@ -33,9 +33,12 @@ Method | HTTP request | Description
 [**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
 Create a domain to be verified via DKIM (DomainKeys Identified Mail)

+[API Spec](https://developer.sailpoint.com/docs/api/beta/create-domain-dkim)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -69,21 +72,24 @@ $DomainAddress = @"{

 try {
    $Result = ConvertFrom-JsonToDomainAddress -Json $DomainAddress
-    New-BetaDomainDkim -BetaDomainAddress $Result
+    New-BetaDomainDkim -BetaDomainAddress $Result 
    
    # Below is a request that includes all optional parameters
-    # New-BetaDomainDkim -BetaDomainAddress $DomainAddress  
+    # New-BetaDomainDkim -BetaDomainAddress $Result  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaDomainDkim"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## create-notification-template
 This creates a template for your site. 

 You can also use this endpoint to update a template.  First, copy the response body from the [get notification template endpoint](https://developer.sailpoint.com/idn/api/beta/get-notification-template) for a template you wish to update and paste it into the request body for this endpoint.   Modify the fields you want to change and submit the POST request when ready.

+[API Spec](https://developer.sailpoint.com/docs/api/beta/create-notification-template)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -131,19 +137,22 @@ $TemplateDto = @"{

 try {
    $Result = ConvertFrom-JsonToTemplateDto -Json $TemplateDto
-    New-BetaNotificationTemplate -BetaTemplateDto $Result
+    New-BetaNotificationTemplate -BetaTemplateDto $Result 
    
    # Below is a request that includes all optional parameters
-    # New-BetaNotificationTemplate -BetaTemplateDto $TemplateDto  
+    # New-BetaNotificationTemplate -BetaTemplateDto $Result  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaNotificationTemplate"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## create-verified-from-address
 Create a new sender email address and initiate verification process.

+[API Spec](https://developer.sailpoint.com/docs/api/beta/create-verified-from-address)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -179,19 +188,22 @@ $EmailStatusDto = @"{

 try {
    $Result = ConvertFrom-JsonToEmailStatusDto -Json $EmailStatusDto
-    New-BetaVerifiedFromAddress -BetaEmailStatusDto $Result
+    New-BetaVerifiedFromAddress -BetaEmailStatusDto $Result 
    
    # Below is a request that includes all optional parameters
-    # New-BetaVerifiedFromAddress -BetaEmailStatusDto $EmailStatusDto  
+    # New-BetaVerifiedFromAddress -BetaEmailStatusDto $Result  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-BetaVerifiedFromAddress"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## delete-notification-templates-in-bulk
 This lets you bulk delete templates that you previously created for your site. Since this is a beta feature, please contact support to enable usage.

+[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-notification-templates-in-bulk)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -227,19 +239,22 @@ Code | Description  | Data Type

 try {
    $Result = ConvertFrom-JsonToTemplateBulkDeleteDto -Json $TemplateBulkDeleteDto
-    Remove-BetaNotificationTemplatesInBulk -BetaTemplateBulkDeleteDto $Result
+    Remove-BetaNotificationTemplatesInBulk -BetaTemplateBulkDeleteDto $Result 
    
    # Below is a request that includes all optional parameters
-    # Remove-BetaNotificationTemplatesInBulk -BetaTemplateBulkDeleteDto $TemplateBulkDeleteDto  
+    # Remove-BetaNotificationTemplatesInBulk -BetaTemplateBulkDeleteDto $Result  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaNotificationTemplatesInBulk"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## delete-verified-from-address
 Delete a verified sender email address

+[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-verified-from-address)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -270,19 +285,22 @@ $Id = "MyId" # String |
 # Delete Verified From Address

 try {
-    Remove-BetaVerifiedFromAddress -BetaId $Id 
+    Remove-BetaVerifiedFromAddress -Id $Id 
    
    # Below is a request that includes all optional parameters
-    # Remove-BetaVerifiedFromAddress -BetaId $Id  
+    # Remove-BetaVerifiedFromAddress -Id $Id  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-BetaVerifiedFromAddress"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## get-dkim-attributes
 Retrieve DKIM (DomainKeys Identified Mail) attributes for all your tenants' AWS SES identities. Limits retrieval to 100 identities per call.

+[API Spec](https://developer.sailpoint.com/docs/api/beta/get-dkim-attributes)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -310,7 +328,7 @@ Code | Description  | Data Type
 # Get DKIM Attributes

 try {
-    Get-BetaDkimAttributes
+    Get-BetaDkimAttributes 
    
    # Below is a request that includes all optional parameters
    # Get-BetaDkimAttributes  
@@ -320,9 +338,12 @@ try {
 }
 ```
 [[Back to top]](#) 
+
 ## get-mail-from-attributes
 Retrieve MAIL FROM attributes for a given AWS SES identity.

+[API Spec](https://developer.sailpoint.com/docs/api/beta/get-mail-from-attributes)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -352,19 +373,22 @@ $IdentityId = "bobsmith@sailpoint.com" # String | Returns the MX and TXT record
 # Get MAIL FROM Attributes

 try {
-    Get-BetaMailFromAttributes -BetaIdentityId $IdentityId 
+    Get-BetaMailFromAttributes -IdentityId $IdentityId 
    
    # Below is a request that includes all optional parameters
-    # Get-BetaMailFromAttributes -BetaIdentityId $IdentityId  
+    # Get-BetaMailFromAttributes -IdentityId $IdentityId  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaMailFromAttributes"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## get-notification-template
 This gets a template that you have modified for your site by Id.

+[API Spec](https://developer.sailpoint.com/docs/api/beta/get-notification-template)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -394,20 +418,23 @@ $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Notification T
 # Get Notification Template By Id

 try {
-    Get-BetaNotificationTemplate -BetaId $Id 
+    Get-BetaNotificationTemplate -Id $Id 
    
    # Below is a request that includes all optional parameters
-    # Get-BetaNotificationTemplate -BetaId $Id  
+    # Get-BetaNotificationTemplate -Id $Id  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationTemplate"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## get-notifications-template-context
 The notification service maintains metadata to construct the notification templates or supply any information during the event propagation. The data-store where this information is retrieved is called "Global Context" (a.k.a. notification template context). It defines a set of attributes
 that will be available per tenant (organization).

+[API Spec](https://developer.sailpoint.com/docs/api/beta/get-notifications-template-context)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -435,7 +462,7 @@ Code | Description  | Data Type
 # Get Notification Template Context

 try {
-    Get-BetaNotificationsTemplateContext
+    Get-BetaNotificationsTemplateContext 
    
    # Below is a request that includes all optional parameters
    # Get-BetaNotificationsTemplateContext  
@@ -445,9 +472,12 @@ try {
 }
 ```
 [[Back to top]](#) 
+
 ## list-from-addresses
 Retrieve a list of sender email addresses and their verification statuses

+[API Spec](https://developer.sailpoint.com/docs/api/beta/list-from-addresses)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -484,19 +514,22 @@ $Sorters = "email" # String | Sort results using the standard syntax described i
 # List From Addresses

 try {
-    Get-BetaFromAddresses
+    Get-BetaFromAddresses 
    
    # Below is a request that includes all optional parameters
-    # Get-BetaFromAddresses -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $Sorters  
+    # Get-BetaFromAddresses -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaFromAddresses"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## list-notification-preferences
 Returns a list of notification preferences for tenant.

+[API Spec](https://developer.sailpoint.com/docs/api/beta/list-notification-preferences)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -527,19 +560,22 @@ $Key = "cloud_manual_work_item_summary" # String | The notification key.
 # List Notification Preferences for tenant.

 try {
-    Get-BetaNotificationPreferences -BetaKey $Key 
+    Get-BetaNotificationPreferences -Key $Key 
    
    # Below is a request that includes all optional parameters
-    # Get-BetaNotificationPreferences -BetaKey $Key  
+    # Get-BetaNotificationPreferences -Key $Key  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationPreferences"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## list-notification-template-defaults
 This lists the default templates used for notifications, such as emails from IdentityNow.

+[API Spec](https://developer.sailpoint.com/docs/api/beta/list-notification-template-defaults)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -573,19 +609,22 @@ $Filters = 'key eq "cloud_manual_work_item_summary"' # String | Filter results u
 # List Notification Template Defaults

 try {
-    Get-BetaNotificationTemplateDefaults
+    Get-BetaNotificationTemplateDefaults 
    
    # Below is a request that includes all optional parameters
-    # Get-BetaNotificationTemplateDefaults -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters  
+    # Get-BetaNotificationTemplateDefaults -Limit $Limit -Offset $Offset -Filters $Filters  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationTemplateDefaults"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## list-notification-templates
 This lists the templates that you have modified for your site.

+[API Spec](https://developer.sailpoint.com/docs/api/beta/list-notification-templates)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -619,19 +658,22 @@ $Filters = 'medium eq "EMAIL"' # String | Filter results using the standard synt
 # List Notification Templates

 try {
-    Get-BetaNotificationTemplates
+    Get-BetaNotificationTemplates 
    
    # Below is a request that includes all optional parameters
-    # Get-BetaNotificationTemplates -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $Filters  
+    # Get-BetaNotificationTemplates -Limit $Limit -Offset $Offset -Filters $Filters  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationTemplates"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## put-mail-from-attributes
 Change the MAIL FROM domain of an AWS SES email identity and provide the MX and TXT records to be placed in the caller's DNS

+[API Spec](https://developer.sailpoint.com/docs/api/beta/put-mail-from-attributes)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -665,19 +707,22 @@ $MailFromAttributesDto = @"{

 try {
    $Result = ConvertFrom-JsonToMailFromAttributesDto -Json $MailFromAttributesDto
-    Send-BetaMailFromAttributes -BetaMailFromAttributesDto $Result
+    Send-BetaMailFromAttributes -BetaMailFromAttributesDto $Result 
    
    # Below is a request that includes all optional parameters
-    # Send-BetaMailFromAttributes -BetaMailFromAttributesDto $MailFromAttributesDto  
+    # Send-BetaMailFromAttributes -BetaMailFromAttributesDto $Result  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaMailFromAttributes"
    Write-Host $_.ErrorDetails
 }
 ```
 [[Back to top]](#) 
+
 ## send-test-notification
 Send a Test Notification

+[API Spec](https://developer.sailpoint.com/docs/api/beta/send-test-notification)
+
 ### Parameters 
 Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 
@@ -713,10 +758,10 @@ $SendTestNotificationRequestDto = @"{

 try {
    $Result = ConvertFrom-JsonToSendTestNotificationRequestDto -Json $SendTestNotificationRequestDto
-    Send-BetaTestNotification -BetaSendTestNotificationRequestDto $Result
+    Send-BetaTestNotification -BetaSendTestNotificationRequestDto $Result 
    
    # Below is a request that includes all optional parameters
-    # Send-BetaTestNotification -BetaSendTestNotificationRequestDto $SendTestNotificationRequestDto  
+    # Send-BetaTestNotification -BetaSendTestNotificationRequestDto $Result  
 } catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-BetaTestNotification"
    Write-Host $_.ErrorDetails