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

Update to powershell SDK docs: 13207859154

Browse Source
This commit is contained in:
developer-relations-sp
2025-02-07 20:53:08 +00:00
parent fea17715f4
commit 09ed592191
244 changed files with 12907 additions and 6931 deletions
Download Patch File Download Diff File Expand all files Collapse all files

150
docs/tools/sdk/powershell/Reference/V2024/Methods/V2024NotificationsApi.md
View File

@@ -33,9 +33,15 @@ Method | HTTP request | Description
[**Send-V2024MailFromAttributes**](#put-mail-from-attributes) | **PUT** `/mail-from-attributes` | Change MAIL FROM domain
[**Send-V2024TestNotification**](#send-test-notification) | **POST** `/send-test-notification` | Send Test Notification
## create-domain-dkim
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Create a domain to be verified via DKIM (DomainKeys Identified Mail)
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-domain-dkim)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -71,21 +77,27 @@ $DomainAddress = @"{
try {
$Result = ConvertFrom-JsonToDomainAddress -Json $DomainAddress
New-V2024DomainDkim -V2024XSailPointExperimental $XSailPointExperimental -V2024DomainAddress $Result
New-V2024DomainDkim -XSailPointExperimental $XSailPointExperimental -V2024DomainAddress $Result
# Below is a request that includes all optional parameters
# New-V2024DomainDkim -V2024XSailPointExperimental $XSailPointExperimental -V2024DomainAddress $DomainAddress
# New-V2024DomainDkim -XSailPointExperimental $XSailPointExperimental -V2024DomainAddress $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024DomainDkim"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-notification-template
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
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/v2024/create-notification-template)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -135,19 +147,25 @@ $TemplateDto = @"{
try {
$Result = ConvertFrom-JsonToTemplateDto -Json $TemplateDto
New-V2024NotificationTemplate -V2024XSailPointExperimental $XSailPointExperimental -V2024TemplateDto $Result
New-V2024NotificationTemplate -XSailPointExperimental $XSailPointExperimental -V2024TemplateDto $Result
# Below is a request that includes all optional parameters
# New-V2024NotificationTemplate -V2024XSailPointExperimental $XSailPointExperimental -V2024TemplateDto $TemplateDto
# New-V2024NotificationTemplate -XSailPointExperimental $XSailPointExperimental -V2024TemplateDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024NotificationTemplate"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## create-verified-from-address
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Create a new sender email address and initiate verification process.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-verified-from-address)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -185,19 +203,25 @@ $EmailStatusDto = @"{
try {
$Result = ConvertFrom-JsonToEmailStatusDto -Json $EmailStatusDto
New-V2024VerifiedFromAddress -V2024XSailPointExperimental $XSailPointExperimental -V2024EmailStatusDto $Result
New-V2024VerifiedFromAddress -XSailPointExperimental $XSailPointExperimental -V2024EmailStatusDto $Result
# Below is a request that includes all optional parameters
# New-V2024VerifiedFromAddress -V2024XSailPointExperimental $XSailPointExperimental -V2024EmailStatusDto $EmailStatusDto
# New-V2024VerifiedFromAddress -XSailPointExperimental $XSailPointExperimental -V2024EmailStatusDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling New-V2024VerifiedFromAddress"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-notification-templates-in-bulk
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
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/v2024/delete-notification-templates-in-bulk)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -235,19 +259,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
try {
$Result = ConvertFrom-JsonToTemplateBulkDeleteDto -Json $TemplateBulkDeleteDto
Remove-V2024NotificationTemplatesInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024TemplateBulkDeleteDto $Result
Remove-V2024NotificationTemplatesInBulk -XSailPointExperimental $XSailPointExperimental -V2024TemplateBulkDeleteDto $Result
# Below is a request that includes all optional parameters
# Remove-V2024NotificationTemplatesInBulk -V2024XSailPointExperimental $XSailPointExperimental -V2024TemplateBulkDeleteDto $TemplateBulkDeleteDto
# Remove-V2024NotificationTemplatesInBulk -XSailPointExperimental $XSailPointExperimental -V2024TemplateBulkDeleteDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024NotificationTemplatesInBulk"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## delete-verified-from-address
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Delete a verified sender email address
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-verified-from-address)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -280,19 +310,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Delete Verified From Address
try {
Remove-V2024VerifiedFromAddress -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Remove-V2024VerifiedFromAddress -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Remove-V2024VerifiedFromAddress -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Remove-V2024VerifiedFromAddress -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024VerifiedFromAddress"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-dkim-attributes
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
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/v2024/get-dkim-attributes)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -322,19 +358,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get DKIM Attributes
try {
Get-V2024DkimAttributes -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024DkimAttributes -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024DkimAttributes -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024DkimAttributes -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024DkimAttributes"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-mail-from-attributes
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Retrieve MAIL FROM attributes for a given AWS SES identity.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-mail-from-attributes)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -366,19 +408,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get MAIL FROM Attributes
try {
Get-V2024MailFromAttributes -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024MailFromAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024MailFromAttributes -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024MailFromAttributes -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024MailFromAttributes"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-notification-template
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This gets a template that you have modified for your site by Id.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-notification-template)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -410,20 +458,26 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get Notification Template By Id
try {
Get-V2024NotificationTemplate -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024NotificationTemplate -Id $Id -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024NotificationTemplate -V2024Id $Id -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024NotificationTemplate -Id $Id -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationTemplate"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## get-notifications-template-context
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
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/v2024/get-notifications-template-context)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -453,19 +507,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# Get Notification Template Context
try {
Get-V2024NotificationsTemplateContext -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024NotificationsTemplateContext -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024NotificationsTemplateContext -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024NotificationsTemplateContext -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationsTemplateContext"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-from-addresses
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Retrieve a list of sender email addresses and their verification statuses
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-from-addresses)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -504,19 +564,25 @@ $Sorters = "email" # String | Sort results using the standard syntax described i
# List From Addresses
try {
Get-V2024FromAddresses -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024FromAddresses -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024FromAddresses -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Count $Count -V2024Filters $Filters -V2024Sorters $Sorters
# Get-V2024FromAddresses -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters -Sorters $Sorters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024FromAddresses"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-notification-preferences
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Returns a list of notification preferences for tenant.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-notification-preferences)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -547,19 +613,25 @@ $XSailPointExperimental = "true" # String | Use this header to enable this exper
# List Notification Preferences for tenant.
try {
Get-V2024NotificationPreferences -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024NotificationPreferences -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024NotificationPreferences -V2024XSailPointExperimental $XSailPointExperimental
# Get-V2024NotificationPreferences -XSailPointExperimental $XSailPointExperimental
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationPreferences"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-notification-template-defaults
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This lists the default templates used for notifications, such as emails from IdentityNow.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-notification-template-defaults)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -595,19 +667,25 @@ $Filters = 'key eq "cloud_manual_work_item_summary"' # String | Filter results u
# List Notification Template Defaults
try {
Get-V2024NotificationTemplateDefaults -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024NotificationTemplateDefaults -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024NotificationTemplateDefaults -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters
# Get-V2024NotificationTemplateDefaults -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationTemplateDefaults"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## list-notification-templates
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
This lists the templates that you have modified for your site.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-notification-templates)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -643,19 +721,25 @@ $Filters = 'medium eq "EMAIL"' # String | Filter results using the standard synt
# List Notification Templates
try {
Get-V2024NotificationTemplates -V2024XSailPointExperimental $XSailPointExperimental
Get-V2024NotificationTemplates -XSailPointExperimental $XSailPointExperimental
# Below is a request that includes all optional parameters
# Get-V2024NotificationTemplates -V2024XSailPointExperimental $XSailPointExperimental -V2024Limit $Limit -V2024Offset $Offset -V2024Filters $Filters
# Get-V2024NotificationTemplates -XSailPointExperimental $XSailPointExperimental -Limit $Limit -Offset $Offset -Filters $Filters
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024NotificationTemplates"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## put-mail-from-attributes
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
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/v2024/put-mail-from-attributes)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -691,19 +775,25 @@ $MailFromAttributesDto = @"{
try {
$Result = ConvertFrom-JsonToMailFromAttributesDto -Json $MailFromAttributesDto
Send-V2024MailFromAttributes -V2024XSailPointExperimental $XSailPointExperimental -V2024MailFromAttributesDto $Result
Send-V2024MailFromAttributes -XSailPointExperimental $XSailPointExperimental -V2024MailFromAttributesDto $Result
# Below is a request that includes all optional parameters
# Send-V2024MailFromAttributes -V2024XSailPointExperimental $XSailPointExperimental -V2024MailFromAttributesDto $MailFromAttributesDto
# Send-V2024MailFromAttributes -XSailPointExperimental $XSailPointExperimental -V2024MailFromAttributesDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024MailFromAttributes"
Write-Host $_.ErrorDetails
}
```
[[Back to top]](#)
## send-test-notification
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
Send a Test Notification
[API Spec](https://developer.sailpoint.com/docs/api/v2024/send-test-notification)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
@@ -741,10 +831,10 @@ $SendTestNotificationRequestDto = @"{
try {
$Result = ConvertFrom-JsonToSendTestNotificationRequestDto -Json $SendTestNotificationRequestDto
Send-V2024TestNotification -V2024XSailPointExperimental $XSailPointExperimental -V2024SendTestNotificationRequestDto $Result
Send-V2024TestNotification -XSailPointExperimental $XSailPointExperimental -V2024SendTestNotificationRequestDto $Result
# Below is a request that includes all optional parameters
# Send-V2024TestNotification -V2024XSailPointExperimental $XSailPointExperimental -V2024SendTestNotificationRequestDto $SendTestNotificationRequestDto
# Send-V2024TestNotification -XSailPointExperimental $XSailPointExperimental -V2024SendTestNotificationRequestDto $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TestNotification"
Write-Host $_.ErrorDetails