Sign in
Users

Creating a new User

All that is required to create a new user is an email address. That email address will receive a message instructing the new user on how to claim their new account and set a password.

Optionally, a password may also be supplied as a part of this request. If it is, the account is immediately usable with the given credentials. However, an email will still be dispatched with claim instructions as above.

Users are not able to do anything upon creation besides log in and change their own profile information. To allow Users to perform useful actions, you will need to assign them one or more Roles.

post/v1/users

Response

OK

createdAtstring required

ISO date format

displayNamestring required

All Actors, regardless of type, have a display name

idnumber required
type'user' | 'field_key' | 'public_link' | 'singleUse' required

the Type of this Actor; typically this will be user.

updatedAtstring

ISO date format

deletedAtstring

ISO date format

emailstring required

Only Users have email addresses associated with them

Changes

Changed in 3 of the 54 revisions of this API.4

  • 022694254f0d1See the full diff
    • ○

      api operation id Creating a new User removed and replaced with createNewUser

      api-operation-id-removed

  • b11b54eea4871See the full diff
    • ○

      removed the non-success response with the status 403

      response-non-success-status-removed

  • e8c2858fd4eb2See the full diff
    • ○

      api operation id createNewUser removed and replaced with Creating a new User

      api-operation-id-removed

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog