SMsmokeball
Users

Create a user

Changed on

Creates a user.

Provider decides where the user is created. When omitted, Default is used.

  • Default (the service's default identity provider for new users)
  • Auth0

InitialPassword decides how the user gets their first password. When omitted, a missing password means Invitation (the identity provider emails the user the way to set their own) and a supplied password is Permanent. Temporary must be changed at first sign-in. Nothing is emailed for Permanent or Temporary - the caller delivers the password.

To add an invited person, accept their invitation instead; creating the login here registers them without it.

post/users

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/users
  • Auth
    API key in header x-api-key and API key in header Authorization

Request body

providerstring

Where the user is created: Default or Auth0.

When omitted: Default.

emailstring required

Email address of the user.

passwordstring nullable

Password for the user.

Password must include atleast one lowercase character, uppercase character, numeric character as well as a special character.

expireAfterDaysinteger nullable

Expire after the specified days. Must be left blank for users that do not expire.

isInternalboolean

Creates the user as an internal user.

Internal users are excluded from billing and license counts.

Use this option for testing, background services, or other non-customer-facing purposes.

bypassMfaboolean

Bypasses multi-factor authentication for the user.

When enabled, the user will not be prompted for two factor authentication during login.

initialPasswordstring nullable

How the user gets their first password: Permanent (the supplied password is final), Temporary (the supplied password must be changed at first sign-in) or Invitation (the user is emailed the way to set their own; any supplied password is ignored).

Permanent and Temporary require a password; nothing is emailed for them, the caller delivers the password.

When omitted: Invitation if no password is supplied, otherwise Permanent.

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",
  "email": "user@domain.com",
  "expireAfterDays": 7,
  "isInternal": true,
  "bypassMfa": true,
  "initialPassword": "Temporary",
  "mfaEnrollmentGraceDays": 30
}

Response

When the user was created. Returns the created 'User' object.

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable
userIdstring nullable

Unique identifier of the user.

emailstring nullable

Email address of the user.

isInternalboolean

Returns true if the user is flagged as an internal user.

bypassMfaboolean

Returns true if multi-factor authentication is bypassed for the user.

Example response

{
  "userId": "23d2a4bc-8529-462e-8560-dfbf4fa24e49",
  "email": "user@domain.com",
  "isInternal": true,
  "bypassMfa": true
}

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)

  • b05b7b93cefaRevision changes
    • breaking

      removed the success response with the status

    • 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)

    • 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)

    • info

      added the success response with the status