Update an ACS User

Updates the properties of a specified access system user.

Updates the properties of a specified access system user, using the associated user identity.

Code

await seam.acs.users.update({
  acs_user_id: "5db87499-0b3b-4750-a2e8-341b2af64049",
  user_identity_id: "b0bbb463-4fad-4b21-a695-952463ea6e93",
  acs_system_id: "88ae7b8b-c406-414b-a745-91d9cea661f7",
  access_schedule: {
    starts_at: "2025-06-10T15:00:00.000Z",
    ends_at: "2025-06-12T11:00:00.000Z",
  },
  full_name: "Jane Doe",
  email: "[email protected]",
  phone_number: "+15551234567",
  email_address: "[email protected]",
});

Output

// void
Authentication Methods
  • API key

  • Personal access token Must also include the seam-workspace header in the request.

To learn more, see Authentication.

Request Parameters

access_schedule Object

starts_at and ends_at timestamps for the 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.

ends_at Datetime

Ending timestamp for the access system user's access.


starts_at Datetime

Starting timestamp for the access system user's access.


acs_system_id String

ID of the access system that you want to update. You can only provide acs_system_id with user_identity_id.


acs_user_id String

ID of the access system user that you want to update. You can only provide acs_user_id or user_identity_id.


email String


email_address String

Email address of the access system user.


full_name String

Full name of the access system user.


hid_acs_system_id String


phone_number String

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


user_identity_id String

ID of the user identity that you want to update. You can only provide acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id.


Response

void


Examples

Update an access system user

Updates the properties of a specified access system user.

Code

await seam.acs.users.update({
  acs_user_id: "5db87499-0b3b-4750-a2e8-341b2af64049",
  access_schedule: {
    starts_at: "2025-06-10T15:00:00.000Z",
    ends_at: "2025-06-12T11:00:00.000Z",
  },
  full_name: "Jane Doe",
  email: "[email protected]",
  phone_number: "+15551234567",
  email_address: "[email protected]",
});

Output

// void

Last updated

Was this helpful?