Users

API endpoints to create, list, activate, deactivate, and manage end users and employee users within your DFNS organization, including roles.

Users represent people with access to the DFNS platform. These can be either Employees of your company or end users of your service who do not work for you (either consumers or corporate clients). Alternatively, you can create Service Accounts, which serve as API keys for programmatic access to the system.

When you call Create User providing an email address, an email will be sent from DFNS to the user to onboard them to the DFNS dashboard. Note in most cases, you will only do this for Employees and can accomplish this from the Settings section of our dashboard without using the API directly.

If you are implementing Delegated Signing in which your user has full control over a DFNS wallet, we recommend authenticating the user yourself, and then calling delegated registration via a service account to register on behalf of the end user. This way, DFNS remains fully white labeled so your users will not know our platform exists.

User object

username · string · required

Username/identifier of the user (any unique string accepted, e.g. your internal user ID or email).

name · string · required

Display name of the user.

userId · 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

User kind.

Available options: CustomerEmployee, EndUser

credentialUuid · string · required

UUID of the user's primary credential.

isActive · boolean · required

Whether the user is active.

isServiceAccount · boolean · required

Whether the user is a service account.

isRegistered · boolean · required

Whether the user has completed registration.

isSSORequired · boolean · required

Whether the user must authenticate via SSO.

permissionAssignments · object[] · required

Permissions (roles) assigned to the user.

Show child attributes

orgId · string

Organization id.

Required string length: 1 - 64

Pattern: ^or-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$

Example:

"or-30tnh-itmjs-s235s5ontr3r23h2"

accountId · string

Account id.

Required string length: 1 - 64

Pattern: ^acct-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$

Example:

"acct-24hka-dhili-9hgvdlvr1ohpibp4"

permissions · string[]

@deprecated - Flat list of API operations the user has access to.