Create Account User

Beta

POST/v1/identity/account-users

Idempotent with Idempotency-Key header. Learn more

Creates an account user and invites them to the account.

include[]optional arrayenumValues:roledepartment

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

namestringnullable

Display name.

emailstringnullable

Email address.

usernamestringnullable

Username.

passwordstringnullable

Password (only valid for scanner-role users backing a scanning station).

role_idoptional stringnullable

Role ID. Expandable.

department_idoptional stringnullable

Department ID. Expandable.

preferencesarray of object

Notification preferences to create for the new user (external targets only).

notification_type_codestringenumValues:invoiceorder_acknowledgementpurchase_order_submission

Notification type code. Must match a value of constants.AccountRelationNotificationType.

enabledboolean

Whether this notification type is enabled for the account user.

idstring

Account user ID.

objectstringenumValues:account_user

Resource type identifier.

namestringnullable

Display name.

emailstringnullable

Email address.

usernamestringnullable

Username.

image_urlstringnullable

Profile image URL.

statusstringenumValues:activedisabledremoved

Account user status.

roleobjectExpandablenullable

Assigned role.

idstring

Role ID.

objectstringenumValues:role

Resource type identifier.

namestring

Display name.

typestringenumValues:adminuserscanner

Role type code.

ownerobjectnullable

Owner of this resource.

Always returned as null in this endpoint.

permissionsarray of stringnullable

Permissions in {domain}:{action} format.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

departmentobjectExpandablenullable

Assigned department.

idstring

Department ID.

objectstringenumValues:department

Resource type identifier.

namestring

Display name.

notesstringnullable

Notes about the department.

locationobjectnullable

Associated location.

Always returned as null in this endpoint.

scanning_stationsobjectnullable

Scanning stations in this department.

Always returned as null in this endpoint.

machinesobjectnullable

Machines in this department.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last update timestamp.

last_used_atstring (date-time)nullable

When the user last used this account.

created_atstring (date-time)

When the account user was created.

updated_atstring (date-time)

When the account user was last updated.

Responses

201

Successful response for Create Account User

Create Account User

curl API_HOST/v1/identity/account-users \
  -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Augno-Version: 1.0.forge-preview.1" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "John Doe",
  "email": "jdoe@augno.com",
  "username": "jdoe",
  "password": "QgS7Z8Hhj3&1",
  "role_id": "rl_01gf7a8200er3ar3pkfrb6kk29",
  "preferences": [
    {
      "notification_type_code": "order_acknowledgement",
      "enabled": true
    }
  ]
}'

curl API_HOST/v1/identity/account-users \
  -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Augno-Version: 1.0.forge-preview.1" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "John Doe",
  "email": "jdoe@augno.com",
  "username": "jdoe",
  "password": "QgS7Z8Hhj3&1",
  "role_id": "rl_01gf7a8200er3ar3pkfrb6kk29",
  "preferences": [
    {
      "notification_type_code": "order_acknowledgement",
      "enabled": true
    }
  ]
}'

201 example

{
  "id": "acus_01gf7a8200er3ar3pkfrb6kk29",
  "object": "account_user",
  "name": "John Doe",
  "email": "john@augno.com",
  "username": null,
  "image_url": null,
  "status": "active",
  "role": {
    "id": "rl_01gf7a8200er3ar3pkfrb6kk29",
    "object": "role",
    "name": "Admin",
    "type": "admin",
    "owner": null,
    "permissions": [
      "customers:create",
      "customers:read",
      "customers:update",
      "customers:delete"
    ],
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "department": null,
  "last_used_at": null,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "acus_01gf7a8200er3ar3pkfrb6kk29",
  "object": "account_user",
  "name": "John Doe",
  "email": "john@augno.com",
  "username": null,
  "image_url": null,
  "status": "active",
  "role": {
    "id": "rl_01gf7a8200er3ar3pkfrb6kk29",
    "object": "role",
    "name": "Admin",
    "type": "admin",
    "owner": null,
    "permissions": [
      "customers:create",
      "customers:read",
      "customers:update",
      "customers:delete"
    ],
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "department": null,
  "last_used_at": null,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Create Account User

Query Parameters

Request Body

Returns

Responses