Create invite for the realm.
POST /realms/{realm_id}/invites
POST
/realms/{realm_id}/invites
Authorizations
Section titled “Authorizations ”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-99c59f481d2eRequest Body
Section titled “Request Body ”The invite data.
object
email
string format: email
label
string
Examples
{ "email": "ms.boba@bobaboard.com"}Responses
Section titled “ Responses ”The invite metadata.
object
realm_id
required
string format: uuid
invite_url
required
string format: uri-reference
Examples
{ "realm_id": "76ef4cc3-1603-4278-95d7-99c59f481d2e", "invite_url": "https://twisted_minds.boba.social/invites/123invite_code456"}User was not found in request that requires authentication.
Generic response object
object
message
string
Examples
No authentication token given.
{ "message": "No authenticated user found."}Expired authentication token given.
{ "message": "Authentication token expired."}User does not have required permissions to complete this action.
Generic response object
object
message
string
The realm was not found.
Generic response object
object
message
string