signIn.signIn

POST

/auth/sign-in

const url = 'https://example.com/auth/sign-in';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"email":"example","returnTo":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/auth/sign-in \
  --header 'Content-Type: application/json' \
  --data '{ "email": "example", "returnTo": "example" }'

Request Body^required

application/json

object

email

string

<= 320 characters

returnTo

string

<= 4096 characters

Example ^generated

{
  "email": "example",
  "returnTo": "example"
}

Responses

200

Success

application/json

object

url

required

string

Example ^generated

{
  "url": "example"
}

403

ForbiddenOrigin

application/json

object

_tag

required

string

Allowed values: ForbiddenOrigin

Example

{
  "_tag": "ForbiddenOrigin"
}

503

SignInUnavailable | AuthenticationUnavailable | SettingsUnavailable | RequestFailed

application/json

Any of:

object

_tag

required

string

Allowed values: SignInUnavailable

Example

{
  "_tag": "SignInUnavailable"
}

signIn.signIn

Request Bodyrequired

Example generated

Responses

200

Example generated

403

Example

503

Example

Request Body^required

Example ^generated

Example ^generated