Update to powershell SDK docs: 13122455471

2025-12-07 12:27:47 +00:00 · 2025-02-03 20:42:04 +00:00
parent aeda961e54
commit bdb088c15d
207 changed files with 3520 additions and 8694 deletions
--- a/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaNotificationsApi.md
+++ b/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaNotificationsApi.md
@@ -1,3 +1,4 @@
+
 ---
 id: beta-notifications
 title: Notifications
@@ -9,7 +10,6 @@ slug: /tools/sdk/powershell/beta/methods/notifications
 tags: ['SDK', 'Software Development Kit', 'Notifications', 'BetaNotifications']
 ---

-
 # Notifications
   
  
@@ -34,9 +34,7 @@ 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)

 ### Parameters 
@@ -45,7 +43,6 @@ Param Type | Name | Data Type | Required  | Description
 Body  | DomainAddress | [**DomainAddress**](../models/domain-address) | True  | 

 ### Return type
-
 [**DomainStatusDto**](../models/domain-status-dto)

 ### Responses
@@ -60,7 +57,6 @@ Code | Description  | Data Type
 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

 ### HTTP request headers
-
 - **Content-Type**: application/json
 - **Accept**: application/json

@@ -69,7 +65,9 @@ Code | Description  | Data Type
 $DomainAddress = @"{
  "domain" : "sailpoint.com"
 }"@
+
 # Verify domain address via DKIM
+
 try {
    $Result = ConvertFrom-JsonToDomainAddress -Json $DomainAddress
    New-BetaDomainDkim-BetaDomainAddress $Result
@@ -81,11 +79,8 @@ try {
    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.
@@ -96,7 +91,6 @@ Param Type | Name | Data Type | Required  | Description
 Body  | TemplateDto | [**TemplateDto**](../models/template-dto) | True  | 

 ### Return type
-
 [**TemplateDto**](../models/template-dto)

 ### Responses
@@ -110,7 +104,6 @@ Code | Description  | Data Type
 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

 ### HTTP request headers
-
 - **Content-Type**: application/json
 - **Accept**: application/json

@@ -134,7 +127,9 @@ $TemplateDto = @"{
  "id" : "c17bea3a-574d-453c-9e04-4365fbf5af0b",
  "key" : "cloud_manual_work_item_summary"
 }"@
+
 # Create Notification Template
+
 try {
    $Result = ConvertFrom-JsonToTemplateDto -Json $TemplateDto
    New-BetaNotificationTemplate-BetaTemplateDto $Result
@@ -146,11 +141,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## create-verified-from-address
-
 Create a new sender email address and initiate verification process.

 ### Parameters 
@@ -159,7 +151,6 @@ Param Type | Name | Data Type | Required  | Description
 Body  | EmailStatusDto | [**EmailStatusDto**](../models/email-status-dto) | True  | 

 ### Return type
-
 [**EmailStatusDto**](../models/email-status-dto)

 ### Responses
@@ -173,7 +164,6 @@ Code | Description  | Data Type
 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

 ### HTTP request headers
-
 - **Content-Type**: application/json
 - **Accept**: application/json

@@ -185,7 +175,9 @@ $EmailStatusDto = @"{
  "id" : "id",
  "email" : "sender@example.com"
 }"@
+
 # Create Verified From Address
+
 try {
    $Result = ConvertFrom-JsonToEmailStatusDto -Json $EmailStatusDto
    New-BetaVerifiedFromAddress-BetaEmailStatusDto $Result
@@ -197,11 +189,8 @@ try {
    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.

 ### Parameters 
@@ -210,7 +199,6 @@ Param Type | Name | Data Type | Required  | Description
 Body  | TemplateBulkDeleteDto | [**[]TemplateBulkDeleteDto**](../models/template-bulk-delete-dto) | True  | 

 ### Return type
-
 (empty response body)

 ### Responses
@@ -224,20 +212,20 @@ Code | Description  | Data Type
 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

 ### HTTP request headers
-
 - **Content-Type**: application/json
 - **Accept**: application/json

 ### Example
 ```powershell
- # TemplateBulkDeleteDto[] | 
 $TemplateBulkDeleteDto = @"{
  "medium" : "EMAIL",
  "locale" : "en",
  "key" : "cloud_manual_work_item_summary"
-}"@ 
+}"@ # TemplateBulkDeleteDto[] | 
+ 

 # Bulk Delete Notification Templates
+
 try {
    $Result = ConvertFrom-JsonToTemplateBulkDeleteDto -Json $TemplateBulkDeleteDto
    Remove-BetaNotificationTemplatesInBulk-BetaTemplateBulkDeleteDto $Result
@@ -249,11 +237,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## delete-verified-from-address
-
 Delete a verified sender email address

 ### Parameters 
@@ -262,7 +247,6 @@ Param Type | Name | Data Type | Required  | Description
 Path   | Id | **String** | True  | 

 ### Return type
-
 (empty response body)

 ### Responses
@@ -277,14 +261,15 @@ Code | Description  | Data Type
 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

 ### HTTP request headers
-
 - **Content-Type**: Not defined
 - **Accept**: application/json

 ### Example
 ```powershell
 $Id = "MyId" # String | 
+
 # Delete Verified From Address
+
 try {
    Remove-BetaVerifiedFromAddress-BetaId $Id 
    
@@ -295,11 +280,8 @@ try {
    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.

 ### Parameters 
@@ -307,7 +289,6 @@ Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 

 ### Return type
-
 [**DkimAttributes[]**](../models/dkim-attributes)

 ### Responses
@@ -321,13 +302,14 @@ Code | Description  | Data Type
 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

 ### HTTP request headers
-
 - **Content-Type**: Not defined
 - **Accept**: application/json

 ### Example
 ```powershell
+
 # Get DKIM Attributes
+
 try {
    Get-BetaDkimAttributes
    
@@ -338,11 +320,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## get-mail-from-attributes
-
 Retrieve MAIL FROM attributes for a given AWS SES identity.

 ### Parameters 
@@ -351,7 +330,6 @@ Param Type | Name | Data Type | Required  | Description
  Query | Id | **String** | True  | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status

 ### Return type
-
 [**MailFromAttributes**](../models/mail-from-attributes)

 ### Responses
@@ -365,14 +343,15 @@ Code | Description  | Data Type
 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

 ### HTTP request headers
-
 - **Content-Type**: Not defined
 - **Accept**: application/json

 ### Example
 ```powershell
 $Id = "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
+
 try {
    Get-BetaMailFromAttributes-BetaId $Id 
    
@@ -383,11 +362,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## get-notification-template
-
 This gets a template that you have modified for your site by Id.

 ### Parameters 
@@ -396,7 +372,6 @@ Param Type | Name | Data Type | Required  | Description
 Path   | Id | **String** | True  | Id of the Notification Template

 ### Return type
-
 [**TemplateDto[]**](../models/template-dto)

 ### Responses
@@ -410,14 +385,15 @@ Code | Description  | Data Type
 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

 ### HTTP request headers
-
 - **Content-Type**: Not defined
 - **Accept**: application/json

 ### Example
 ```powershell
 $Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Notification Template
+
 # Get Notification Template By Id
+
 try {
    Get-BetaNotificationTemplate-BetaId $Id 
    
@@ -428,11 +404,8 @@ try {
    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).

@@ -441,7 +414,6 @@ Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 

 ### Return type
-
 [**NotificationTemplateContext**](../models/notification-template-context)

 ### Responses
@@ -455,13 +427,14 @@ Code | Description  | Data Type
 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

 ### HTTP request headers
-
 - **Content-Type**: Not defined
 - **Accept**: application/json

 ### Example
 ```powershell
+
 # Get Notification Template Context
+
 try {
    Get-BetaNotificationsTemplateContext
    
@@ -472,11 +445,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## list-from-addresses
-
 Retrieve a list of sender email addresses and their verification statuses

 ### Parameters 
@@ -489,7 +459,6 @@ Param Type | Name | Data Type | Required  | Description
  Query | Sorters | **String** |   (optional) | 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**

 ### Return type
-
 [**EmailStatusDto[]**](../models/email-status-dto)

 ### Responses
@@ -502,7 +471,6 @@ Code | Description  | Data Type
 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

 ### HTTP request headers
-
 - **Content-Type**: Not defined
 - **Accept**: application/json

@@ -513,7 +481,9 @@ $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 = '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
+
 try {
    Get-BetaFromAddresses
    
@@ -524,11 +494,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## list-notification-preferences
-
 Returns a list of notification preferences for tenant.

 ### Parameters 
@@ -536,7 +503,6 @@ Param Type | Name | Data Type | Required  | Description
 ------------- | ------------- | ------------- | ------------- | ------------- 

 ### Return type
-
 [**PreferencesDto[]**](../models/preferences-dto)

 ### Responses
@@ -551,13 +517,14 @@ Code | Description  | Data Type
 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

 ### HTTP request headers
-
 - **Content-Type**: Not defined
 - **Accept**: application/json

 ### Example
 ```powershell
+
 # List Notification Preferences for tenant.
+
 try {
    Get-BetaNotificationPreferences
    
@@ -568,11 +535,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## list-notification-template-defaults
-
 This lists the default templates used for notifications, such as emails from IdentityNow.

 ### Parameters 
@@ -583,7 +547,6 @@ Param Type | Name | Data Type | Required  | Description
  Query | Filters | **String** |   (optional) | 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*

 ### Return type
-
 [**TemplateDtoDefault[]**](../models/template-dto-default)

 ### Responses
@@ -597,7 +560,6 @@ Code | Description  | Data Type
 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

 ### HTTP request headers
-
 - **Content-Type**: Not defined
 - **Accept**: application/json

@@ -606,7 +568,9 @@ 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)
 $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
+
 try {
    Get-BetaNotificationTemplateDefaults
    
@@ -617,11 +581,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## list-notification-templates
-
 This lists the templates that you have modified for your site.

 ### Parameters 
@@ -632,7 +593,6 @@ Param Type | Name | Data Type | Required  | Description
  Query | Filters | **String** |   (optional) | 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*

 ### Return type
-
 [**TemplateDto[]**](../models/template-dto)

 ### Responses
@@ -646,7 +606,6 @@ Code | Description  | Data Type
 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

 ### HTTP request headers
-
 - **Content-Type**: Not defined
 - **Accept**: application/json

@@ -655,7 +614,9 @@ 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)
 $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
+
 try {
    Get-BetaNotificationTemplates
    
@@ -666,11 +627,8 @@ try {
    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

 ### Parameters 
@@ -679,7 +637,6 @@ Param Type | Name | Data Type | Required  | Description
 Body  | MailFromAttributesDto | [**MailFromAttributesDto**](../models/mail-from-attributes-dto) | True  | 

 ### Return type
-
 [**MailFromAttributes**](../models/mail-from-attributes)

 ### Responses
@@ -693,7 +650,6 @@ Code | Description  | Data Type
 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

 ### HTTP request headers
-
 - **Content-Type**: application/json
 - **Accept**: application/json

@@ -703,7 +659,9 @@ $MailFromAttributesDto = @"{
  "identity" : "BobSmith@sailpoint.com",
  "mailFromDomain" : "example.sailpoint.com"
 }"@
+
 # Change MAIL FROM domain
+
 try {
    $Result = ConvertFrom-JsonToMailFromAttributesDto -Json $MailFromAttributesDto
    Send-BetaMailFromAttributes-BetaMailFromAttributesDto $Result
@@ -715,11 +673,8 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
 ## send-test-notification
-
 Send a Test Notification

 ### Parameters 
@@ -728,7 +683,6 @@ Param Type | Name | Data Type | Required  | Description
 Body  | SendTestNotificationRequestDto | [**SendTestNotificationRequestDto**](../models/send-test-notification-request-dto) | True  | 

 ### Return type
-
 (empty response body)

 ### Responses
@@ -743,7 +697,6 @@ Code | Description  | Data Type
 500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto

 ### HTTP request headers
-
 - **Content-Type**: application/json
 - **Accept**: application/json

@@ -754,7 +707,9 @@ $SendTestNotificationRequestDto = @"{
  "medium" : "EMAIL",
  "key" : "cloud_manual_work_item_summary"
 }"@
+
 # Send Test Notification
+
 try {
    $Result = ConvertFrom-JsonToSendTestNotificationRequestDto -Json $SendTestNotificationRequestDto
    Send-BetaTestNotification-BetaSendTestNotificationRequestDto $Result
@@ -766,7 +721,4 @@ try {
    Write-Host $_.ErrorDetails
 }
 ```
-
 [[Back to top]](#) 
-
-