Create a User

Create a new ACS user

Creates a new ACS user.

Request

Specify the characteristics of the new ACS user by including the corresponding parameters in the request body. Also, include the acs_system_id of the access control system to which you want to add the new ACS user. In addition, you can specify the acs_access_group_ids of the access groups to which you want to add the new ACS user, as well as a user_identity_id if you want to associate the new ACS user with a user identity.

Request Body Parameters

ParameterTypeDescription

acs_system_id

String (UUID) Required

ID of the access control system to which to add the new ACS user

acs_access_group_ids

Array of strings (UUIDs) Optional

Array of access group IDs to indicate the access groups to which to add the new ACS user

user_identity_id

String (UUID) Optional

ID of the user identity with which to associate the new ACS user

full_name

String Optional

Full name of the new ACS user

email_address

String Optional

Email address of the new ACS user

phone_number

String Optional

Phone number of the new ACS user in E.164 format (for example, +15555550100)

access_schedule

Object Optional

starts_at and ends_at dates/times for the new ACS user's access

Sample Request

seam.acs.users.create(
  acs_system_id="11111111-1111-1111-1111-111111111111",
  user_identity_id="22222222-2222-2222-2222-222222222222",
  acs_access_group_ids=["44444444-4444-4444-4444-444444444444"],
  full_name="Jane Doe",
  email_address="jane@example.com",
  phone_number="+15555550100",
  access_schedule={
    "starts_at": "2024-03-01T10:40:00Z",
    "ends_at": "2024-03-04T10:40:00Z"
  }
)

Response

Returns an acs_user containing the following properties:

PropertyDescription

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='jane@example.com',
  email_address='jane@example.com',
  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'
)

Last updated

Logo

Š Seam Labs, Inc. All rights reserved.