Create an ACS User

await seam.acs.users.create({
  full_name: "Jane Doe",
  acs_system_id: "dc5c90b2-1aab-40a6-bcaa-4b8924b7ad46",
  acs_access_group_ids: ["bab9962b-708b-4db7-98d5-b242a28c12e9"],
  user_identity_id: "3ce809f3-b5ac-43a7-a086-70ffa9cb1dd6",
  access_schedule: {
    starts_at: "2025-06-10T15:00:00.000Z",
    ends_at: "2025-06-12T11:00:00.000Z",
  },
  email_address: "jane@example.com",
  phone_number: "+15551234567",
});

/*
{
  "access_schedule": {
    "ends_at": "2025-06-12T11:00:00.000Z",
    "starts_at": "2025-06-10T15:00:00.000Z"
  },
  "acs_system_id": "dc5c90b2-1aab-40a6-bcaa-4b8924b7ad46",
  "acs_user_id": "6a5d9697-3cc4-436a-8165-4375ff424870",
  "connected_account_id": "c0175797-30f0-49f7-a228-2df115443ca7",
  "created_at": "2025-06-15T16:54:17.946482Z",
  "display_name": "Jane Doe",
  "email_address": "jane@example.com",
  "errors": [],
  "external_type": "salto_site_user",
  "external_type_display_name": "Salto site user",
  "full_name": "Jane Doe",
  "hid_acs_system_id": "2acbe47f-612c-422a-9205-7af292f74e7f",
  "is_managed": true,
  "is_suspended": false,
  "last_successful_sync_at": "2025-06-18T17:45:00.582Z",
  "pending_mutations": [],
  "phone_number": "+15551234567",
  "user_identity_email_address": "jane@example.com",
  "user_identity_full_name": "Jane Doe",
  "user_identity_id": "3ce809f3-b5ac-43a7-a086-70ffa9cb1dd6",
  "user_identity_phone_number": "+15551234567",
  "warnings": [],
  "workspace_id": "8d4868e3-2f95-4f33-8689-19420b3101cd"
}
*/

{
  "acs_user": {
    "acs_system_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "acs_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "connected_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "display_name": "<string>",
    "errors": [
      {
        "error_code": "<string>",
        "message": "<string>",
        "created_at": "2023-11-07T05:31:56Z"
      }
    ],
    "is_managed": true,
    "warnings": [
      {
        "created_at": "2023-11-07T05:31:56Z",
        "message": "<string>",
        "warning_code": "being_deleted"
      }
    ],
    "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "access_schedule": {
      "ends_at": "2023-11-07T05:31:56Z",
      "starts_at": "2023-11-07T05:31:56Z"
    },
    "email": "jsmith@example.com",
    "email_address": "jsmith@example.com",
    "external_type_display_name": "<string>",
    "full_name": "<string>",
    "hid_acs_system_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "is_suspended": true,
    "pending_mutations": [
      {
        "created_at": "2023-11-07T05:31:56Z",
        "message": "<string>",
        "mutation_code": "creating"
      }
    ],
    "phone_number": "<string>",
    "salto_space_metadata": {
      "audit_openings": true,
      "user_id": "<string>"
    },
    "user_identity_email_address": "<string>",
    "user_identity_full_name": "<string>",
    "user_identity_id": "<string>",
    "user_identity_phone_number": "<string>"
  }
}

POST

acs

users

create

await seam.acs.users.create({
  full_name: "Jane Doe",
  acs_system_id: "dc5c90b2-1aab-40a6-bcaa-4b8924b7ad46",
  acs_access_group_ids: ["bab9962b-708b-4db7-98d5-b242a28c12e9"],
  user_identity_id: "3ce809f3-b5ac-43a7-a086-70ffa9cb1dd6",
  access_schedule: {
    starts_at: "2025-06-10T15:00:00.000Z",
    ends_at: "2025-06-12T11:00:00.000Z",
  },
  email_address: "jane@example.com",
  phone_number: "+15551234567",
});

/*
{
  "access_schedule": {
    "ends_at": "2025-06-12T11:00:00.000Z",
    "starts_at": "2025-06-10T15:00:00.000Z"
  },
  "acs_system_id": "dc5c90b2-1aab-40a6-bcaa-4b8924b7ad46",
  "acs_user_id": "6a5d9697-3cc4-436a-8165-4375ff424870",
  "connected_account_id": "c0175797-30f0-49f7-a228-2df115443ca7",
  "created_at": "2025-06-15T16:54:17.946482Z",
  "display_name": "Jane Doe",
  "email_address": "jane@example.com",
  "errors": [],
  "external_type": "salto_site_user",
  "external_type_display_name": "Salto site user",
  "full_name": "Jane Doe",
  "hid_acs_system_id": "2acbe47f-612c-422a-9205-7af292f74e7f",
  "is_managed": true,
  "is_suspended": false,
  "last_successful_sync_at": "2025-06-18T17:45:00.582Z",
  "pending_mutations": [],
  "phone_number": "+15551234567",
  "user_identity_email_address": "jane@example.com",
  "user_identity_full_name": "Jane Doe",
  "user_identity_id": "3ce809f3-b5ac-43a7-a086-70ffa9cb1dd6",
  "user_identity_phone_number": "+15551234567",
  "warnings": [],
  "workspace_id": "8d4868e3-2f95-4f33-8689-19420b3101cd"
}
*/

{
  "acs_user": {
    "acs_system_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "acs_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "connected_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "display_name": "<string>",
    "errors": [
      {
        "error_code": "<string>",
        "message": "<string>",
        "created_at": "2023-11-07T05:31:56Z"
      }
    ],
    "is_managed": true,
    "warnings": [
      {
        "created_at": "2023-11-07T05:31:56Z",
        "message": "<string>",
        "warning_code": "being_deleted"
      }
    ],
    "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "access_schedule": {
      "ends_at": "2023-11-07T05:31:56Z",
      "starts_at": "2023-11-07T05:31:56Z"
    },
    "email": "jsmith@example.com",
    "email_address": "jsmith@example.com",
    "external_type_display_name": "<string>",
    "full_name": "<string>",
    "hid_acs_system_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "is_suspended": true,
    "pending_mutations": [
      {
        "created_at": "2023-11-07T05:31:56Z",
        "message": "<string>",
        "mutation_code": "creating"
      }
    ],
    "phone_number": "<string>",
    "salto_space_metadata": {
      "audit_openings": true,
      "user_id": "<string>"
    },
    "user_identity_email_address": "<string>",
    "user_identity_full_name": "<string>",
    "user_identity_id": "<string>",
    "user_identity_phone_number": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

acs_system_id

string<uuid>

required

ID of the access system to which you want to add the new access system user.

full_name

string

required

Full name of the new access system user.

access_schedule

object

starts_at and ends_at timestamps for the new access system user's access. If you specify an access_schedule, you may include both starts_at and ends_at. If you omit starts_at, it defaults to the current time. ends_at is optional and must be a time in the future and after starts_at.

Show child attributes

acs_access_group_ids

string<uuid>[]

Array of access group IDs to indicate the access groups to which you want to add the new access system user.

string<email>

deprecated

Deprecated. use email_address.

email_address

string<email>

Email address of the access system user.

phone_number

string

Phone number of the access system user in E.164 format (for example, +15555550100).

user_identity_id

string<uuid>

ID of the user identity with which you want to associate the new access system user.

Response

acs_user

object

required

Represents a user in an access system. See the acs_user object.

Show child attributes

Add to access group Delete

Getting Started

Granting Access

Devices and Systems

Setup

Monitoring

Low-Level APIs

Create an ACS User

Authorizations

Body

Response