Users

create a new user

post/Users

Request

Base URL
https://api.jambonz.cloud/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/jambonz/apis/jambonz-api/docs/Users/post.ts
A function with typed inputs. Its response is checked against the schema.

namestring required

username

emailstring required

user email address

is_activeboolean required

user account is active

force_changeboolean required

require the user to change password on next login

initial_passwordstring required

users password

account_sidstring uuid

account sid the account the user will have access to, if not set will create a Service Provider account

service_provider_sidstring uuid

The service provider sid, the account is under, if not set account will be admin level

is_view_onlyboolean required

if set to true the user will not be able to make changes

{
  "name": "my_user",
  "email": "user@example.com",
  "initial_password": "MySecurePassword"
}

user created

user_sidstring uuid

The sid of the newly created user

{
  "user_sid": "58b8ec3a-6fcc-4fd7-8f45-cff054c2ebe9"
}