LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-08 12:27:47 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ed1043e2b57e16fa61926ea035a46e315d8a1a4b
developer.sailpoint.com/docs/tools/sdk/python/Reference/V2024/Methods/NotificationsApi.md
darrell-thobe-sp ed1043e2b5 updating method docs for python sdk
2025-02-20 13:59:30 -05:00

57 KiB
Raw Blame History

id, title, pagination_label, sidebar_label, sidebar_class_name, keywords, slug, tags
id title pagination_label sidebar_label sidebar_class_name keywords slug tags
v2024-notifications Notifications Notifications Notifications pythonsdk
python
Python
sdk
Notifications
V2024Notifications
/tools/sdk/python/v2024/methods/notifications
SDK
Software Development Kit
Notifications
V2024Notifications

sailpoint.v2024.NotificationsApi

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

Method HTTP request Description
create-domain-dkim POST /verified-domains Verify domain address via DKIM
create-notification-template POST /notification-templates Create Notification Template
create-verified-from-address POST /verified-from-addresses Create Verified From Address
delete-notification-templates-in-bulk POST /notification-templates/bulk-delete Bulk Delete Notification Templates
delete-verified-from-address DELETE /verified-from-addresses/{id} Delete Verified From Address
get-dkim-attributes GET /verified-domains Get DKIM Attributes
get-mail-from-attributes GET /mail-from-attributes/{identity} Get MAIL FROM Attributes
get-notification-template GET /notification-templates/{id} Get Notification Template By Id
get-notifications-template-context GET /notification-template-context Get Notification Template Context
list-from-addresses GET /verified-from-addresses List From Addresses
list-notification-preferences GET /notification-preferences/{key} List Notification Preferences for tenant.
list-notification-template-defaults GET /notification-template-defaults List Notification Template Defaults
list-notification-templates GET /notification-templates List Notification Templates
put-mail-from-attributes PUT /mail-from-attributes Change MAIL FROM domain
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. ::: Verify domain address via DKIM Create a domain to be verified via DKIM (DomainKeys Identified Mail)

API Spec

Parameters

Param Type Name Data Type Required Description
x_sail_point_experimental str True (default to 'true') Use this header to enable this experimental API.
Body domain_address DomainAddress True

Return type

DomainStatusDto

Responses

Code Description Data Type Response headers
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. ListAccessProfiles401Response -
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. ListAccessProfiles429Response -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

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

Example

import sailpoint.v2024
from sailpoint.v2024.models.domain_address import DomainAddress
from sailpoint.v2024.models.domain_status_dto import DomainStatusDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
    domain_address = {
          "domain" : "sailpoint.com"
        } # DomainAddress | 

    try:
        # Verify domain address via DKIM
        Result = domain_address.from_json(domain_address)
        api_response = api_instance.create_domain_dkim(x_sail_point_experimental, Result)
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.create_domain_dkim(x_sail_point_experimental, Result)
        print("The response of NotificationsApi->create_domain_dkim:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NotificationsApi->create_domain_dkim: %s\n" % e)

[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. ::: 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.

API Spec

Parameters

Param Type Name Data Type Required Description
x_sail_point_experimental str True (default to 'true') Use this header to enable this experimental API.
Body template_dto TemplateDto True

Return type

TemplateDto

Responses

Code Description Data Type Response headers
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. ListAccessProfiles401Response -
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. ListAccessProfiles429Response -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

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

Example

import sailpoint.v2024
from sailpoint.v2024.models.template_dto import TemplateDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
    template_dto = {
          "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"
        } # TemplateDto | 

    try:
        # Create Notification Template
        Result = template_dto.from_json(template_dto)
        api_response = api_instance.create_notification_template(x_sail_point_experimental, Result)
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.create_notification_template(x_sail_point_experimental, Result)
        print("The response of NotificationsApi->create_notification_template:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NotificationsApi->create_notification_template: %s\n" % e)

[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 Verified From Address Create a new sender email address and initiate verification process.

API Spec

Parameters

Param Type Name Data Type Required Description
x_sail_point_experimental str True (default to 'true') Use this header to enable this experimental API.
Body email_status_dto EmailStatusDto True

Return type

EmailStatusDto

Responses

Code Description Data Type Response headers
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. ListAccessProfiles401Response -
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. ListAccessProfiles429Response -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

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

Example

import sailpoint.v2024
from sailpoint.v2024.models.email_status_dto import EmailStatusDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
    email_status_dto = {
          "isVerifiedByDomain" : false,
          "verificationStatus" : "PENDING",
          "id" : "id",
          "email" : "sender@example.com"
        } # EmailStatusDto | 

    try:
        # Create Verified From Address
        Result = email_status_dto.from_json(email_status_dto)
        api_response = api_instance.create_verified_from_address(x_sail_point_experimental, Result)
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.create_verified_from_address(x_sail_point_experimental, Result)
        print("The response of NotificationsApi->create_verified_from_address:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NotificationsApi->create_verified_from_address: %s\n" % e)

[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. ::: Bulk Delete Notification Templates 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

Parameters

Param Type Name Data Type Required Description
x_sail_point_experimental str True (default to 'true') Use this header to enable this experimental API.
Body template_bulk_delete_dto []TemplateBulkDeleteDto True

Return type

(empty response body)

Responses

Code Description Data Type Response headers
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. ListAccessProfiles401Response -
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. ListAccessProfiles429Response -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

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

Example

import sailpoint.v2024
from sailpoint.v2024.models.template_bulk_delete_dto import TemplateBulkDeleteDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
    [sailpoint.v2024.TemplateBulkDeleteDto()] # List[TemplateBulkDeleteDto] | 
     template_bulk_delete_dto = {
          "medium" : "EMAIL",
          "locale" : "en",
          "key" : "cloud_manual_work_item_summary"
        } # List[TemplateBulkDeleteDto] | 
    

    try:
        # Bulk Delete Notification Templates
        Result = template_bulk_delete_dto.from_json(template_bulk_delete_dto)
        api_instance.delete_notification_templates_in_bulk(x_sail_point_experimental, Result)
        
        # Below is a request that includes all optional parameters
        # api_instance.delete_notification_templates_in_bulk(x_sail_point_experimental, Result)
    except Exception as e:
        print("Exception when calling NotificationsApi->delete_notification_templates_in_bulk: %s\n" % e)

[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 Verified From Address Delete a verified sender email address

API Spec

Parameters

Param Type Name Data Type Required Description
Path id str True
x_sail_point_experimental str True (default to 'true') Use this header to enable this experimental API.

Return type

(empty response body)

Responses

Code Description Data Type Response headers
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. ListAccessProfiles401Response -
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. ListAccessProfiles429Response -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    id = 'id_example' # str |  # str | 
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')

    try:
        # Delete Verified From Address
        
        api_instance.delete_verified_from_address(id, x_sail_point_experimental)
        
        # Below is a request that includes all optional parameters
        # api_instance.delete_verified_from_address(id, x_sail_point_experimental)
    except Exception as e:
        print("Exception when calling NotificationsApi->delete_verified_from_address: %s\n" % e)

[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. ::: 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

Parameters

Param Type Name Data Type Required Description
x_sail_point_experimental str True (default to 'true') Use this header to enable this experimental API.

Return type

List[DkimAttributes]

Responses

Code Description Data Type Response headers
200 List of DKIM Attributes List[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. ListAccessProfiles401Response -
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. ListAccessProfiles429Response -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

import sailpoint.v2024
from sailpoint.v2024.models.dkim_attributes import DkimAttributes
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')

    try:
        # Get DKIM Attributes
        
        api_response = api_instance.get_dkim_attributes(x_sail_point_experimental)
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.get_dkim_attributes(x_sail_point_experimental)
        print("The response of NotificationsApi->get_dkim_attributes:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NotificationsApi->get_dkim_attributes: %s\n" % e)

[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. ::: Get MAIL FROM Attributes Retrieve MAIL FROM attributes for a given AWS SES identity.

API Spec

Parameters

Param Type Name Data Type Required Description
Query id str True Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status
x_sail_point_experimental str True (default to 'true') Use this header to enable this experimental API.

Return type

MailFromAttributes

Responses

Code Description Data Type Response headers
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. ListAccessProfiles401Response -
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. ListAccessProfiles429Response -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

import sailpoint.v2024
from sailpoint.v2024.models.mail_from_attributes import MailFromAttributes
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    id = 'bobsmith@sailpoint.com' # str | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status # str | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')

    try:
        # Get MAIL FROM Attributes
        
        api_response = api_instance.get_mail_from_attributes(id, x_sail_point_experimental)
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.get_mail_from_attributes(id, x_sail_point_experimental)
        print("The response of NotificationsApi->get_mail_from_attributes:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NotificationsApi->get_mail_from_attributes: %s\n" % e)

[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. ::: Get Notification Template By Id This gets a template that you have modified for your site by Id.

API Spec

Parameters

Param Type Name Data Type Required Description
Path id str True Id of the Notification Template
x_sail_point_experimental str True (default to 'true') Use this header to enable this experimental API.

Return type

List[TemplateDto]

Responses

Code Description Data Type Response headers
200 A template object for your site List[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. ListAccessProfiles401Response -
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. ListAccessProfiles429Response -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

import sailpoint.v2024
from sailpoint.v2024.models.template_dto import TemplateDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Notification Template # str | Id of the Notification Template
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')

    try:
        # Get Notification Template By Id
        
        api_response = api_instance.get_notification_template(id, x_sail_point_experimental)
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.get_notification_template(id, x_sail_point_experimental)
        print("The response of NotificationsApi->get_notification_template:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NotificationsApi->get_notification_template: %s\n" % e)

[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. ::: Get Notification 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

Parameters

Param Type Name Data Type Required Description
x_sail_point_experimental str True (default to 'true') Use this header to enable this experimental API.

Return type

NotificationTemplateContext

Responses

Code Description Data Type Response headers
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. ListAccessProfiles401Response -
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. ListAccessProfiles429Response -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

import sailpoint.v2024
from sailpoint.v2024.models.notification_template_context import NotificationTemplateContext
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')

    try:
        # Get Notification Template Context
        
        api_response = api_instance.get_notifications_template_context(x_sail_point_experimental)
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.get_notifications_template_context(x_sail_point_experimental)
        print("The response of NotificationsApi->get_notifications_template_context:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NotificationsApi->get_notifications_template_context: %s\n" % e)

[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. ::: List From Addresses Retrieve a list of sender email addresses and their verification statuses

API Spec

Parameters

Param Type Name Data Type Required Description
x_sail_point_experimental str True (default to 'true') Use this header to enable this experimental API.
Query limit int (optional) (default to 250) Max number of results to return. See V3 API Standard Collection Parameters for more information.
Query offset int (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 bool (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 str (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 str (optional) Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: email

Return type

List[EmailStatusDto]

Responses

Code Description Data Type Response headers
200 List of Email Status List[EmailStatusDto] -
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessProfiles401Response -
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. ListAccessProfiles429Response -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

import sailpoint.v2024
from sailpoint.v2024.models.email_status_dto import EmailStatusDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
    limit = 250 # int | 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) # int | 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 # int | 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) # int | 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 = False # bool | 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) # bool | 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\"' # str | 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) # str | 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' # str | 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) # str | 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)

    try:
        # List From Addresses
        
        api_response = api_instance.list_from_addresses(x_sail_point_experimental, )
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.list_from_addresses(x_sail_point_experimental, limit, offset, count, filters, sorters)
        print("The response of NotificationsApi->list_from_addresses:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NotificationsApi->list_from_addresses: %s\n" % e)

[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. ::: List Notification Preferences for tenant. Returns a list of notification preferences for tenant.

API Spec

Parameters

Param Type Name Data Type Required Description
x_sail_point_experimental str True (default to 'true') Use this header to enable this experimental API.

Return type

List[PreferencesDto]

Responses

Code Description Data Type Response headers
200 Return preference for the given notification key. List[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. ListAccessProfiles401Response -
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. ListAccessProfiles429Response -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

import sailpoint.v2024
from sailpoint.v2024.models.preferences_dto import PreferencesDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')

    try:
        # List Notification Preferences for tenant.
        
        api_response = api_instance.list_notification_preferences(x_sail_point_experimental)
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.list_notification_preferences(x_sail_point_experimental)
        print("The response of NotificationsApi->list_notification_preferences:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NotificationsApi->list_notification_preferences: %s\n" % e)

[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. ::: List Notification Template Defaults This lists the default templates used for notifications, such as emails from IdentityNow.

API Spec

Parameters

Param Type Name Data Type Required Description
x_sail_point_experimental str True (default to 'true') Use this header to enable this experimental API.
Query limit int (optional) (default to 250) Max number of results to return. See V3 API Standard Collection Parameters for more information.
Query offset int (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 str (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

List[TemplateDtoDefault]

Responses

Code Description Data Type Response headers
200 A list of the default template objects List[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. ListAccessProfiles401Response -
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. ListAccessProfiles429Response -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

import sailpoint.v2024
from sailpoint.v2024.models.template_dto_default import TemplateDtoDefault
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
    limit = 250 # int | 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) # int | 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 # int | 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) # int | 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\"' # str | 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) # str | 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)

    try:
        # List Notification Template Defaults
        
        api_response = api_instance.list_notification_template_defaults(x_sail_point_experimental, )
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.list_notification_template_defaults(x_sail_point_experimental, limit, offset, filters)
        print("The response of NotificationsApi->list_notification_template_defaults:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NotificationsApi->list_notification_template_defaults: %s\n" % e)

[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. ::: List Notification Templates This lists the templates that you have modified for your site.

API Spec

Parameters

Param Type Name Data Type Required Description
x_sail_point_experimental str True (default to 'true') Use this header to enable this experimental API.
Query limit int (optional) (default to 250) Max number of results to return. See V3 API Standard Collection Parameters for more information.
Query offset int (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 str (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

List[TemplateDto]

Responses

Code Description Data Type Response headers
200 A list of template objects for your site List[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. ListAccessProfiles401Response -
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. ListAccessProfiles429Response -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

import sailpoint.v2024
from sailpoint.v2024.models.template_dto import TemplateDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
    limit = 250 # int | 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) # int | 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 # int | 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) # int | 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\"' # str | 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) # str | 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)

    try:
        # List Notification Templates
        
        api_response = api_instance.list_notification_templates(x_sail_point_experimental, )
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.list_notification_templates(x_sail_point_experimental, limit, offset, filters)
        print("The response of NotificationsApi->list_notification_templates:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NotificationsApi->list_notification_templates: %s\n" % e)

[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 MAIL FROM domain 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

Parameters

Param Type Name Data Type Required Description
x_sail_point_experimental str True (default to 'true') Use this header to enable this experimental API.
Body mail_from_attributes_dto MailFromAttributesDto True

Return type

MailFromAttributes

Responses

Code Description Data Type Response headers
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. ListAccessProfiles401Response -
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. ListAccessProfiles429Response -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

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

Example

import sailpoint.v2024
from sailpoint.v2024.models.mail_from_attributes import MailFromAttributes
from sailpoint.v2024.models.mail_from_attributes_dto import MailFromAttributesDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
    mail_from_attributes_dto = {
          "identity" : "BobSmith@sailpoint.com",
          "mailFromDomain" : "example.sailpoint.com"
        } # MailFromAttributesDto | 

    try:
        # Change MAIL FROM domain
        Result = mail_from_attributes_dto.from_json(mail_from_attributes_dto)
        api_response = api_instance.put_mail_from_attributes(x_sail_point_experimental, Result)
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.put_mail_from_attributes(x_sail_point_experimental, Result)
        print("The response of NotificationsApi->put_mail_from_attributes:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling NotificationsApi->put_mail_from_attributes: %s\n" % e)

[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 Test Notification Send a Test Notification

API Spec

Parameters

Param Type Name Data Type Required Description
x_sail_point_experimental str True (default to 'true') Use this header to enable this experimental API.
Body send_test_notification_request_dto SendTestNotificationRequestDto True

Return type

(empty response body)

Responses

Code Description Data Type Response headers
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. ListAccessProfiles401Response -
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. ListAccessProfiles429Response -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

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

Example

import sailpoint.v2024
from sailpoint.v2024.models.send_test_notification_request_dto import SendTestNotificationRequestDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
    send_test_notification_request_dto = {
          "context" : "{}",
          "medium" : "EMAIL",
          "key" : "cloud_manual_work_item_summary"
        } # SendTestNotificationRequestDto | 

    try:
        # Send Test Notification
        Result = send_test_notification_request_dto.from_json(send_test_notification_request_dto)
        api_instance.send_test_notification(x_sail_point_experimental, Result)
        
        # Below is a request that includes all optional parameters
        # api_instance.send_test_notification(x_sail_point_experimental, Result)
    except Exception as e:
        print("Exception when calling NotificationsApi->send_test_notification: %s\n" % e)

[Back to top]