Apps

Invite someone to an app

Lets this person sign in to the app with the given role, and emails them a sign-in link (unless send_email is false). The app needs auth (deploy_app with auth). With signup invite (the default) only invited people can sign in. Invitations with an email are limited per app to 20 per hour and 100 per day, and the same address once per 10 minutes (429 with Retry-After).

post/apps/{id}/users

Request

  • Base URL: https://api.hypamoon.com/api/v1
  • URL: https://api.hypamoon.com/api/v1/apps/{id}/users
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.hypamoon.com/oauth/authorize, token URL https://api.hypamoon.com/oauth/token, scopes: sites:write)

Path parameters

idstring uuid required

The id of the app.

Request body

emailstring email required

Their email address.

namestring

Their name, shown to the app.

rolestring

One of the app's roles. Defaults to default_role.

send_emailboolean

Send them a sign-in link now (default true).

Response

Invited.

idstring uuid required

The person's id: sub in x-hypamoon-user.

emailstring required
namestring nullable required
rolestring required
created_atstring required
last_sign_in_atstring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.