LukeParke/developer.sailpoint.com

Fork 0

mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-07 04:19:34 +00:00

Files

developer-relations-sp 3e9d359da1 Update to powershell SDK docs: 13123805130

2025-02-03 22:09:17 +00:00

38 KiB

Raw Blame History

id, title, pagination_label, sidebar_label, sidebar_class_name, keywords, slug, tags

title

pagination_label

sidebar_label

sidebar_class_name

keywords

slug

Notifications

All URIs are relative to https://sailpoint.api.identitynow.com/beta

Method	HTTP request	Description
New-BetaDomainDkim	POST `/verified-domains`	Verify domain address via DKIM
New-BetaNotificationTemplate	POST `/notification-templates`	Create Notification Template
New-BetaVerifiedFromAddress	POST `/verified-from-addresses`	Create Verified From Address
Remove-BetaNotificationTemplatesInBulk	POST `/notification-templates/bulk-delete`	Bulk Delete Notification Templates
Remove-BetaVerifiedFromAddress	DELETE `/verified-from-addresses/{id}`	Delete Verified From Address
Get-BetaDkimAttributes	GET `/verified-domains`	Get DKIM Attributes
Get-BetaMailFromAttributes	GET `/mail-from-attributes/{identity}`	Get MAIL FROM Attributes
Get-BetaNotificationTemplate	GET `/notification-templates/{id}`	Get Notification Template By Id
Get-BetaNotificationsTemplateContext	GET `/notification-template-context`	Get Notification Template Context
Get-BetaFromAddresses	GET `/verified-from-addresses`	List From Addresses
Get-BetaNotificationPreferences	GET `/notification-preferences/{key}`	List Notification Preferences for tenant.
Get-BetaNotificationTemplateDefaults	GET `/notification-template-defaults`	List Notification Template Defaults
Get-BetaNotificationTemplates	GET `/notification-templates`	List Notification Templates
Send-BetaMailFromAttributes	PUT `/mail-from-attributes`	Change MAIL FROM domain
Send-BetaTestNotification	POST `/send-test-notification`	Send Test Notification

create-domain-dkim

Create a domain to be verified via DKIM (DomainKeys Identified Mail)

Parameters

Param Type	Name	Data Type	Required	Description
Body	DomainAddress	DomainAddress	True

Return type

DomainStatusDto

Responses

Code	Description	Data Type
200	List of DKIM tokens required for the verification process.	DomainStatusDto
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
405	Method Not Allowed - indicates that the server knows the request method, but the target resource doesn't support this method.	CreateDomainDkim405Response
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessModelMetadataAttribute429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: application/json
Accept: application/json

Example

$DomainAddress = @"{
  "domain" : "sailpoint.com"
}"@

# Verify domain address via DKIM

try {
    $Result = ConvertFrom-JsonToDomainAddress -Json $DomainAddress
    New-BetaDomainDkim -BetaDomainAddress $Result
    
    # Below is a request that includes all optional parameters
    # New-BetaDomainDkim -BetaDomainAddress $DomainAddress  
} 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 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.

Parameters

Param Type	Name	Data Type	Required	Description
Body	TemplateDto	TemplateDto	True

Return type

TemplateDto

Responses

Code	Description	Data Type
200	A template object for your site	TemplateDto
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
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessModelMetadataAttribute429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: application/json
Accept: application/json

Example

$TemplateDto = @"{
  "slackTemplate" : "slackTemplate",
  "footer" : "footer",
  "teamsTemplate" : "teamsTemplate",
  "subject" : "You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.",
  "created" : "2020-01-01T00:00:00Z",
  "description" : "Daily digest - sent if number of outstanding tasks for task owner > 0",
  "medium" : "EMAIL",
  "locale" : "en",
  "body" : "Please go to the task manager",
  "name" : "Task Manager Subscription",
  "replyTo" : "$__global.emailFromAddress",
  "header" : "header",
  "modified" : "2020-01-01T00:00:00Z",
  "from" : "$__global.emailFromAddress",
  "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
    
    # Below is a request that includes all optional parameters
    # New-BetaNotificationTemplate -BetaTemplateDto $TemplateDto  
} 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.

Parameters

Param Type	Name	Data Type	Required	Description
Body	EmailStatusDto	EmailStatusDto	True

Return type

EmailStatusDto

Responses

Code	Description	Data Type
201	New Verified Email Status	EmailStatusDto
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
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessModelMetadataAttribute429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: application/json
Accept: application/json

Example

$EmailStatusDto = @"{
  "isVerifiedByDomain" : false,
  "verificationStatus" : "PENDING",
  "id" : "id",
  "email" : "sender@example.com"
}"@

# Create Verified From Address

try {
    $Result = ConvertFrom-JsonToEmailStatusDto -Json $EmailStatusDto
    New-BetaVerifiedFromAddress -BetaEmailStatusDto $Result
    
    # Below is a request that includes all optional parameters
    # New-BetaVerifiedFromAddress -BetaEmailStatusDto $EmailStatusDto  
} 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.

Parameters

Param Type	Name	Data Type	Required	Description
Body	TemplateBulkDeleteDto	[]TemplateBulkDeleteDto	True

Return type

(empty response body)

Responses

Code	Description	Data Type
204	No content - indicates the request was successful but there is no content to be returned in the response.
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
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessModelMetadataAttribute429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: application/json
Accept: application/json

Example

 $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
    
    # Below is a request that includes all optional parameters
    # Remove-BetaNotificationTemplatesInBulk -BetaTemplateBulkDeleteDto $TemplateBulkDeleteDto  
} 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

Parameters

Param Type	Name	Data Type	Required	Description
Path	Id	String	True

Return type

(empty response body)

Responses

Code	Description	Data Type
204	No content - indicates the request was successful but there is no content to be returned in the response.
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
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessModelMetadataAttribute429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

$Id = "MyId" # String | 

# Delete Verified From Address

try {
    Remove-BetaVerifiedFromAddress -BetaId $Id 
    
    # Below is a request that includes all optional parameters
    # Remove-BetaVerifiedFromAddress -BetaId $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.

Parameters

Param Type	Name	Data Type	Required	Description

Return type

DkimAttributes[]

Responses

Code	Description	Data Type
200	List of DKIM Attributes	DkimAttributes[]
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
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessModelMetadataAttribute429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example


# Get DKIM Attributes

try {
    Get-BetaDkimAttributes
    
    # Below is a request that includes all optional parameters
    # Get-BetaDkimAttributes  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaDkimAttributes"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-mail-from-attributes

Retrieve MAIL FROM attributes for a given AWS SES identity.

Parameters

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

Responses

Code	Description	Data Type
200	MAIL FROM Attributes object	MailFromAttributes
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
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessModelMetadataAttribute429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

$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 
    
    # Below is a request that includes all optional parameters
    # Get-BetaMailFromAttributes -BetaId $Id  
} 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.

Parameters

Param Type	Name	Data Type	Required	Description
Path	Id	String	True	Id of the Notification Template

Return type

TemplateDto[]

Responses

Code	Description	Data Type
200	A template object for your site	TemplateDto[]
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
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessModelMetadataAttribute429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

$Id = "c17bea3a-574d-453c-9e04-4365fbf5af0b" # String | Id of the Notification Template

# Get Notification Template By Id

try {
    Get-BetaNotificationTemplate -BetaId $Id 
    
    # Below is a request that includes all optional parameters
    # Get-BetaNotificationTemplate -BetaId $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).

Parameters

Param Type	Name	Data Type	Required	Description

Return type

NotificationTemplateContext

Responses

Code	Description	Data Type
200	Notification template context attributes for a specific tenant.	NotificationTemplateContext
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
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessModelMetadataAttribute429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example


# Get Notification Template Context

try {
    Get-BetaNotificationsTemplateContext
    
    # Below is a request that includes all optional parameters
    # Get-BetaNotificationsTemplateContext  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaNotificationsTemplateContext"
    Write-Host $_.ErrorDetails
}

[Back to top]

list-from-addresses

Retrieve a list of sender email addresses and their verification statuses

Parameters

Param Type	Name	Data Type	Required	Description
Query	Limit	Int32	(optional) (default to 250)	Max number of results to return. See V3 API Standard Collection Parameters for more information.
Query	Offset	Int32	(optional) (default to 0)	Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.
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. 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 for more information.
Query	Filters	String	(optional)	Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: email: eq, ge, le, sw
Query	Sorters	String	(optional)	Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: email

Return type

EmailStatusDto[]

Responses

Code	Description	Data Type
200	List of Email Status	EmailStatusDto[]
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
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessModelMetadataAttribute429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

$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 = $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
    
    # Below is a request that includes all optional parameters
    # Get-BetaFromAddresses -BetaLimit $Limit -BetaOffset $Offset -BetaCount $Count -BetaFilters $Filters -BetaSorters $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.

Parameters

Param Type	Name	Data Type	Required	Description

Return type

PreferencesDto[]

Responses

Code	Description	Data Type
200	Return preference for the given notification key.	PreferencesDto[]
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
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessModelMetadataAttribute429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example


# List Notification Preferences for tenant.

try {
    Get-BetaNotificationPreferences
    
    # Below is a request that includes all optional parameters
    # Get-BetaNotificationPreferences  
} 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.

Parameters

Param Type	Name	Data Type	Required	Description
Query	Limit	Int32	(optional) (default to 250)	Max number of results to return. See V3 API Standard Collection Parameters for more information.
Query	Offset	Int32	(optional) (default to 0)	Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.
Query	Filters	String	(optional)	Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: key: eq, in, sw medium: eq, sw locale: eq, sw

Return type

TemplateDtoDefault[]

Responses

Code	Description	Data Type
200	A list of the default template objects	TemplateDtoDefault[]
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
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessModelMetadataAttribute429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

$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
    
    # Below is a request that includes all optional parameters
    # Get-BetaNotificationTemplateDefaults -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $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.

Parameters

Param Type	Name	Data Type	Required	Description
Query	Limit	Int32	(optional) (default to 250)	Max number of results to return. See V3 API Standard Collection Parameters for more information.
Query	Offset	Int32	(optional) (default to 0)	Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.
Query	Filters	String	(optional)	Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: key: eq, in, sw medium: eq, sw locale: eq, sw

Return type

TemplateDto[]

Responses

Code	Description	Data Type
200	A list of template objects for your site	TemplateDto[]
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
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessModelMetadataAttribute429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

$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
    
    # Below is a request that includes all optional parameters
    # Get-BetaNotificationTemplates -BetaLimit $Limit -BetaOffset $Offset -BetaFilters $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

Parameters

Param Type	Name	Data Type	Required	Description
Body	MailFromAttributesDto	MailFromAttributesDto	True

Return type

MailFromAttributes

Responses

Code	Description	Data Type
200	MAIL FROM Attributes required to verify the change	MailFromAttributes
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
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessModelMetadataAttribute429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: application/json
Accept: application/json

Example

$MailFromAttributesDto = @"{
  "identity" : "BobSmith@sailpoint.com",
  "mailFromDomain" : "example.sailpoint.com"
}"@

# Change MAIL FROM domain

try {
    $Result = ConvertFrom-JsonToMailFromAttributesDto -Json $MailFromAttributesDto
    Send-BetaMailFromAttributes -BetaMailFromAttributesDto $Result
    
    # Below is a request that includes all optional parameters
    # Send-BetaMailFromAttributes -BetaMailFromAttributesDto $MailFromAttributesDto  
} 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

Parameters

Param Type	Name	Data Type	Required	Description
Body	SendTestNotificationRequestDto	SendTestNotificationRequestDto	True

Return type

(empty response body)

Responses

Code	Description	Data Type
204	No content - indicates the request was successful but there is no content to be returned in the response.
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
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessModelMetadataAttribute429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: application/json
Accept: application/json

Example

$SendTestNotificationRequestDto = @"{
  "context" : "{}",
  "medium" : "EMAIL",
  "key" : "cloud_manual_work_item_summary"
}"@

# Send Test Notification

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

[Back to top]

38 KiB Raw Blame History

Notifications

create-domain-dkim

Parameters

Return type

Responses

HTTP request headers

Example

create-notification-template

Parameters

Return type

Responses

HTTP request headers

Example

create-verified-from-address

Parameters

Return type

Responses

HTTP request headers

Example

delete-notification-templates-in-bulk

Parameters

Return type

Responses

HTTP request headers

Example

delete-verified-from-address

Parameters

Return type

Responses

HTTP request headers

Example

get-dkim-attributes

Parameters

Return type

Responses

HTTP request headers

Example

get-mail-from-attributes

Parameters

Return type

Responses

HTTP request headers

Example

get-notification-template

Parameters

Return type

Responses

HTTP request headers

Example

get-notifications-template-context

Parameters

Return type

Responses

HTTP request headers

Example

list-from-addresses

Parameters

Return type

Responses

HTTP request headers

Example

list-notification-preferences

Parameters

Return type

Responses

HTTP request headers

Example

list-notification-template-defaults

Parameters

Return type

Responses

HTTP request headers

Example

list-notification-templates

Parameters

Return type

Responses

HTTP request headers

Example

38 KiB

Raw Blame History