Authentication

Authentication

Options

Enable CORS by returning correct headers

SecurityNone
Responses
200

Enable CORS by returning correct headers

options/legacy/api/mobile/authentication/authenticate/forgot/password

Send forgot password mail

This endpoint is required for the migration phase of the customer portal and is only intended to be used for the Jifeline Customer Portal.

SecurityNone
Request
Request Body schema: application/json
required

Forgot password body containing e-mail address

email_address
required
string

email address used to reset password fore

Responses
200

Successfully sent forgot password email

400

Returned when a client sends a bad request

401

Returned when a request is performed without or with an incorrect OIDC token

403

Returned when a client requests a resource it's not authorized for.

500

Returned when an error occurs on the server

post/legacy/api/mobile/authentication/authenticate/forgot/password
Request samples
application/json
{
  • "email_address": "test@test.nl"
}
Response samples
application/json
{
  • "method": "SESSION"
}

Options

Enable CORS by returning correct headers

SecurityNone
Responses
200

Enable CORS by returning correct headers

options/v1/authenticate/pincode

Login using connector ID and connector pincodeDeprecated

Login using connector ID and connector pincode, response includes the ID token, access token and refresh token. This API endpoint is deprecated. Please use the connector UUID to log in.

SecurityNone
Request
Request Body schema: application/json
required

Login using connector ID and pincode

connector_id
string

ID of the connector to login for

pincode
string

Pincode of the connector

Responses
200

Successfully obtained authentication tokens

400

Returned when a client sends a bad request

401

Returned when a request is performed without or with an incorrect OIDC token

403

Returned when a client requests a resource it's not authorized for.

500

Returned when an error occurs on the server

post/v1/authenticate/pincode
Request samples
application/json
{
  • "connector_id": 940201044,
  • "pincode": 1234
}
Response samples
application/json
{
  • "id_token": "eyJraW2In0.eyJhdF9....",
  • "access_token": "eyJraW2In0.eyJhdF9....",
  • "refresh_token": "eyJraW2In0.eyJhdF9...."
}

Options

Enable CORS by returning correct headers

SecurityNone
Responses
200

Enable CORS by returning correct headers

options/v2/authenticate/pincode

Login using connector UUID and connector pincode

Login using connector UUID and connector pincode, response includes the ID token, Access token and Refresh token

SecurityNone
Request
Request Body schema: application/json
required

Login using connector UUID and pincode

connector_uuid
string

UUID of the connector to login for

pincode
string

Pincode of the connector

Responses
200

Successfully obtained authentication tokens

400

Returned when a client sends a bad request

401

Returned when a request is performed without or with an incorrect OIDC token

403

Returned when a client requests a resource it's not authorized for.

500

Returned when an error occurs on the server

post/v2/authenticate/pincode
Request samples
application/json
{
  • "connector_uuid": "6ec2911c-a09a-11ee-8c90-0242ac120002",
  • "pincode": 1234
}
Response samples
application/json
{
  • "id_token": "eyJraW2In0.eyJhdF9....",
  • "access_token": "eyJraW2In0.eyJhdF9....",
  • "refresh_token": "eyJraW2In0.eyJhdF9...."
}

Options

Enable CORS by returning correct headers

SecurityNone
Responses
200

Enable CORS by returning correct headers

options/v1/authenticate/otp-login

Login using an OTP

Login using an OTP, response includes the ID token, Access token and Refresh token

SecurityNone
Request
Request Body schema: application/json
required

Login using connector UUID and pincode

otp
string

OTP

Responses
200

Successfully obtained authentication tokens

400

Returned when a client sends a bad request

401

Returned when a request is performed without or with an incorrect OIDC token

403

Returned when a client requests a resource it's not authorized for.

500

Returned when an error occurs on the server

post/v1/authenticate/otp-login
Request samples
application/json
{
  • "otp": "bafd50b7-7388-4eb1-8812-cbb5517faa2c"
}
Response samples
application/json
{
  • "id_token": "eyJraW2In0.eyJhdF9....",
  • "access_token": "eyJraW2In0.eyJhdF9....",
  • "refresh_token": "eyJraW2In0.eyJhdF9...."
}