Skip to content
DYCRYPT

Add a person

POST
/api/users
curl --request POST \
  --url https://app.dycrypt.com/o/acme/api/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "username": "example", "displayName": "example", "email": "hello@example.com", "password": "example", "role": "ORG_ADMIN", "active": true }'

Requires users:write, or an organisation administrator.

This is the most sensitive scope you can grant a token: it can create an ORG_ADMIN, and an administrator can do everything else. Refused with 403 if the plan’s seat limit is reached.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
username
string
/^[a-zA-Z0-9._-]{2,60}$/
displayName
string
email
string format: email
password
string format: password
>= 8 characters
role

What a person may do. A token is measured against its scopes instead, and never inherits the role of whoever created it.

string
Allowed values: ORG_ADMIN ISSUER VIEWER
active
boolean

Responses

Section titled “Responses”

200

Section titled “200”

The new member.

Media typeapplication/json

A member of your DYCRYPT organisation.

object
id
required
integer format: int64
username
required
string
displayName
string | null
email
string | null format: email
role
required

What a person may do. A token is measured against its scopes instead, and never inherits the role of whoever created it.

string
Allowed values: ORG_ADMIN ISSUER VIEWER
active
required
boolean
createdAt
string format: date-time
lastLoginAt
string | null format: date-time
Example
{
  "role": "ORG_ADMIN"
}

400

Section titled “400”

The request is wrong — a bad date, a missing field, a value the product does not declare.

Media typeapplication/json

Every failure in this API has this shape and no other.

object
error
required
string
Example
{
  "error": "this token does not have licenses:write"
}

401

Section titled “401”

No credential, or one that no longer resolves — revoked, expired, deleted. Replace it.

Media typeapplication/json

Every failure in this API has this shape and no other.

object
error
required
string
Example
{
  "error": "this token does not have licenses:write"
}

403

Section titled “403”

Authenticated, but not allowed: a missing scope, a read-only role, a plan limit reached, or a credential used under another organisation’s slug. The right credential doing something it may not do.

Media typeapplication/json

Every failure in this API has this shape and no other.

object
error
required
string
Example
{
  "error": "this token does not have licenses:write"
}