Skip to content

Magic Link Endpoints

Magic Link Endpoints define profiles for Mideye Server’s passwordless single-factor web authentication (SFWA) service. Each profile configures an externally accessible endpoint that third-party applications can invoke to trigger SMS- or push-based authentication for end users.

Navigate to External Endpoints → Magic Link Endpoints to manage profiles. Requires the Administrator role or above.

The list view displays all configured Magic Link profiles.

ColumnDescription
NameProfile name. Default sort column (ascending).
Endpoint for external APIThe full URL for the SFWA endpoint. Includes a copy-to-clipboard button. For the default profile, the URL is /api/sfwa/auth. For named profiles, the URL is /api/sfwa/auth/{name}.
DefaultBoolean indicator — checked if this is the default endpoint.
ActionEdit and Delete buttons (administrator only). The default endpoint cannot be deleted.

The editor uses a tabbed form. The API Token Management tab is only available when editing an existing profile — it is hidden during creation.

FieldDescriptionDefault
NameUnique profile name. Validated asynchronously for uniqueness. Max 255 characters.
Enable plus activation linksWhen enabled, includes Mideye+ app activation links in authentication messages.Enabled
Use Mideye+ if activatedWhen enabled, prefers Mideye+ push authentication for users who have activated the mobile app.Enabled

Configures user repository sources for the assisted login workflow. An informational alert describes the prerequisites for enabling assisted login with Magic Links.

FieldDescriptionDefault
Assisted login profilesSelect an assisted login profile to enable the approver-based workflow. Optional.None
Use Mideye databaseWhen enabled, searches the local Mideye user database for authentication.Disabled
LDAP ProfilesSelect one or more LDAP profiles as user repositories.None
Azure Active DirectoriesSelect one or more Entra ID profiles as user repositories.None

Configures the text displayed to end users during authentication flows. Two message sets are available:

Controls the content shown during push-based (Mideye+) authentication.

FieldDescriptionMax Length
Title textHeading displayed on the authentication page.255
SMS textText included in the SMS notification.20
Button label for acceptLabel on the approve button.50
Button label for rejectLabel on the reject button.50
Information text in authentication pageBody text shown while waiting for the user’s response.1024
Information text in touch accepted pageMessage shown after the user approves.1024
Information text in touch rejected pageMessage shown after the user rejects.1024

Same seven fields as Touch Accept Messages, but applied to the assisted login flow where an approver validates the user.

Available only when editing an existing profile. Manages the API tokens that external applications use to authenticate against the SFWA endpoint.

ColumnDescription
API token nameName of the token.
Expires atExpiration date, or “N/A” for tokens with no expiry.
ActionDelete button.

The list uses server-side pagination.

Click Create new API token to open the creation dialog.

FieldDescriptionValidation
NameToken identifier.Required. 3–42 characters.
Expires atOptional expiration date. Tokens without an expiry date remain valid indefinitely.

After creation, the dialog displays the plain-text token value in {name}:{token} format with a copy button.

Click Import existing API token to import a pre-generated token.

FieldDescriptionValidation
NameToken identifier.Required. 3–42 characters.
Plain text tokenThe token value to import.Required. 16–42 characters.
Expires atOptional expiration date.

Third-party applications call the SFWA endpoint with an API key header to trigger authentication.

Request format:

GET /api/sfwa/auth[/{endpointName}]
Header: api-key: {tokenName}:{tokenValue}
Query: msisdn={phoneNumber}

Optional query parameters: sms-text, touch-accept-text, touch-reject-text, authentication-text, button-accept-text, button-reject-text, title-text, touch-timeout.

ActionRequired Role
View profilesAny authenticated user
Create, edit, or delete profilesAdministrator or above
Manage API tokensAdministrator or above