List ACS Users
Returns a list of all access system users.
Returns a list of all access system users for a specified user identity.
Code:
await seam.acs.users.list({
user_identity_id: "0dcb435f-0aef-4ae6-8d6e-9c605b78c94e",
});
Output:
[
{
"access_schedule": {
"ends_at": "2025-06-12T11:00:00.000Z",
"starts_at": "2025-06-10T15:00:00.000Z"
},
"acs_system_id": "62d3384f-267f-4a4a-a946-d35819ec9981",
"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": "[email protected]",
"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": "+1555551000",
"user_identity_email_address": "[email protected]",
"user_identity_full_name": "Jane Doe",
"user_identity_id": "0dcb435f-0aef-4ae6-8d6e-9c605b78c94e",
"user_identity_phone_number": "+1555551000",
"warnings": [],
"workspace_id": "8d4868e3-2f95-4f33-8689-19420b3101cd"
}
]
Request Parameters
acs_system_id
String
ID of the acs_system
for which you want to retrieve all access system users.
created_before
String
Timestamp by which to limit returned access system users. Returns users created before this timestamp.
limit
Number
Maximum number of records to return per page.
page_cursor
String
Identifies the specific page of results to return, obtained from the previous page's next_page_cursor
.
search
String
String for which to search. Filters returned access system users to include all records that satisfy a partial match using full_name
, phone_number
, email_address
, acs_user_id
, user_identity_id
, user_identity_full_name
or user_identity_phone_number
.
user_identity_email_address
String
Email address of the user identity for which you want to retrieve all access system users.
user_identity_id
String
ID of the user identity for which you want to retrieve all access system users.
user_identity_phone_number
String
Phone number of the user identity for which you want to retrieve all access system users, in E.164 format (for example, +15555550100
).
Response
Array of acs_users
{
"access_schedule": {
"ends_at": "2025-06-12T11:00:00.000Z",
"starts_at": "2025-06-10T15:00:00.000Z"
},
"acs_system_id": "62d3384f-267f-4a4a-a946-d35819ec9981",
"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": "[email protected]",
"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": [
{
"to": { "acs_access_group_id": "2c0fb4a0-2b42-4651-926e-1a10bedbf6ce" },
"from": { "acs_access_group_id": "f1e2d3c4-b5a6-4d7c-8e9f-0a1b2c3d4e5f" },
"message": "This user's access membership is being updated.",
"created_at": "2025-06-18T17:57:01.867Z",
"mutation_code": "updating_group_membership"
}
],
"phone_number": "+1555551000",
"user_identity_email_address": "[email protected]",
"user_identity_full_name": "Jane Doe",
"user_identity_id": "a23b3e02-e394-4e5f-b21c-b366b8bc0dd3",
"user_identity_phone_number": "+1555551000",
"warnings": [],
"workspace_id": "8d4868e3-2f95-4f33-8689-19420b3101cd"
}
Examples
List access system users for a user identity phone number
Returns a list of all access system users for a specified user identity phone number.
Code:
await seam.acs.users.list({ user_identity_phone_number: "+1555551000" });
Output:
[
{
"access_schedule": {
"ends_at": "2025-06-12T11:00:00.000Z",
"starts_at": "2025-06-10T15:00:00.000Z"
},
"acs_system_id": "62d3384f-267f-4a4a-a946-d35819ec9981",
"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": "[email protected]",
"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": "+1555551000",
"user_identity_email_address": "[email protected]",
"user_identity_full_name": "Jane Doe",
"user_identity_id": "a23b3e02-e394-4e5f-b21c-b366b8bc0dd3",
"user_identity_phone_number": "+1555551000",
"warnings": [],
"workspace_id": "8d4868e3-2f95-4f33-8689-19420b3101cd"
}
]
List access system users for a user identity email address
Returns a list of all access system users for a specified user identity email address.
Code:
await seam.acs.users.list({ user_identity_email_address: "[email protected]" });
Output:
[
{
"access_schedule": {
"ends_at": "2025-06-12T11:00:00.000Z",
"starts_at": "2025-06-10T15:00:00.000Z"
},
"acs_system_id": "62d3384f-267f-4a4a-a946-d35819ec9981",
"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": "[email protected]",
"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": "+1555551000",
"user_identity_email_address": "[email protected]",
"user_identity_full_name": "Jane Doe",
"user_identity_id": "a23b3e02-e394-4e5f-b21c-b366b8bc0dd3",
"user_identity_phone_number": "+1555551000",
"warnings": [],
"workspace_id": "8d4868e3-2f95-4f33-8689-19420b3101cd"
}
]
List users for an access system
Returns a list of all users for a specified access system.
Code:
await seam.acs.users.list({
acs_system_id: "0e3369a0-1376-46cd-b79c-ebba856701a2",
});
Output:
[
{
"access_schedule": {
"ends_at": "2025-06-12T11:00:00.000Z",
"starts_at": "2025-06-10T15:00:00.000Z"
},
"acs_system_id": "0e3369a0-1376-46cd-b79c-ebba856701a2",
"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": "[email protected]",
"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": "+1555551000",
"user_identity_email_address": "[email protected]",
"user_identity_full_name": "Jane Doe",
"user_identity_id": "a23b3e02-e394-4e5f-b21c-b366b8bc0dd3",
"user_identity_phone_number": "+1555551000",
"warnings": [],
"workspace_id": "8d4868e3-2f95-4f33-8689-19420b3101cd"
}
]
List access system users, filtered by a string
Returns a list of all access system users, filtered by a string.
Code:
await seam.acs.users.list({ search: "Jane Doe" });
Output:
[
{
"access_schedule": {
"ends_at": "2025-06-12T11:00:00.000Z",
"starts_at": "2025-06-10T15:00:00.000Z"
},
"acs_system_id": "62d3384f-267f-4a4a-a946-d35819ec9981",
"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": "[email protected]",
"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": "+1555551000",
"user_identity_email_address": "[email protected]",
"user_identity_full_name": "Jane Doe",
"user_identity_id": "a23b3e02-e394-4e5f-b21c-b366b8bc0dd3",
"user_identity_phone_number": "+1555551000",
"warnings": [],
"workspace_id": "8d4868e3-2f95-4f33-8689-19420b3101cd"
}
]
List access system users, limited to ten per page
Returns a list of all access system users, with a limit of ten per page.
Code:
await seam.acs.users.list({
acs_system_id: "0e3369a0-1376-46cd-b79c-ebba856701a2",
limit: 10,
});
Output:
[
{
"access_schedule": {
"ends_at": "2025-06-12T11:00:00.000Z",
"starts_at": "2025-06-10T15:00:00.000Z"
},
"acs_system_id": "0e3369a0-1376-46cd-b79c-ebba856701a2",
"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": "[email protected]",
"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": "+1555551000",
"user_identity_email_address": "[email protected]",
"user_identity_full_name": "Jane Doe",
"user_identity_id": "a23b3e02-e394-4e5f-b21c-b366b8bc0dd3",
"user_identity_phone_number": "+1555551000",
"warnings": [],
"workspace_id": "8d4868e3-2f95-4f33-8689-19420b3101cd"
}
]
List access system users created before a date
Returns a list of all access system users created before a specified date.
Code:
await seam.acs.users.list({
acs_system_id: "0e3369a0-1376-46cd-b79c-ebba856701a2",
created_before: "2025-06-19T02:22:45.000Z",
});
Output:
[
{
"access_schedule": {
"ends_at": "2025-06-12T11:00:00.000Z",
"starts_at": "2025-06-10T15:00:00.000Z"
},
"acs_system_id": "0e3369a0-1376-46cd-b79c-ebba856701a2",
"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": "[email protected]",
"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": "+1555551000",
"user_identity_email_address": "[email protected]",
"user_identity_full_name": "Jane Doe",
"user_identity_id": "a23b3e02-e394-4e5f-b21c-b366b8bc0dd3",
"user_identity_phone_number": "+1555551000",
"warnings": [],
"workspace_id": "8d4868e3-2f95-4f33-8689-19420b3101cd"
}
]
Last updated
Was this helpful?