Skip to main content

List Notification Template Defaults

GET 

/notification-template-defaults

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.

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

Header Parameters

    X-SailPoint-Experimental stringrequired

    Default value: true

    Use this header to enable this experimental API.

    Example: true

Responses

A list of the default template objects

Schema

  • Array [

  • key string

    The key of the default template

    name string

    The name of the default template

    medium string

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

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

    locale string

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

    subject stringnullable

    The subject of the default 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 of the default 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 stringnullable

    The "From:" address of the default template

    replyTo stringnullable

    The "Reply To" field of the default template

    description stringnullable

    The description of the default template

    slackTemplate

    object

    nullable

    key stringnullable
    text string
    blocks stringnullable
    attachments string
    notificationType stringnullable
    approvalId stringnullable
    requestId stringnullable
    requestedById stringnullable
    isSubscription booleannullable

    autoApprovalData

    object

    nullable

    isAutoApproved stringnullable
    itemId stringnullable
    itemType stringnullable
    autoApprovalMessageJSON stringnullable
    autoApprovalTitle stringnullable

    customFields

    object

    nullable

    requestType stringnullable
    containsDeny stringnullable
    campaignId stringnullable
    campaignStatus stringnullable

    teamsTemplate

    object

    nullable

    key stringnullable
    title stringnullable
    text string
    messageJSON stringnullable
    isSubscription booleannullable
    approvalId stringnullable
    requestId stringnullable
    requestedById stringnullable
    notificationType stringnullable

    autoApprovalData

    object

    nullable

    isAutoApproved stringnullable
    itemId stringnullable
    itemType stringnullable
    autoApprovalMessageJSON stringnullable
    autoApprovalTitle stringnullable

    customFields

    object

    nullable

    requestType stringnullable
    containsDeny stringnullable
    campaignId stringnullable
    campaignStatus stringnullable
  • ]

Loading...