Description

You have to call this method when you want to provide with a reset password URL that you can send within your emails, allowing to confirm DRUID users aside from standard emails.
Please read https://dru-id.com/developers/apis/oauth-2/ to learn about Oauth2 protocol and the meaning of each token.

Some considerations to take into account:
• URL is unique per user, therefor you have to call this method for every single user.

As a result, you will get a URL that you can use within your emails. This way, when a user clicks it, he will be redirected to DRUID reset password page  and will also be redirected to your defined callback. This will give you full control of what you need (redirect user to another page or wherever you need).

Endpoint URL:

 POST https://{your-endpoint-domain.com}/activityid/v1/notification/give

Request headers

HeaderDescriptionTypeRequired
AuthorizationBearer {{app_token}}

Literal text Bearer followed by app_token that is the token obtained from /oauth2/token endpoint

stringyes
Content-Typeapplication/jsonstringyes
Acceptapplication/jsonstringyes
Fromentrypoint idstringyes
Accept-LanguageLanguage for this requestLocaleno

Query string parameters

ParameterDescriptionTypeRequiredDefault value

Request example

ParameterDescriptionTypeRequiredValue
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‘access’
object.objectTypeObjectType represents the userstringyes‘user’
object.passwordPassword of the user. it must be send plainstringyesuser password
object.ids.emailStructure of email identifier. node name must be “email”structyesemail
object.ids.email.objectTypeObjectType represents the id of the userstringyes‘user_id’
object.ids.email.valueEmail valuestringyesemail
source.idType of device doing the activitystringyes‘unknown’ | ‘pc’ | ‘mobile’ | ‘tablet’ | ‘game_console’ | ‘itv’
source.objectTypeType of sourcestringyes‘device’

Response examples

Response: url for reset password

ParameterDescriptionType
contentData receive with the responseurl
result.statushttp status codeinteger

Response: User does not exists

ParameterDescriptionType
result.statushttp status codeinteger
result.elapsedTime spent to receive the responseinteger
errorsResponse errorsstruct
errors.messageErrors messagestring
errors.detailsErrors detailstring
ParameterDescriptionType
result.statushttp status codeinteger
result.elapsedTime spent to receive the responseinteger
errorsResponse errorsstruct
errors.messageErrors messagestring
errors.detailsErrors detailstring

Response codes

CodeTypeDescription
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)
409ErrorThe request could not be completed due to a conflict with the current state of the target resource.
500ErrorInternal Server Error: The server encountered an unexpected condition which prevented it from fulfilling the request
504ErrorGateway TimeoutService can not contact with oauth server to do some internal operations
200Successrequest success