Skip to main content
POST
Create Tenant User

Authentication

❌ Organization User (CustomerEmployee)
❌ Delegated User (EndUser)
❌ Service Account

Required Permissions

Tenant:Users:Create: Always required.

Authorizations

Authorization
string
header
required

Bearer Token: Used to authenticate API requests. More details how to generate the token: Authentication flows

X-DFNS-USERACTION
string
header
required

User Action Signature: Used to sign the change-inducing API requests. More details how to generate the token: User Action Signing flows

Body

application/json
email
string<email>
required

The email address of the new user.

externalId
string

Value that can be used to correlate the entity with an external system.

isSSORequired
boolean
default:false

If set to true, the user will have to authenticate via SSO

Response

200 - application/json

Success

id
string
required

User id.

Required string length: 1 - 64
Pattern: ^us-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$
Example:

"us-6b58p-r53sr-rlrd3l5cj3uc4ome"

kind
enum<string>
required
Available options:
TenantUser
username
string
required
isRegistered
boolean
required
isActive
boolean
required
isSSORequired
boolean
required
permissions
object[]
required
orgs
object[]
required

orgs this user has access to

externalId
string