Skip to main content

List Notification Templates

GET 

/notification-templates

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.

Request

Query Parameters

    limit int32

    Possible values: <= 250

    Default value: 250

    Max number of results to return. See V3 API Standard Collection Parameters for more information.

    Example: 250
    offset int32

    Default value: 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.

    Example: 0
    filters string

    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

    Example: medium eq "EMAIL"

Header Parameters

    X-SailPoint-Experimental stringrequired

    Default value: true

    Use this header to enable this experimental API.

    Example: true

Responses

A list of template objects for your site

Schema

  • Array [

  • key stringrequired

    The key of the template

    name string

    The name of the Task Manager Subscription

    medium stringrequired

    Possible values: [EMAIL, PHONE, SMS, SLACK, TEAMS]

    The message medium. More mediums may be added in the future.

    locale stringrequired

    The locale for the message text, a BCP 47 language tag.

    subject string

    The subject line in the template

    header stringnullabledeprecated

    The header value is now located within the body field. If included with non-null values, will result in a 400.

    body string

    The body in the template

    footer stringnullabledeprecated

    The footer value is now located within the body field. If included with non-null values, will result in a 400.

    from string

    The "From:" address in the template

    replyTo string

    The "Reply To" line in the template

    description string

    The description in the template

    id string

    This is auto-generated.

    created date-time

    The time when this template is created. This is auto-generated.

    modified date-time

    The time when this template was last modified. This is auto-generated.

    slackTemplate stringnullable
    teamsTemplate stringnullable
  • ]

Loading...