API Changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
Authentication API Reference | Streambird logo

Topics

  • Introduction
  • Authentication

Endpoints

  • Users
    • Create User POST
    • Search Users (beta) POST
    • Get User GET
    • Update User PUT
    • Delete User DELETE
    • Delete User Email DELETE
    • Delete User Phone Number DELETE
    • Delete User Wallet DELETE
    • Delete User WebAuthn Credential DELETE
    • Delete User TOTP DELETE
  • Magic Links
    • Login or Create User by Magic Link POST
    • Invite User by Magic Link POST
    • Create Embeddable Magic Link POST
    • GetMagicLinkLoginStatus POST
    • Verify Token POST
  • OTPs
    • Login or Create User by SMS POST
    • Create SMS OTP POST
    • Login or Create User by Email OTP POST
    • Create Email OTP POST
    • Verify OTP (One-time passcode) POST
  • OAuth
    • Google GET
    • Apple GET
    • Microsoft GET
    • Discord GET
    • Github GET
    • Verify Token POST
  • Wallets Login
    • Begin Wallet Registration POST
    • Get Wallet Registration Nonce POST
    • Verify Wallet (beta) POST
    • Verify Siwe Wallet Registration POST
  • Managed Wallets
    • Create Wallet (beta) POST
    • Wallet Sign Transaction (beta) POST
    • Wallet Sign Message (beta) POST
    • Get Wallet Balance (beta) POST
    • Get Wallet (beta) GET
    • List Wallet (beta) GET
  • Sessions
    • GetJWKs GET
    • GetJWKsByApp GET
    • List Sessions GET
    • Verify Session POST
    • Delete Session DELETE
  • TOTP (Time-based one-time passcode)
    • Create TOTP (beta) POST
    • Verify TOTP (beta) POST
    • Get TOTP Recovery Codes (beta) POST
    • TOTP Recovery (beta) POST
  • Passwords
    • Update Password by Session (Enterprise) POST
    • Verify Password (Enterprise) POST
    • PasswordStrengthCheck (Enterprise) POST
  • Transfers
    • Create Transfer (beta) POST
    • Confirm Transfer (beta) POST
    • Get Transfer (beta) GET
    • List Transfer (beta) GET
  • WebAuthn
    • Initiate WebAuthn Registration (beta) POST
    • Create WebAuthn Registration (beta) POST
    • Initiate WebAuthn Authentication (beta) POST
    • Verify WebAuthn Authentication (beta) POST
Powered by Bump.sh
API Changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
Authentication API Reference | Streambird logo

Invite User by Magic Link

POST /v1/auth/magic_links/email/invite
Authorization

Create an email Magic Link to the provided email for invite verification. If no user account exists, a new user will be created and Magic Link sent.

HTTP Request

POST /v1/auth/magic_links/email/invite

Returns

A successful response returns an object with user_id and email_id properties.

application/json

Body

  • email string Required

    Required Email that uniquely identifies the user.

    Minimum length is 1.

  • first_name string

    First name of the user.

  • middle_name string

    Middle name of the user.

  • last_name string

    Last name of the user.

  • invite_redirect_url string

    The base url we will use to construct the final invite magic link and send to the user via email. If the redirect_url is https://streambird.io/authenticate, final url user sees in email will be https://streambird.io/authenticate?token=autogeneratedmagictoken. We will redirect to your app in this url and your app should handle and parse the token parameter and allow the user to accept invite. If no url is sent in, we will use the default redirect url set in the Console and if no default redirect url is available, an error will be returned.

  • invite_expires_in number

    Expiration time of the magic link in minutes for invite. Must be between 5 to 10080 minutes (7 days), defaults to 60 minutes.

  • device_fingerprint object

    Device fingerprinting metadata for fraud detection during verification step. This is useful to ensure that the user who originated the request matches the user that verifies the token. Verification requirements can be enabled in the Verify Token step by matching fields in the device_fingerprint such as IP, User Agent or the combination of them (more fraud detection features coming soon!)

    Hide device_fingerprint attributes Show device_fingerprint attributes object
    • ip string

      IP of the user originating the request.

    • user_agent string

      User Agent of the browser originating the request.

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • user_id string Required

      Minimum length is 1.

    • status string Required
    • user_created boolean Required
    • email_id string Required

      Minimum length is 1.

POST /v1/auth/magic_links/email/invite
curl \
 --request POST 'https://api.streambird.io/v1/auth/magic_links/email/invite' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"email":"sandbox@streambird.io","last_name":"Smith","first_name":"John","invite_expires_in":180}'
Request example
{
  "email": "sandbox@streambird.io",
  "last_name": "Smith",
  "first_name": "John",
  "invite_expires_in": 180
}
Response examples (200)
{
  "status": "pending",
  "user_id": "user_24wFP9pDa9YiMJLun94iKykoZs2",
  "email_id": "email_24oXBL3PufzHkH1Jzyjc2EXYeo7",
  "user_created": true
}