List ACS Users in an Access Group

• Request Parameters

• Response

• Examples

Returns a list of all access system users in an access group.

Signature

POST /acs/access_groups/list_users ⇒ { acs_users: [acs_user, …] }

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_access_group_id String (Required)

ID of the access group for which you want to retrieve all access system users.

---

Response

Array of acs_users

JSON

{
  JSON representation of acs_user
}

---

Examples

List ACS users in an access group

Specify the acs_access_group_id to retrieve all ACS users in an access group.

JavaScript

Code

await seam.acs.accessGroups.listUsers({
  acs_access_group_id: "44444444-4444-4444-4444-444444444444",
});

Output

[
  {
    "acs_user_id": "33333333-3333-3333-3333-333333333333",
    "display_name": "Jane Doe",
    "full_name": "Jane Doe",
    "email": "[email protected]",
    "email_address": "[email protected]",
    "phone_number": "[phone]",
    "acs_system_id": "11111111-1111-1111-1111-111111111111",
    "workspace_id": "00000000-0000-0000-0000-000000000000",
    "created_at": "2024-04-05T07:14:28.531Z",
    "is_suspended": false,
    "access_schedule": {
      "starts_at": "2024-03-01T10:40:00.000Z",
      "ends_at": "2024-03-04T10:40:00.000Z"
    },
    "user_identity_id": "22222222-2222-2222-2222-222222222222",
    "user_identity_full_name": "Jane Doe",
    "user_identity_email_address": "[email protected]",
    "user_identity_phone_number": "[phone]"
  }
]

Python

Code

seam.acs.access_groups.list_users(
    acs_access_group_id="44444444-4444-4444-4444-444444444444"
)

Output

[
    AcsUser(
        acs_user_id="33333333-3333-3333-3333-333333333333",
        display_name="Jane Doe",
        full_name="Jane Doe",
        email="[email protected]",
        email_address="[email protected]",
        phone_number="[phone]",
        acs_system_id="11111111-1111-1111-1111-111111111111",
        workspace_id="00000000-0000-0000-0000-000000000000",
        created_at="2024-04-05T07:14:28.531Z",
        is_suspended=false,
        access_schedule={
            "starts_at": "2024-03-01T10:40:00.000Z",
            "ends_at": "2024-03-04T10:40:00.000Z",
        },
        user_identity_id="22222222-2222-2222-2222-222222222222",
        user_identity_full_name="Jane Doe",
        user_identity_email_address="[email protected]",
        user_identity_phone_number="[phone]",
    )
]

Ruby

Code

seam.acs.access_groups.list_users(acs_access_group_id: "44444444-4444-4444-4444-444444444444")

Output

[
  {
    "acs_user_id" => "33333333-3333-3333-3333-333333333333",
    "display_name" => "Jane Doe",
    "full_name" => "Jane Doe",
    "email" => "[email protected]",
    "email_address" => "[email protected]",
    "phone_number" => "[phone]",
    "acs_system_id" => "11111111-1111-1111-1111-111111111111",
    "workspace_id" => "00000000-0000-0000-0000-000000000000",
    "created_at" => "2024-04-05T07:14:28.531Z",
    "is_suspended" => false,
    "access_schedule" => {
      starts_at: "2024-03-01T10:40:00.000Z",
      ends_at: "2024-03-04T10:40:00.000Z",
    },
    "user_identity_id" => "22222222-2222-2222-2222-222222222222",
    "user_identity_full_name" => "Jane Doe",
    "user_identity_email_address" => "[email protected]",
    "user_identity_phone_number" => "[phone]",
  },
]

PHP

Code

<?php
$seam->acs->access_groups->list_users(
    acs_access_group_id: "44444444-4444-4444-4444-444444444444"
);

Output

<?php
[
    [
        "acs_user_id" => "33333333-3333-3333-3333-333333333333",
        "display_name" => "Jane Doe",
        "full_name" => "Jane Doe",
        "email" => "[email protected]",
        "email_address" => "[email protected]",
        "phone_number" => "[phone]",
        "acs_system_id" => "11111111-1111-1111-1111-111111111111",
        "workspace_id" => "00000000-0000-0000-0000-000000000000",
        "created_at" => "2024-04-05T07:14:28.531Z",
        "is_suspended" => false,
        "access_schedule" => [
            "starts_at" => "2024-03-01T10:40:00.000Z",
            "ends_at" => "2024-03-04T10:40:00.000Z",
        ],
        "user_identity_id" => "22222222-2222-2222-2222-222222222222",
        "user_identity_full_name" => "Jane Doe",
        "user_identity_email_address" => "[email protected]",
        "user_identity_phone_number" => "[phone]",
    ],
];

Seam CLI

Code

seam acs access-groups list-users --acs_access_group_id "44444444-4444-4444-4444-444444444444"

Output

[
  {
    "acs_user_id": "33333333-3333-3333-3333-333333333333",
    "display_name": "Jane Doe",
    "full_name": "Jane Doe",
    "email": "[email protected]",
    "email_address": "[email protected]",
    "phone_number": "[phone]",
    "acs_system_id": "11111111-1111-1111-1111-111111111111",
    "workspace_id": "00000000-0000-0000-0000-000000000000",
    "created_at": "2024-04-05T07:14:28.531Z",
    "is_suspended": false,
    "access_schedule": {
      "starts_at": "2024-03-01T10:40:00.000Z",
      "ends_at": "2024-03-04T10:40:00.000Z"
    },
    "user_identity_id": "22222222-2222-2222-2222-222222222222",
    "user_identity_full_name": "Jane Doe",
    "user_identity_email_address": "[email protected]",
    "user_identity_phone_number": "[phone]"
  }
]

Go

Code

package main

import api "github.com/seamapi/go"
import accessgroups "github.com/seamapi/go/accessgroups"

func main() {
	client.Acs.AccessGroups.ListUsers(
		context.Background(),
		accessgroups.AccessGroupsListUsersRequest{
			AcsAccessGroupId: api.String("44444444-4444-4444-4444-444444444444"),
		},
	)
}

Output

[]api.AcsUser{api.AcsUser{AcsUserId: "33333333-3333-3333-3333-333333333333", DisplayName: "Jane Doe", FullName: "Jane Doe", Email: "[email protected]", EmailAddress: "[email protected]", PhoneNumber: "[phone]", AcsSystemId: "11111111-1111-1111-1111-111111111111", WorkspaceId: "00000000-0000-0000-0000-000000000000", CreatedAt: "2024-04-05T07:14:28.531Z", IsSuspended: false, AccessSchedule: api.AcsUserAccessSchedule{StartsAt: "2024-03-01T10:40:00.000Z", EndsAt: "2024-03-04T10:40:00.000Z"}, UserIdentityId: "22222222-2222-2222-2222-222222222222", UserIdentityFullName: "Jane Doe", UserIdentityEmailAddress: "[email protected]", UserIdentityPhoneNumber: "[phone]"}}

cURL

Code

curl --include --request POST "https://connect.getseam.com/acs/access_groups/list_users" \
  --header "Authorization: Bearer $SEAM_API_KEY" \
  --json @- <<EOF
{
  "acs_access_group_id": "44444444-4444-4444-4444-444444444444"
}
EOF

Output

{
  "acs_users": [
    {
      "acs_user_id": "33333333-3333-3333-3333-333333333333",
      "display_name": "Jane Doe",
      "full_name": "Jane Doe",
      "email": "[email protected]",
      "email_address": "[email protected]",
      "phone_number": "[phone]",
      "acs_system_id": "11111111-1111-1111-1111-111111111111",
      "workspace_id": "00000000-0000-0000-0000-000000000000",
      "created_at": "2024-04-05T07:14:28.531Z",
      "is_suspended": false,
      "access_schedule": {
        "starts_at": "2024-03-01T10:40:00.000Z",
        "ends_at": "2024-03-04T10:40:00.000Z"
      },
      "user_identity_id": "22222222-2222-2222-2222-222222222222",
      "user_identity_full_name": "Jane Doe",
      "user_identity_email_address": "[email protected]",
      "user_identity_phone_number": "[phone]"
    }
  ]
}