You have to call this method when the user ask for remembering his password. If the process it’s done successfully the user will receive a notification with a code and link to reset the current password and change it by a new one. The notification is sent by mail or sms (depending on the principal id defined with this app and entry point).

You can use method Reset password process to allow user to insert code in your application and allow to reset password.

Please, read first: to learn about Oauth2 protocol and the meaning of each token.

Endpoint URL:

 POST https://{}/activityid/v1/notification/request

Request parameters

Authorization“Bearer app_token” Literal text Bearer followed by app_token that is the token obtained from /oauth2/token endpointstringyes
Content-TypeThe type of content that will be used for requests to be JSONstringyes
AcceptThe type of content that will be used for responses to be JSONstringyes
FromName of the entry pointstringyes
Accept-LanguageLanguage for this requestLocaleno

Query string parameters

stateAn opaque value used by the app to maintain state between the request and callback.stringno

Request example

actor.idapp_id of the application you are using to log userstringyesapp id
actor.objectTypeType of the object which represents the actor.stringyes‘application’
verbVerb used for the loginstringyes‘request’
object.objectTypeObjectType represents the userstringyes‘user’
object.ids.emailStructure of email identifier. node name must be “email”structyesemail represents the id of the userstringyes‘user_id’ valuestringyesemail
context.notificationTypeNotification typestringyes‘reset_password’
source.idType of device doing the activitystringyes‘unknown’ | ‘pc’ | ‘mobile’ | ‘tablet’ | ‘game_console’ | ‘itv’
source.objectTypeType of sourcestringyes‘device’

Response examples

Reponse: notification sent

result.statushttp status codeinteger
content.displayNameIdentifier type where notification is sentstring
content.valueIdentifier value where notification is sentstring

Response: user account not confirmed

contentData receive with the responsestruct
content.urlRedirect url to notify the user how to confirm the accountstring
result.statusHTTP status codeint
result.errorsStruct for errorsarray
result.errors[].messageError messagestring

Response KO: user not found

result.statusHTTP status codeint
result.errorsStruct for errorsarray
result.errors[].messageError messagestring

Response codes

400ErrorBad Request: The request could not be understood by the server due to malformed syntax
401ErrorUnauthorized: authentication is required and has failed or has not yet been provided (token is invalid, etc)
404ErrorNot found: user is not found so notification could not be sent
412ErrorPrecondition failed: can not send notification to user because user is not confirmed
500ErrorInternal Server Error: The server encountered an unexpected condition which prevented it from fulfilling the request
502ErrorBad Gateway: notification service is nor working fine so notification can not be sent
200SuccessNotification sent to user successfully