Magic Link
Magic links generator
Generates a magic link for a passwordless authentication. To create a magic link for a company admin, you need to provide the user_id parameter. To create a magic link for an employee, you need to provide the employment_id parameter.
Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage company resources (company_admin) | - | Create magic links (magic_link:write) |
post/v1/magic-link
Request
- Base URL: https://gateway.remote.com
- URL: https://gateway.remote.com/v1/magic-link
- Auth: OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, magic_link:write, company_admin, all:write)
Headers
Authorizationstring required
Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow.
The refresh token needs to have been obtained through the Authorization Code flow.
Request body
Example request
{
"user_id": "663e0b79-c893-45ff-a1b2-f6dcabc098b5"
}Response
Success
Example response
{
"data": {
"url": "https://example.com/magic-link"
}
}Changes
No recorded changes to this operation across all 1 revision of this API.