Accept invite for the realm.
POST /realms/{realm_id}/invites/{nonce}
POST
/realms/{realm_id}/invites/{nonce}
Authorizations
Section titled “Authorizations ”- firebase
- None
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” realm_id
required
string format: uuid
The id of the realm.
Examples
the twisted-minds realm id
76ef4cc3-1603-4278-95d7-99c59f481d2e nonce
required
string
The invite code.
Examples
the invite code.
123invite_code456Request Body
Section titled “Request Body ”The user data for the invite. Only required if the user does not already have an account.
object
email
required
string format: email
password
required
string
Examples
{ "email": "ms.boba@bobaboard.com", "password": "how_bad_can_i_be"}Responses
Section titled “ Responses ”The invite was successfully accepted.
object
realm_id
required
string format: uuid
realm_slug
required
string
Examples
{ "realm_id": "76ef4cc3-1603-4278-95d7-99c59f481d2e", "realm_slug": "twisted-minds"}Request does not contain email and password require to create new user account.
Generic response object
object
message
string
The invite is not valid anymore, or the user’s email does not correspond to the invited one.
Generic response object
object
message
string
The invite with the given code was not found, or the requested realm does not exist.
Generic response object
object
message
string
The user is already a member of the requested realm.
Generic response object
object
message
string