Managing Users

Learn how to manage your users and sync tenants and visitors from your property management platform.

This guide explains how to create and manage users in an access control system (ACS). Using the Access Control Systems API, you can automate issuing access to long-term tenants or visitors.

---

Before You Begin

To add users to your access system, first retrieve the ID (acs_system_id) of the access system that you want to configure. To retrieve the access system details, use Get a System or List Systems. Then, continue to the remaining sections in this topic to learn how to manage users.

Python

Request:

seam.acs.systems.list()

Response:

[
  AcsSystem(
    acs_system_id='11111111-1111-1111-1111-111111111111',
    name='Visionline System',
    ...
  ),
  ...
]

cURL (bash)

Request:

# Use GET or POST.
curl -X 'GET' \
  'https://connect.getseam.com/acs/systems/list' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer ${API_KEY}" \
  -H 'Content-Type: application/json'

Response:

{
  "acs_systems": [
    {
      "acs_system_id": "11111111-1111-1111-1111-111111111111",
      "name": "Visionline System",
      ...
    },
    ...
  ],
  "ok": true
}

JavaScript

Request:

await seam.acs.systems.list();

Response:

[
  {
    acs_system_id: '11111111-1111-1111-1111-111111111111',
    name: 'Visionline System',
    ...
  },
  ...
]

Ruby

Request:

# Coming soon!

Response:

# Coming soon!

PHP

Request:

$seam->acs->systems->list();

Response:

[
  {
    "acs_system_id": "11111111-1111-1111-1111-111111111111",
    "name": "Visionline System",
    ...
  },
  ...
]

C#

Request:

seam.SystemsAcs.List();

Response:

{
  "acs_system_id": "11111111-1111-1111-1111-111111111111",
  "name": "Visionline System",
  ...
}
...

Java

Request:

// Coming soon!

Response:

// Coming soon!

Go

Request:

acs_systems, uErr := client.Acs.Systems.List(
  context.Background(), &acs.SystemsListRequest{},
)

Response:

{
  "acs_systems": [
    {
      "acs_system_id": "11111111-1111-1111-1111-111111111111",
      "name": "Visionline System",
      ...
    },
    ...
  ],
  "ok": true
}

---

Create a User

To create a user, provide the ACS system ID (acs_system_id) of the system and the attributes of the user, such as the full name (full_name), email address (email_address), phone number (phone_number), and so on.

You can also assign a user to one or more access groups by including the access group IDs for the user as an array of strings in the acs_access_group_ids parameter. Further, you can use the user_identity_id parameter to associate a new user with a mobile access user identity, if desired. You can also specify an access_schedule for the user, including a starts_at and ends_at date and time.

Python

Request:

seam.acs.users.create(
  acs_system_id="11111111-1111-1111-1111-111111111111",
  user_identity_id="22222222-2222-2222-2222-222222222222",
  full_name="Jane Doe",
  email_address="[e-mail]",
  phone_number="[phone]"
)

Response:

AcsUser(
  acs_user_id='33333333-3333-3333-3333-333333333333',
  full_name='Jane Doe',
  email_address='[e-mail]',
  phone_number='[phone]',
  acs_system_id='11111111-1111-1111-1111-111111111111',
  ...
)

cURL (bash)

Request:

curl -X 'POST' \
  'https://connect.getseam.com/acs/users/create' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer ${API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "acs_system_id": "11111111-1111-1111-1111-111111111111",
  "user_identity_id": "22222222-2222-2222-2222-222222222222",
  "full_name": "Jane Doe",
  "email_address": "[e-mail]",
  "phone_number": "[phone]"
}'

Response:

{
  "acs_user": {
    "acs_user_id": "33333333-3333-3333-3333-333333333333",
    "full_name": "Jane Doe",
    "email_address": "[e-mail]",
    "phone_number": "[phone]",
    "acs_system_id": "11111111-1111-1111-1111-111111111111",
    ...
  },
  "ok": true
}

JavaScript

Request:

await seam.acs.users.create({
  acs_system_id: "11111111-1111-1111-1111-111111111111",
  user_identity_id: "22222222-2222-2222-2222-222222222222",
  full_name: "Jane Doe",
  email_address: "[e-mail]",
  phone_number: "[phone]"
});

Response:

{
  acs_user_id: '33333333-3333-3333-3333-333333333333',
  full_name: 'Jane Doe',
  email_address: '[e-mail]',
  phone_number: '[phone]',
  acs_system_id: '11111111-1111-1111-1111-111111111111',
  ...
}

Ruby

Request:

# Coming soon!

Response:

# Coming soon!

PHP

Request:

$seam->acs->users->create(
  acs_system_id: "11111111-1111-1111-1111-111111111111",
  user_identity_id: "22222222-2222-2222-2222-222222222222",
  full_name: "Jane Doe",
  email_address: "[e-mail]",
  phone_number: "[phone]"
);

Response:

{
  "acs_user_id": "33333333-3333-3333-3333-333333333333",
  "full_name": "Jane Doe",
  "email_address": "[e-mail]",
  "phone_number": "[phone]",
  "acs_system_id": "11111111-1111-1111-1111-111111111111",
  ...
}

C#

Request:

seam.UsersAcs.Create(
  acsSystemId: "11111111-1111-1111-1111-111111111111",
  userIdentityId: "22222222-2222-2222-2222-222222222222",
  fullName: "Jane Doe",
  emailAddress: "[e-mail]",
  phoneNumber: "[phone]"
);

Response:

{
  "acs_user_id": "33333333-3333-3333-3333-333333333333",
  "full_name": "Jane Doe",
  "email_address": "[e-mail]",
  "phone_number": "[phone]",
  "acs_system_id": "11111111-1111-1111-1111-111111111111",
  ...
}

Java

Request:

// Coming soon!

Response:

// Coming soon!

Go

Request:

acs_user, uErr := client.Acs.Users.Create(
  context.Background(), &acs.UsersCreateRequest{
    AcsSystemId: "11111111-1111-1111-1111-111111111111",
    UserIdentityId: api.String("22222222-2222-2222-2222-222222222222"),
    FullName: api.String("Jane Doe"),
    EmailAddress: api.String("[e-mail]"),
    PhoneNumber: api.String("[phone]")
  },
)

Response:

{
  "acs_user": {
    "acs_user_id": "33333333-3333-3333-3333-333333333333",
    "full_name": "Jane Doe",
    "email_address": "[e-mail]",
    "phone_number": "[phone]",
    "acs_system_id": "11111111-1111-1111-1111-111111111111",
    ...
  },
  "ok": true
}

---

Update a User

To update a user, provide the ID (acs_user_id) of the desired user, along with the attributes that you want to modify.

Python

Request:

seam.acs.users.update(
  acs_user_id="33333333-3333-3333-3333-333333333333",
  full_name="Jack Doe"
)

Response:

None

cURL (bash)

Request:

curl -X 'POST' \
  "https://connect.getseam.com/acs/users/update" \
  -H 'accept: application/json' \
  -H "Authorization: Bearer ${API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "acs_user_id": "33333333-3333-3333-3333-333333333333",
  "full_name": "Jack Doe"
}'

Response:

{
  "ok": true
}

JavaScript

Request:

await seam.acs.users.update({
  acs_user_id: "33333333-3333-3333-3333-333333333333",
  full_name: "Jack Doe"
});

Response:

void

Ruby

Request:

# Coming soon!

Response:

# Coming soon!

PHP

Request:

$seam->acs->users->update(
  acs_user_id: "33333333-3333-3333-3333-333333333333",
  full_name: "Jack Doe"
);

Response:

void

C#

Request:

seam.UsersAcs.Update(
  acsUserId: "33333333-3333-3333-3333-333333333333",
  fullName: "Jack Doe"
);

Response:

void

Java

Request:

// Coming soon!

Response:

// Coming soon!

Go

Request:

acs_user, uErr := client.Acs.Users.Update(
  context.Background(), &acs.UsersUpdateRequest{
    AcsUserId: "33333333-3333-3333-3333-333333333333",
    FullName: api.String("Jack Doe"),
  },
)

Response:

{
  "acs_user": {
    "acs_user_id": "33333333-3333-3333-3333-333333333333",
    "full_name": "Jack Doe",
    ...
  },
  "ok": true
}

---

Delete a User

To delete a user, provide the ID (acs_user_id) of the user that you want to delete.

Python

Request:

seam.acs.users.delete(
  acs_user_id="33333333-3333-3333-3333-333333333333"
)

Response:

None

cURL (bash)

Request:

curl -X 'POST' \
  'https://connect.getseam.com/acs/users/delete' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer ${API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "acs_user_id": "33333333-3333-3333-3333-333333333333"
}'

Response:

{
  "ok": true
}

JavaScript

Request:

await seam.acs.users.delete({
  acs_user_id: "33333333-3333-3333-3333-333333333333"
});

Response:

void

Ruby

Request:

# Coming soon!

Response:

# Coming soon!

PHP

Request:

$seam->acs->users->delete(
  acs_user_id: "33333333-3333-3333-3333-333333333333"
);

Response:

void

C#

Request:

seam.UsersAcs.Delete(
  acsUserId: "33333333-3333-3333-3333-333333333333"
);

Response:

void

Java

Request:

// Coming soon!

Response:

// Coming soon!

Go

Request:

deletion, uErr := client.Acs.Users.Delete(
  context.Background(), &acs.UsersDeleteRequest{
    AcsUserId: "33333333-3333-3333-3333-333333333333",
  },
)

Response:

{
  "ok": true
}

---

List Users

To list all users within an ACS, provide the ID (acs_system_id) of the ACS. You can also filter users by user_identity_id, user_identity_email_address, or user_identity_phone_number.

Python

Request:

seam.acs.users.list(
  acs_system_id="11111111-1111-1111-1111-111111111111"
)

Response:

[
  AcsUser(
    acs_user_id='33333333-3333-3333-3333-333333333333',
    full_name='Jane Doe',
    email_address='[e-mail]',
    ...
  ),
  ...
]

cURL (bash)

Request:

# Use GET or POST.
curl -X 'GET' \
  'https://connect.getseam.com/acs/users/list' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer ${API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "acs_system_id": "11111111-1111-1111-1111-111111111111"
}'

Response:

{
  "acs_users": [
    {
      "acs_user_id": "33333333-3333-3333-3333-333333333333",
      "full_name": "Jane Doe",
      "email_address": "[e-mail]",
      ...
    },
    ...
  ],
  "ok": true
}

JavaScript

Request:

await seam.acs.users.list({
  acs_system_id: "11111111-1111-1111-1111-111111111111"
});

Response:

[
  {
    acs_user_id: '33333333-3333-3333-3333-333333333333',
    full_name: 'Jane Doe',
    email_address: '[e-mail]',
    ...
  },
  ...
]

Ruby

Request:

# Coming soon!

Response:

# Coming soon!

PHP

Request:

$seam->acs->users->list(
  acs_system_id: "11111111-1111-1111-1111-111111111111"
);

Response:

[
  {
    "acs_user_id": "33333333-3333-3333-3333-333333333333",
    "full_name": "Jane Doe",
    "email_address": "[e-mail]",
    ...
  },
  ...
]

C#

Request:

seam.UsersAcs.List(
  acsSystemId: "11111111-1111-1111-1111-111111111111"
);

Response:

{
  "acs_user_id": "33333333-3333-3333-3333-333333333333",
  "full_name": "Jane Doe",
  "email_address": "[e-mail]",
  ...
}
...

Java

Request:

// Coming soon!

Response:

// Coming soon!

Go

Request:

acs_users, uErr := client.Acs.Users.List(
  context.Background(), &acs.UsersListRequest{
    AcsSystemId: api.String("11111111-1111-1111-1111-111111111111"),
  },
)

Response:

{
  "acs_users": [
    {
      "acs_user_id": "33333333-3333-3333-3333-333333333333",
      "full_name": "Jane Doe",
      "email_address": "[e-mail]",
      ...
    },
    ...
  ],
  "ok": true
}