List Notification Template Defaults

GET 
https://sailpoint.api.identitynow.com/v2024/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
Max number of results to return. See V3 API Standard Collection Parameters for more information.
Default value: 250
Example: 250
offset int32
Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.
Default value: 0
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
Use this header to enable this experimental API.
Default value: true
Example: true

Responses

200

A list of the default template objects

application/json

Schema

Schema

Array [
keystring
The key of the default template
Example: cloud_manual_work_item_summary
namestring
The name of the default template
Example: Task Manager Subscription
mediumstring
The message medium. More mediums may be added in the future.
Possible values: [EMAIL, PHONE, SMS, SLACK, TEAMS]
Example: EMAIL
localestring
The locale for the message text, a BCP 47 language tag.
Example: en
subjectstringnullable
The subject of the default template
Example: You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.
headerstringnullabledeprecated
The header value is now located within the body field. If included with non-null values, will result in a 400.
Example: null
bodystring
The body of the default template
Example: Please go to the task manager
footerstringnullabledeprecated
The footer value is now located within the body field. If included with non-null values, will result in a 400.
Example: null
fromstringnullable
The "From:" address of the default template
Example: $__global.emailFromAddress
replyTostringnullable
The "Reply To" field of the default template
Example: $__global.emailFromAddress
descriptionstringnullable
The description of the default template
Example: Daily digest - sent if number of outstanding tasks for task owner > 0
slackTemplate objectnullable
keystringnullable
textstring
blocksstringnullable
attachmentsstring
notificationTypestringnullable
approvalIdstringnullable
requestIdstringnullable
requestedByIdstringnullable
isSubscriptionbooleannullable
autoApprovalData objectnullable
isAutoApprovedstringnullable
itemIdstringnullable
itemTypestringnullable
autoApprovalMessageJSONstringnullable
autoApprovalTitlestringnullable
customFields objectnullable
requestTypestringnullable
containsDenystringnullable
campaignIdstringnullable
campaignStatusstringnullable
teamsTemplate objectnullable
keystringnullable
titlestringnullable
textstring
messageJSONstringnullable
isSubscriptionbooleannullable
approvalIdstringnullable
requestIdstringnullable
requestedByIdstringnullable
notificationTypestringnullable
autoApprovalData objectnullable
isAutoApprovedstringnullable
itemIdstringnullable
itemTypestringnullable
autoApprovalMessageJSONstringnullable
autoApprovalTitlestringnullable
customFields objectnullable
requestTypestringnullable
containsDenystringnullable
campaignIdstringnullable
campaignStatusstringnullable
]

Example (auto)

[
  {
    "key": "cloud_manual_work_item_summary",
    "name": "Task Manager Subscription",
    "medium": "EMAIL",
    "locale": "en",
    "subject": "You have $numberOfPendingTasks $taskTasks to complete in ${__global.productName}.",
    "body": "Please go to the task manager",
    "from": "$__global.emailFromAddress",
    "replyTo": "$__global.emailFromAddress",
    "description": "Daily digest - sent if number of outstanding tasks for task owner > 0",
    "slackTemplate": {
      "key": "string",
      "text": "string",
      "blocks": "string",
      "attachments": "string",
      "notificationType": "string",
      "approvalId": "string",
      "requestId": "string",
      "requestedById": "string",
      "isSubscription": true,
      "autoApprovalData": {
        "isAutoApproved": "string",
        "itemId": "string",
        "itemType": "string",
        "autoApprovalMessageJSON": "string",
        "autoApprovalTitle": "string"
      },
      "customFields": {
        "requestType": "string",
        "containsDeny": "string",
        "campaignId": "string",
        "campaignStatus": "string"
      }
    },
    "teamsTemplate": {
      "key": "string",
      "title": "string",
      "text": "string",
      "messageJSON": "string",
      "isSubscription": true,
      "approvalId": "string",
      "requestId": "string",
      "requestedById": "string",
      "notificationType": "string",
      "autoApprovalData": {
        "isAutoApproved": "string",
        "itemId": "string",
        "itemType": "string",
        "autoApprovalMessageJSON": "string",
        "autoApprovalTitle": "string"
      },
      "customFields": {
        "requestType": "string",
        "containsDeny": "string",
        "campaignId": "string",
        "campaignStatus": "string"
      }
    }
  }
]

400

Client Error - Returned if the request body is invalid.

application/json

Schema

Schema

detailCodestring
Fine-grained error code providing more detail of the error.
Example: 400.1 Bad Request Content
trackingIdstring
Unique tracking id for the error.
Example: e7eab60924f64aa284175b9fa3309599
messages object[]
Generic localized reason for error
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]

Example (auto)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

401

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

application/json

Schema

Schema

error
A message describing the error
Example: JWT validation failed: JWT is expired

Example (auto)

{
  "error": "JWT validation failed: JWT is expired"
}

403

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

application/json

Schema

Schema

detailCodestring
Fine-grained error code providing more detail of the error.
Example: 400.1 Bad Request Content
trackingIdstring
Unique tracking id for the error.
Example: e7eab60924f64aa284175b9fa3309599
messages object[]
Generic localized reason for error
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]

Example (auto)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

403

An example of a 403 response object

{
  "detailCode": "403 Forbidden",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server understood the request but refuses to authorize it."
    }
  ]
}

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.

application/json

Schema

Schema

message
A message describing the error
Example: Rate Limit Exceeded

Example (auto)

{
  "message": " Rate Limit Exceeded "
}

500

Internal Server Error - Returned if there is an unexpected error.

application/json

Schema

Schema

detailCodestring
Fine-grained error code providing more detail of the error.
Example: 400.1 Bad Request Content
trackingIdstring
Unique tracking id for the error.
Example: e7eab60924f64aa284175b9fa3309599
messages object[]
Generic localized reason for error
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]

Example (auto)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

500

An example of a 500 response object

{
  "detailCode": "500.0 Internal Fault",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "An internal fault occurred."
    }
  ]
}

Authorization: oauth2

type: Personal Access Token
scopes: idn:notification-template-defaults:read

• go
• powershell
  SailPoint SDK
• python
  SailPoint SDK
• csharp
• curl
• dart
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• r
• ruby
• rust
• shell
• swift

• NATIVE

Request Collapse all

Base URL

https://sailpoint.api.identitynow.com/v2024

Auth

Bearer Token

Parameters

X-SailPoint-Experimental — headerrequired

limit — query

offset — query

filters — query

ResponseClear

Click the Send API Request button above and see the response here!