Sluby
REST APIAuth

What an invite or reset link is for.

Public: the join and reset pages call it with the token from their url. 30 link requests per client address in 10 minutes.

GET
/api/v1/auth/invites/{token}

Public: the join and reset pages call it with the token from their url. 30 link requests per client address in 10 minutes.

Path Parameters

token*string

The token from the invite or reset link.

Response Body

The link works.

application/json
  1. response
kind*string
Value in"invite""reset"
role?string

Invites only: the role the new member gets.

Value in"admin""member"
email?|

Reset links only: the email the member signs in with, null when they have no password yet (then accepting needs email).

expires_at*string
Formatdate-time
github*boolean

GitHub sign-in is configured, so an invite can be accepted with it.

Example Request
curl -X GET 'https://sluby.example.com/api/v1/auth/invites/string'
Example Response
{  "kind": "invite",  "role": "admin",  "email": "string",  "expires_at": "2019-08-24T14:15:22Z",  "github": true}

Change the signed-in member's password. POST

Studio sessions only. Every other session of the account ends; this one stays. `revoked` is how many ended.

Use an invite or reset link, and sign in. POST

An invite makes a new member with its role. A reset link sets the member’s password (their first, when they had none) and ends every other session of the account. Either way the link is used up and the browser is signed in.