Get a User

Get a specified ACS user

Returns a specified ACS user.

/acs/users/get

POSThttps://connect.getseam.com/acs/users/get

Authorization

pat_with_workspaceconsole_sessionapi_key

Body

application/json

acs_user_id*string (uuid)

Response

200400401

OK

Body

application/json

acs_user*acs_user (object)

ok*boolean

Request

JavaScriptCurl

const response = await fetch('https://connect.getseam.com/acs/users/get', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer API Token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "acs_user_id": "123e4567-e89b-12d3-a456-426614174000"
    }),
});
const data = await response.json();

Response

{
  "acs_user": {
    "acs_user_id": "123e4567-e89b-12d3-a456-426614174000",
    "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
    "hid_acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
    "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2024-07-27T08:15:30.004Z",
    "display_name": "text",
    "external_type": "pti_user",
    "external_type_display_name": "text",
    "is_suspended": false,
    "access_schedule": {
      "starts_at": "2024-07-27T08:15:30.004Z",
      "ends_at": "2024-07-27T08:15:30.004Z"
    },
    "user_identity_id": "text",
    "user_identity_full_name": "text",
    "user_identity_email_address": "text",
    "user_identity_phone_number": "text",
    "latest_desired_state_synced_with_provider_at": "2024-07-27T08:15:30.004Z",
    "is_latest_desired_state_synced_with_provider": false,
    "warnings": [
      {
        "created_at": "2024-07-27T08:15:30.004Z",
        "message": "text",
        "warning_code": "being_deleted"
      }
    ],
    "full_name": "text",
    "email_address": "[e-mail]",
    "phone_number": "text"
  },
  "ok": false
}

Request

Specify the desired ACS user by including the corresponding acs_user_id in the request body.

Request Body Parameters

Parameter	Type	Description
acs_user_id	String (UUID) Required	ID of the desired ACS user

Sample Request

Python

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

cURL (bash)

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

JavaScript

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

Ruby

# Coming soon!

PHP

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

C#

seam.AcsUsers.Get(
  acsUserId: "33333333-3333-3333-3333-333333333333"
);

Java

// Coming soon!

Go

acs_user, uErr := client.Acs.Users.Get(
  context.Background(), &acs.UsersGetRequest{
    AcsUserId: "33333333-3333-3333-3333-333333333333",
  },
)

Response

Returns an acs_user containing the following properties:

Property	Description
acs_user_id	ID of the ACS user
display_name	Display name for the ACS user
full_name	Full name of the ACS user
email	Email address of the ACS user (for backward compatibility)
email_address	Email address of the ACS user
phone_number	Phone number of the ACS user in E.164 format (for example, [phone])
acs_system_id	ID of the access control system that contains the ACS user
workspace_id	ID of the workspace that contains the ACS user
created_at	Date and time at which the ACS user was created
is_suspended	Indicates whether the ACS user is currently suspended
access_schedule	starts_at and ends_at dates/times for the ACS user's access
user_identity_id	ID of the user identity associated with the ACS user
user_identity_email_address	Email address of the user identity associated with the ACS user
user_identity_phone_number	Phone number of the user identity associated with the ACS user in E.164 format (for example, [phone])

Sample Response

Python

AcsUser(
  acs_user_id='33333333-3333-3333-3333-333333333333',
  display_name='Jane Doe',
  full_name='Jane Doe',
  email='[e-mail]',
  email_address='[e-mail]',
  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_email_address='[e-mail]',
  user_identity_phone_number='[phone]'
)

cURL (bash)

{
  "acs_user": {
    "acs_user_id": "33333333-3333-3333-3333-333333333333",
    "display_name": "Jane Doe",
    "full_name": "Jane Doe",
    "email": "[e-mail]",
    "email_address": "[e-mail]",
    "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_email_address": "[e-mail]",
    "user_identity_phone_number": "[phone]"
  },
  "ok": true
}

JavaScript

{
  acs_user_id: '33333333-3333-3333-3333-333333333333',
  display_name: 'Jane Doe',
  full_name: 'Jane Doe',
  email: '[e-mail]',
  email_address: '[e-mail]',
  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_email_address: '[e-mail]',
  user_identity_phone_number: '[phone]'
}

Ruby

# Coming soon!

PHP

{
  "acs_user_id": "33333333-3333-3333-3333-333333333333",
  "display_name": "Jane Doe",
  "full_name": "Jane Doe",
  "email": "[e-mail]",
  "email_address": "[e-mail]",
  "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_email_address": "[e-mail]",
  "user_identity_phone_number": "[phone]"
}

C#

{
  "acs_user_id": "33333333-3333-3333-3333-333333333333",
  "display_name": "Jane Doe",
  "full_name": "Jane Doe",
  "email": "[e-mail]",
  "email_address": "[e-mail]",
  "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_email_address": "[e-mail]",
  "user_identity_phone_number": "[phone]"
}

Java

// Coming soon!

Go

{
  "acs_user": {
    "acs_user_id": "33333333-3333-3333-3333-333333333333",
    "display_name": "Jane Doe",
    "full_name": "Jane Doe",
    "email": "[e-mail]",
    "email_address": "[e-mail]",
    "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_email_address": "[e-mail]",
    "user_identity_phone_number": "[phone]"
  },
  "ok": true
}