Admin

Create New User

Add User Endpoint

This endpoint allows administrators to add a new user to the system. The request requires a JSON payload containing user details.

Request Parameters

The request body should be in JSON format and include the following parameters:

  • firstName (string): The first name of the user.

  • lastName (string): The last name of the user.

  • email (string): The email address of the user.

  • isActive (boolean): Indicates whether the user account is active.

  • isVerified (boolean): Indicates whether the user's email has been verified.

  • permission (object): An object specifying the permissions granted to the user:

  • audio (boolean): Permission to access audio features.

  • video (boolean): Permission to access video features.

  • text (boolean): Permission to access text features.

  • addPayment (boolean): Permission to manage payment options.

  • userManagement (boolean): Permission to manage other users.

Expected Response

Upon a successful request, the server will respond with a confirmation of the user creation, typically including the user ID and any other relevant details about the newly created user.

Notes

  • Ensure that the email provided is unique and valid to avoid conflicts.

  • Permissions should be assigned based on the user's role within the organization.

  • This endpoint is restricted to users with administrative privileges.

post/admin/user

Request

  • Base URL: https://api.speakai.co/v1
  • URL: https://api.speakai.co/v1/admin/user
  • Auth: API key in header x-speakai-key and API key in header x-access-token

Request body

_idstring

Pass an existing user id. Leave it out when you are creating a new team member. Optional. Empty string is accepted. The create controller never reads it, so it has no effect on this endpoint.

emailstring required

Give the email address to invite. This is the only property the server always requires. Required. Must be a valid email address. Lowercased and trimmed. An empty string is rejected.

firstNamestring

Give the new member's first name. Optional. Trimmed. No minimum or maximum length.

lastNamestring

Give the new member's last name. Optional. Trimmed. No minimum or maximum length.

isActiveboolean

Accepted for compatibility. The create endpoint ignores it, and the new account is created through the invite flow. Optional. The declared default is true, but the middleware discards the converted value, and the create controller never reads this key.

isVerifiedboolean

Accepted for compatibility. The create endpoint ignores it. Optional. The declared default is false, and the same caveat about discarded conversions applies. The create controller never reads this key.

permissionobject

Set what the new member can do. Anything you leave out falls back to the defaults for their role. Optional object with a fixed key set, defined. Unknown keys are rejected. Accepted keys: role (string, one of owner, admin, member); folder object with create, delete, download, share, assign, accessAll; recorder object with create, edit, delete, download, accessAll; media object with delete, edit, download, share; payment object with manageCards, manageInvoices; teamManagement object with manageMembers, manageGroups; developer object with accessKeys; profileSettings object with accountPreferences, accountCustomization, dataManagement; meetingAssistant object with customizeAssistant, shareMeetings, routeMeetings, excludeMeetings, globalSettings. Every leaf key is a boolean. The controller reads permission.role, falls back to member, and merges what you send over the role defaults.

Response

Success

Changes

No recorded changes to this operation across all 2 revisions of this API.