Get a User

Get a specified ACS user

Returns a specified ACS user.

/acs/users/get

post

Returns a specified access system user.

Authorizations

Body

acs_user_idstring · uuidOptional

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

user_identity_idstring · uuidOptional

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

acs_system_idstring · uuidOptional

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

Responses

200

application/json

400

Bad Request

401

Unauthorized

post

POST /acs/users/get HTTP/1.1
Host: connect.getseam.com
Authorization: Bearer API Token
Content-Type: application/json
Accept: */*
Content-Length: 167

{
  "acs_user_id": "123e4567-e89b-12d3-a456-426614174000",
  "user_identity_id": "123e4567-e89b-12d3-a456-426614174000",
  "acs_system_id": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "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": "2025-07-01T04:46:01.628Z",
    "display_name": "text",
    "external_type": "pti_user",
    "external_type_display_name": "text",
    "is_suspended": true,
    "access_schedule": {
      "starts_at": "2025-07-01T04:46:01.628Z",
      "ends_at": "2025-07-01T04:46:01.628Z"
    },
    "user_identity_id": "text",
    "user_identity_full_name": "text",
    "user_identity_email_address": "text",
    "user_identity_phone_number": "text",
    "warnings": [
      {
        "created_at": "2025-07-01T04:46:01.628Z",
        "message": "text",
        "warning_code": "being_deleted"
      }
    ],
    "errors": [
      {
        "created_at": "2025-07-01T04:46:01.628Z",
        "message": "text",
        "error_code": "deleted_externally"
      }
    ],
    "pending_mutations": [
      {
        "created_at": "2025-07-01T04:46:01.628Z",
        "message": "text",
        "mutation_code": "creating"
      }
    ],
    "last_successful_sync_at": "2025-07-01T04:46:01.628Z",
    "connected_account_id": "123e4567-e89b-12d3-a456-426614174000",
    "full_name": "text",
    "email_address": "[email protected]",
    "phone_number": "text",
    "is_managed": true
  },
  "ok": true
}

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

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

# 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"
}'

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

# Coming soon!

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

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

// Coming soon!

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, +15555550100)

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, +15555550100)

Sample Response

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='+15555550100',
  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='[email protected]',
  user_identity_phone_number='+15555550100'
)

{
  "acs_user": {
    "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": "+15555550100",
    "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": "[email protected]",
    "user_identity_phone_number": "+15555550100"
  },
  "ok": true
}

{
  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: '+15555550100',
  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: '[email protected]',
  user_identity_phone_number: '+15555550100'
}

# Coming soon!

{
  "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": "+15555550100",
  "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": "[email protected]",
  "user_identity_phone_number": "+15555550100"
}

{
  "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": "+15555550100",
  "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": "[email protected]",
  "user_identity_phone_number": "+15555550100"
}

// Coming soon!

{
  "acs_user": {
    "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": "+15555550100",
    "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": "[email protected]",
    "user_identity_phone_number": "+15555550100"
  },
  "ok": true
}

PreviousList Users NextUpdate a User

Last updated 1 year ago

Was this helpful?