Find all notification templates
get
/iam/governance/selfservice/api/v1/notification/search/basic
Retrieves all notification templates by providing the template name or event name as URL parameters. Sorting and pagination are supported.
Request
Query Parameters
-
eventName(optional): string
Event name that needs to be searched.
-
limit(optional): integer(int32)
Number of Notification Templates to be returned from startindex.
-
offset(optional): integer(int32)
Pagination start index from which results need to be returned.
-
orderBy(optional): string
Attribute on which sorting needs to be done followed by colon and sort order.
-
templateName(optional): string
Template name that needs to be searched.
Response
Supported Media Types
- application/json
200 Response
successful operation.
Nested Schema : SearchResult
Type:
Show Source
object-
createuser(optional):
string
Create user for notification template.
-
customId(optional):
string
Custom id for notification template.
-
eventName(optional):
string
Event name for notification template.
-
id(optional):
number
Id of notification template.
-
locale(optional):
string
Locale of notification template.
-
status(optional):
string
Status of notification template.
-
subject(optional):
string
Subject of notification template.
-
templateName(optional):
string
Name of notification template.
400 Response
Invalid input.
Examples
This example retrieves all the entity that match the search criteria. The information shown here is against a pseudo system and serves as a prototype.
cURL Example
curl -i -X GET -u username:password \ --header 'Content-Type: application/json' \ 'http://pseudo.com:14000/iam/governance/selfservice/api/v1/notification/search/basic
Example of Response Body
The following example shows the contents of the response body in JSON format.
{
"links":[
{
"rel":"self",
"href":"http://pseudo.com/iam/governance/selfservice/api/v1/notification/search/basic?offset=1&limit=10"
},
{
"rel":"first",
"href":"http://pseudo.com/iam/governance/selfservice/api/v1/notification/search/basic?offset=1&limit=10"
},
{
"rel":"next",
"href":"http://pseudo.com/iam/governance/selfservice/api/v1/notification/search/basic?offset=11&limit=10"
}
],
"count":10,
"hasMore":true,
"totalResult":19,
"offset":1,
"limit":10,
"searchResultTOS":[
{
"templatename":"Add Proxy Notification",
"id":12,
"eventname":"Add Proxy",
"subject":"?????? - ???????????????????????????????????????????????????",
"locale":"ja_JP",
"status":"Disabled",
"createuser":"-1",
"customId":"Add Proxy Notificationja_JP?????? - ???????????????????????????????????????????????????"
},
{
"templatename":"Bulk Request Creation",
"id":6,
"eventname":"Bulk Request Creation",
"subject":"???????????????????????????????????????",
"locale":"th_TH",
"status":"Enabled",
"createuser":"-1",
"customId":"Bulk Request Creationth_TH???????????????????????????????????????"
},
{
"templatename":"Create User Self Service Notification",
"id":7,
"eventname":"Self-Register User",
"subject":"Congratulations - New Account has been created",
"locale":"en_US",
"status":"Enabled",
"createuser":"-1",
"customId":"Create User Self Service Notificationen_USCongratulations - New Account has been created"
},
{
"templatename":"End Date",
"id":11,
"eventname":"User Deleted Notification",
"subject":"The end date of user $Display_Name expired.",
"locale":"en_US",
"status":"Enabled",
"createuser":"-1",
"customId":"End Dateen_USThe end date of user $Display_Name expired."
},
{
"templatename":"Failed Account Creation",
"id":15,
"eventname":"Failed Account Creation",
"subject":"Poskytovanie konta SSO zlyhalo",
"locale":"sk_SK",
"status":"Enabled",
"createuser":"-1",
"customId":"Failed Account Creationsk_SKPoskytovanie konta SSO zlyhalo"
},
{
"templatename":"Failed Account Self Creation",
"id":16,
"eventname":"Failed Account Self Creation",
"subject":"Provisioning dell'account SSO non riuscito",
"locale":"it_IT",
"status":"Enabled",
"createuser":"-1",
"customId":"Failed Account Self Creationit_ITProvisioning dell'account SSO non riuscito"
},
{
"templatename":"Failed Job Notification",
"id":14,
"eventname":"Failed Job",
"subject":"Job er fejlet",
"locale":"da_DK",
"status":"Enabled",
"createuser":"-1",
"customId":"Failed Job Notificationda_DKJob er fejlet"
},
{
"templatename":"Forgot Password with URL Notification",
"id":17,
"eventname":"ForgotPasswordWithURL",
"subject":"Glemt passordet",
"locale":"no_NO",
"status":"Enabled",
"createuser":"-1",
"customId":"Forgot Password with URL Notificationno_NOGlemt passordet"
},
{
"templatename":"Forgotten Username Notification",
"id":13,
"eventname":"Forgotten Username",
"subject":"???????????? ???????? ????????????????",
"locale":"ar_AE",
"status":"Enabled",
"createuser":"-1",
"customId":"Forgotten Username Notificationar_AE???????????? ???????? ????????????????"
},
{
"templatename":"Generated Password Notification",
"id":8,
"eventname":"Generated Password ",
"subject":"New Account Information",
"locale":"en_US",
"status":"Enabled",
"createuser":"-1",
"customId":"Generated Password Notificationen_USNew Account Information"
}
]
}