USusekaneo
Admin

Create a user

Changed on

Create an account with an instance role. No password is set or returned. When password sign-in is available, the user is emailed a single-use link, valid for 2 days, to choose their own password. When password registration or the login form is disabled, the account is created with a verified email so the user can sign in with single sign-on, and no email is sent. Registration restrictions do not apply to administrators. Requires the users:create instance permission; API keys are rejected.

post/admin/users

Request

  • Base URL
    https://cloud.kaneo.app/api
  • URL
    https://cloud.kaneo.app/api/admin/users
  • Auth
    HTTP bearer

Request body

namestring required
emailstring email required

The new user's email address. They sign in with it and receive their password link there.

rolestring

Instance role, as for updates. Defaults to the instance's default role for new users.

Response

The new user

passwordSetupEmail'sent' | 'failed' | 'not_configured' | 'not_needed' required

Whether the link to choose a password was emailed: not_configured without SMTP, not_needed when the account is for single sign-on. The link itself is never returned.

Changes

  • 0f9a0a057a49Revision changes
    • info

      the request property default value user was removed

  • 8f3ec578c70aRevision changes
    • breaking

      removed the enum value admin of the request property

    • breaking

      removed the enum value user of the request property

    • breaking

      the request property's minLength was increased from 0 to 1

    • warning

      the request property's maxLength was set to 64