Create a New User

POST 
/user-svc/user

Allows an authenticated administrator to create a new user with specified details.

Request

application/json

Body

required

Create User Request

password string
roleIds string[]

user

object

contacts

object[]

Contacts are used for login and identification purposes.

Array [

createdAt string

deletedAt string

id string

The unique identifier, which can be a URL.

Example values: "joe12" (singulatron username), "twitter.com/thejoe" (twitter url), "joe@joesdomain.com" (email)

isPrimary boolean

If this is the primary contact method

platform string

Platform of the contact (e.g., "email", "phone", "twitter")

updatedAt string

userId string

value string

Value is the platform local unique identifier. Ie. while the id of a Twitter contact is twitter.com/thejoe, the value will be only thejoe. For email and phones the id and the value will be the same. This field mostly exists for display purposes.

Example values: "joe12" (singulatron username), "thejoe" (twitter username), "joe@joesdomain.com" (email)

verified boolean

Whether the contact is verified

]

createdAt string

deletedAt string

id string

name string

Full name of the organization.

passwordHash string

slug string

URL-friendly unique (inside the Singularon platform) identifier for the user.

updatedAt string

Responses

200

User created successfully

application/json

Schema

Schema

object

Example (from schema)

{}

400

Invalid JSON

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

401

Unauthorized

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

500

Internal Server Error

application/json

Schema

Schema

error string

Example (from schema)

{
  "error": "string"
}

Loading...