Send Magic Link

Authenticate user through email via link.

Resource Informations

Name	Value
Requires authentication?	Yes
Rate limited?	No

Request

Request headers

Key	Value
Authorization	Bearer token
Content-Type	application/json

HTTP request URL

POST http://{hostname}/auth/realms/{realm}/kobil-magic-link/access-link

note

Digitanium support for this API will be provided on request.

note

API requests must be made over https. Calls made over plain http will fail.

Parameters

No parameter fields are required.

Request body(*Required)

Parameter Name	Type	Description
email*	String	Send link to the user email.
clientId*	String	The client ID of the application.
redirectUri*	String	Specify the URI, where user needs to land after completing the process.
scope*	String	The scope requested for the token.
response Mode*	String	Select the type how the Authorization Server should return the result.
response Type*	String	Select the type of response that has to be received on execution.
forceCreate	Boolean	Create user with the email when user doesn't exist.
resetPassword	Boolean	If true reset password option is enabled while clicking the Magic link.

Request Response

{

  "email" : "abc@gmail.com",
  "clientId" : "test",
  "redirectUri" : "https://oidcdebugger.com/debug",
  "scope" : "open_id",
  "responseMode" : "form_post",
  "responseType" : "code token",
  "forceCreate" : true,
  "resetPassword" : true

}

Response

Field Name	Type	Description
message	String	Message explains result of the API call. Refer Response status Information for details.
status	String	The status of the API call. Refer Response status Information for details.
subSystem	Integer	subSystem categorizes the type of API that has been called. Refer Subsystem details for details.

Sample Response

{
  "message": "Mail was sent successfully to provided email id with magic link",
  "status": "Ok",
  "subSystem": 5
}

Response Status Information

Status Code	Status	Message
200	OK	Mail was sent successfully to provided email id with magic link
400	BAD REQUEST	Invalid response type or response mode
404	Not Found	User is not present, Please enable user