Get an ACS User

• Request Parameters

• Response

• Examples

Returns a specified access system user.

JavaScript

Returns a specified access system user.

Code

await seam.acs.users.get({
  user_identity_id: "cde1ec76-5b0d-4b3e-9b85-d80dcc9b599c",
  acs_system_id: "f4d2b3fb-7fa5-47fd-b0d3-aa6da8f5b710",
});

Output

{
  "access_schedule": {
    "ends_at": "2025-06-12T11:00:00.000Z",
    "starts_at": "2025-06-10T15:00:00.000Z"
  },
  "acs_system_id": "f4d2b3fb-7fa5-47fd-b0d3-aa6da8f5b710",
  "acs_user_id": "42968059-0c89-40f3-b39a-fb80398d0d08",
  "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": "[phone]",
  "user_identity_email_address": "[email protected]",
  "user_identity_full_name": "Jane Doe",
  "user_identity_id": "cde1ec76-5b0d-4b3e-9b85-d80dcc9b599c",
  "user_identity_phone_number": "[phone]",
  "warnings": [],
  "workspace_id": "8d4868e3-2f95-4f33-8689-19420b3101cd"
}

cURL

Returns a specified access system user.

Code

curl --include --request POST "https://connect.getseam.com/acs/users/get" \
  --header "Authorization: Bearer $SEAM_API_KEY" \
  --json @- <<EOF
{
  "user_identity_id": "cde1ec76-5b0d-4b3e-9b85-d80dcc9b599c",
  "acs_system_id": "f4d2b3fb-7fa5-47fd-b0d3-aa6da8f5b710"
}
EOF

Output

{
  "acs_user": {
    "access_schedule": {
      "ends_at": "2025-06-12T11:00:00.000Z",
      "starts_at": "2025-06-10T15:00:00.000Z"
    },
    "acs_system_id": "f4d2b3fb-7fa5-47fd-b0d3-aa6da8f5b710",
    "acs_user_id": "42968059-0c89-40f3-b39a-fb80398d0d08",
    "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": "[phone]",
    "user_identity_email_address": "[email protected]",
    "user_identity_full_name": "Jane Doe",
    "user_identity_id": "cde1ec76-5b0d-4b3e-9b85-d80dcc9b599c",
    "user_identity_phone_number": "[phone]",
    "warnings": [],
    "workspace_id": "8d4868e3-2f95-4f33-8689-19420b3101cd"
  }
}

Python

Returns a specified access system user.

Code

seam.acs.users.get(
    user_identity_id="cde1ec76-5b0d-4b3e-9b85-d80dcc9b599c",
    acs_system_id="f4d2b3fb-7fa5-47fd-b0d3-aa6da8f5b710",
)

Output

AcsUser(
    access_schedule={
        "ends_at": "2025-06-12T11:00:00.000Z",
        "starts_at": "2025-06-10T15:00:00.000Z",
    },
    acs_system_id="f4d2b3fb-7fa5-47fd-b0d3-aa6da8f5b710",
    acs_user_id="42968059-0c89-40f3-b39a-fb80398d0d08",
    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="[phone]",
    user_identity_email_address="[email protected]",
    user_identity_full_name="Jane Doe",
    user_identity_id="cde1ec76-5b0d-4b3e-9b85-d80dcc9b599c",
    user_identity_phone_number="[phone]",
    warnings=[],
    workspace_id="8d4868e3-2f95-4f33-8689-19420b3101cd",
)

Ruby

Returns a specified access system user.

Code

seam.acs.users.get(
  user_identity_id: "cde1ec76-5b0d-4b3e-9b85-d80dcc9b599c",
  acs_system_id: "f4d2b3fb-7fa5-47fd-b0d3-aa6da8f5b710",
)

Output

{
  "access_schedule" => {
    ends_at: "2025-06-12T11:00:00.000Z",
    starts_at: "2025-06-10T15:00:00.000Z",
  },
  "acs_system_id" => "f4d2b3fb-7fa5-47fd-b0d3-aa6da8f5b710",
  "acs_user_id" => "42968059-0c89-40f3-b39a-fb80398d0d08",
  "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" => "[phone]",
  "user_identity_email_address" => "[email protected]",
  "user_identity_full_name" => "Jane Doe",
  "user_identity_id" => "cde1ec76-5b0d-4b3e-9b85-d80dcc9b599c",
  "user_identity_phone_number" => "[phone]",
  "warnings" => [],
  "workspace_id" => "8d4868e3-2f95-4f33-8689-19420b3101cd",
}

PHP

Returns a specified access system user.

Code

$seam->acs->users->get(
    user_identity_id: "cde1ec76-5b0d-4b3e-9b85-d80dcc9b599c",
    acs_system_id: "f4d2b3fb-7fa5-47fd-b0d3-aa6da8f5b710"
);

Output

[
    "access_schedule" => [
        "ends_at" => "2025-06-12T11:00:00.000Z",
        "starts_at" => "2025-06-10T15:00:00.000Z",
    ],
    "acs_system_id" => "f4d2b3fb-7fa5-47fd-b0d3-aa6da8f5b710",
    "acs_user_id" => "42968059-0c89-40f3-b39a-fb80398d0d08",
    "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" => "[phone]",
    "user_identity_email_address" => "[email protected]",
    "user_identity_full_name" => "Jane Doe",
    "user_identity_id" => "cde1ec76-5b0d-4b3e-9b85-d80dcc9b599c",
    "user_identity_phone_number" => "[phone]",
    "warnings" => [],
    "workspace_id" => "8d4868e3-2f95-4f33-8689-19420b3101cd",
];

Seam CLI

Returns a specified access system user.

Code

seam acs users get --user_identity_id "cde1ec76-5b0d-4b3e-9b85-d80dcc9b599c" --acs_system_id "f4d2b3fb-7fa5-47fd-b0d3-aa6da8f5b710"

Output

{
  "access_schedule": {
    "ends_at": "2025-06-12T11:00:00.000Z",
    "starts_at": "2025-06-10T15:00:00.000Z"
  },
  "acs_system_id": "f4d2b3fb-7fa5-47fd-b0d3-aa6da8f5b710",
  "acs_user_id": "42968059-0c89-40f3-b39a-fb80398d0d08",
  "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": "[phone]",
  "user_identity_email_address": "[email protected]",
  "user_identity_full_name": "Jane Doe",
  "user_identity_id": "cde1ec76-5b0d-4b3e-9b85-d80dcc9b599c",
  "user_identity_phone_number": "[phone]",
  "warnings": [],
  "workspace_id": "8d4868e3-2f95-4f33-8689-19420b3101cd"
}

Authentication Methods

• API key

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

To learn more, see Authentication.

Request Parameters

acs_system_id String

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

---

acs_user_id String

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

---

user_identity_id String

ID of the user identity that you want to get. You can only provide acs_user_id or user_identity_id.

---

Response

acs_user

JSON

{
  "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": "[phone]",
  "user_identity_email_address": "[email protected]",
  "user_identity_full_name": "Jane Doe",
  "user_identity_id": "a23b3e02-e394-4e5f-b21c-b366b8bc0dd3",
  "user_identity_phone_number": "[phone]",
  "warnings": [],
  "workspace_id": "8d4868e3-2f95-4f33-8689-19420b3101cd"
}

---

Examples

Get an access system user

Returns a specified access system user.

JavaScript

Code

await seam.acs.users.get({
  acs_user_id: "42968059-0c89-40f3-b39a-fb80398d0d08",
});

Output

{
  "access_schedule": {
    "ends_at": "2025-06-12T11:00:00.000Z",
    "starts_at": "2025-06-10T15:00:00.000Z"
  },
  "acs_system_id": "f4d2b3fb-7fa5-47fd-b0d3-aa6da8f5b710",
  "acs_user_id": "42968059-0c89-40f3-b39a-fb80398d0d08",
  "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": "[phone]",
  "user_identity_email_address": "[email protected]",
  "user_identity_full_name": "Jane Doe",
  "user_identity_id": "cde1ec76-5b0d-4b3e-9b85-d80dcc9b599c",
  "user_identity_phone_number": "[phone]",
  "warnings": [],
  "workspace_id": "8d4868e3-2f95-4f33-8689-19420b3101cd"
}

cURL

Code

curl --include --request POST "https://connect.getseam.com/acs/users/get" \
  --header "Authorization: Bearer $SEAM_API_KEY" \
  --json @- <<EOF
{
  "acs_user_id": "42968059-0c89-40f3-b39a-fb80398d0d08"
}
EOF

Output

{
  "acs_user": {
    "access_schedule": {
      "ends_at": "2025-06-12T11:00:00.000Z",
      "starts_at": "2025-06-10T15:00:00.000Z"
    },
    "acs_system_id": "f4d2b3fb-7fa5-47fd-b0d3-aa6da8f5b710",
    "acs_user_id": "42968059-0c89-40f3-b39a-fb80398d0d08",
    "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": "[phone]",
    "user_identity_email_address": "[email protected]",
    "user_identity_full_name": "Jane Doe",
    "user_identity_id": "cde1ec76-5b0d-4b3e-9b85-d80dcc9b599c",
    "user_identity_phone_number": "[phone]",
    "warnings": [],
    "workspace_id": "8d4868e3-2f95-4f33-8689-19420b3101cd"
  }
}

Python

Code

seam.acs.users.get(acs_user_id="42968059-0c89-40f3-b39a-fb80398d0d08")

Output

AcsUser(
    access_schedule={
        "ends_at": "2025-06-12T11:00:00.000Z",
        "starts_at": "2025-06-10T15:00:00.000Z",
    },
    acs_system_id="f4d2b3fb-7fa5-47fd-b0d3-aa6da8f5b710",
    acs_user_id="42968059-0c89-40f3-b39a-fb80398d0d08",
    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="[phone]",
    user_identity_email_address="[email protected]",
    user_identity_full_name="Jane Doe",
    user_identity_id="cde1ec76-5b0d-4b3e-9b85-d80dcc9b599c",
    user_identity_phone_number="[phone]",
    warnings=[],
    workspace_id="8d4868e3-2f95-4f33-8689-19420b3101cd",
)

Ruby

Code

seam.acs.users.get(acs_user_id: "42968059-0c89-40f3-b39a-fb80398d0d08")

Output

{
  "access_schedule" => {
    ends_at: "2025-06-12T11:00:00.000Z",
    starts_at: "2025-06-10T15:00:00.000Z",
  },
  "acs_system_id" => "f4d2b3fb-7fa5-47fd-b0d3-aa6da8f5b710",
  "acs_user_id" => "42968059-0c89-40f3-b39a-fb80398d0d08",
  "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" => "[phone]",
  "user_identity_email_address" => "[email protected]",
  "user_identity_full_name" => "Jane Doe",
  "user_identity_id" => "cde1ec76-5b0d-4b3e-9b85-d80dcc9b599c",
  "user_identity_phone_number" => "[phone]",
  "warnings" => [],
  "workspace_id" => "8d4868e3-2f95-4f33-8689-19420b3101cd",
}

PHP

Code

$seam->acs->users->get(acs_user_id: "42968059-0c89-40f3-b39a-fb80398d0d08");

Output

[
    "access_schedule" => [
        "ends_at" => "2025-06-12T11:00:00.000Z",
        "starts_at" => "2025-06-10T15:00:00.000Z",
    ],
    "acs_system_id" => "f4d2b3fb-7fa5-47fd-b0d3-aa6da8f5b710",
    "acs_user_id" => "42968059-0c89-40f3-b39a-fb80398d0d08",
    "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" => "[phone]",
    "user_identity_email_address" => "[email protected]",
    "user_identity_full_name" => "Jane Doe",
    "user_identity_id" => "cde1ec76-5b0d-4b3e-9b85-d80dcc9b599c",
    "user_identity_phone_number" => "[phone]",
    "warnings" => [],
    "workspace_id" => "8d4868e3-2f95-4f33-8689-19420b3101cd",
];

Seam CLI

Code

seam acs users get --acs_user_id "42968059-0c89-40f3-b39a-fb80398d0d08"

Output

{
  "access_schedule": {
    "ends_at": "2025-06-12T11:00:00.000Z",
    "starts_at": "2025-06-10T15:00:00.000Z"
  },
  "acs_system_id": "f4d2b3fb-7fa5-47fd-b0d3-aa6da8f5b710",
  "acs_user_id": "42968059-0c89-40f3-b39a-fb80398d0d08",
  "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": "[phone]",
  "user_identity_email_address": "[email protected]",
  "user_identity_full_name": "Jane Doe",
  "user_identity_id": "cde1ec76-5b0d-4b3e-9b85-d80dcc9b599c",
  "user_identity_phone_number": "[phone]",
  "warnings": [],
  "workspace_id": "8d4868e3-2f95-4f33-8689-19420b3101cd"
}