REremote-com
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.

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained by a company manager through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Company-scoped access token (assertion) (OAuth2CompanyManagerAssertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant for a company manager. See OAuth Assertion.

Scopes

Any one of the scopes in a token type's row is enough. all:write works too.

Token typeCategoryRead only ScopeWrite only Scope (read access implicit)
Company-scoped access tokenManage company resources (company_admin)-Create magic links (magic_link:write)
Company-scoped access token (assertion)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: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: https://gateway.remote.com/company.manage
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: magic_link:write
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: all:write
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: magic_link:write
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: all:write

Headers

Authorizationstring required

An access token of one of the types listed in this endpoint's Authentication section, as Bearer <ACCESS TOKEN>.

A token from the Refresh Token flow is of the same type as the token issued with that refresh token.

Request body

OR

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.