Users

Creating a new User

Changed on

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

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/users
  • Auth
    none declared

Request body */*

emailstring required

The email address of the User account to be created.

passwordstring

If provided, the User account will be created with this password. Otherwise, the user will still be able set their own password later.

Example request

{
  "email": "my.email.address@getodk.org"
}

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