List Notification Template Defaults

GET 
/notification-template-defaults

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

Responses

200

A list of the default template objects

application/json

Schema

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

• ]

Example (from schema)

[
  {
    "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

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

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

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

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.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

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

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

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.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "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 (from schema)

{
  "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

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

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

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

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.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

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

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

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.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "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 (from schema)

{
  "message": " Rate Limit Exceeded "
}

500

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

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

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

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

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.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

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

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

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.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "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."
    }
  ]
}

Loading...