Skip to main content
POST
/
v1
/
auth
/
magic_links
/
email
/
invite
Invite User by Magic Link
curl --request POST \
  --url https://api.streambird.io/v1/auth/magic_links/email/invite \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "first_name": "John",
  "last_name": "Smith",
  "email": "sandbox@streambird.io",
  "invite_expires_in": 180
}'
{
  "user_id": "user_24wFP9pDa9YiMJLun94iKykoZs2",
  "status": "pending",
  "user_created": true,
  "email_id": "email_24oXBL3PufzHkH1Jzyjc2EXYeo7"
}

Authorizations

​
Authorization
string
header
required

Auth Platform API includes all the Auth related features. All Users, Phone Numbers, Emails, and OTPs are associated with an App as the container.

Endpoints only accept App's Secret API keys other than certain endpoints that are used client side or via SDK that accept the public_token.

Authentication using App Api Key

Header:

Authorization: Bearer {api_key}

Authenticated Request

curl \
  -X GET https://api.streambird.io/v1/auth/users/user_24wFP9pDa9YiMJLun94iKykoZs2 \
  -H "Authorization: Bearer sk_test_pRqweh3wvWmJAAVYv7Z0T5iPLzFM4ql0muoyQcjOxGeN3p1r"

Body

application/json
​
email
string
required

Required Email that uniquely identifies the user.

Minimum length: 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!)

Response

200 - application/json

OK

​
user_id
string
required
Minimum length: 1
​
status
string
required
​
user_created
boolean
required
​
email_id
string
required
Minimum length: 1