SMsmokeball
Invitations

Accept an invitation

Changed on

Server-to-server clients only. Creates the invited person's login under the invited email address, with a user id derived from the invitation, and registers it with the firm; omit password to have the identity provider email them a way to set one. Repeating the request, even after the invitation's expiry, answers the same reply and creates the login once.

post/invitations/{id}/accept

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/invitations/{id}/accept
  • Auth
    API key in header x-api-key and API key in header Authorization

Path parameters

idstring required

Unique identifier of the invitation to accept.

Request body

passwordstring nullable

Password with a lowercase, uppercase, numeric and special character; omit it to have the identity provider email the person a way to set one.

providerstring

Where the login is created: Default (when omitted) or Auth0.

mfaEnrollmentGraceDaysinteger nullable

Number of days after creation during which the user may sign in without setting up multi-factor authentication. Once the period ends, enrolment is required at the next sign-in. Between 1 and 90. Auth0 users only; ignored for other providers.

When omitted: enrolment is required at the first sign-in.

Example request

{
  "provider": "Auth0",
  "mfaEnrollmentGraceDays": 30
}

Response

When the request is accepted. Returns a hypermedia 'Link' object of the user.

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable

Changes

  • 77592e907e3dRevision changes
    • info

      added the new optional request property //// (media type: application/json-patch+json)

    • info

      added the new optional request property //// (media type: application/json)

    • info

      added the new optional request property //// (media type: application/*+json)

  • 2f6c7f5744a8Revision changes
    • info

      endpoint added