Create a User

Create a new ACS user

Creates a new ACS user.

/acs/users/create

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

Authorization

pat_with_workspaceconsole_sessionapi_key

Body

application/json

acs_system_id*string (uuid)

acs_access_group_idsarray of string (uuid)

user_identity_idstring (uuid)

access_scheduleobject

full_namestring

emailstring (email)

---
deprecated: use email_address.
---

phone_numbernullable string

email_addressstring (email)

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/create', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer API Token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "acs_system_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-04-27T06:48:30.542Z",
    "display_name": "text",
    "external_type": "pti_user",
    "external_type_display_name": "text",
    "is_suspended": false,
    "access_schedule": {
      "starts_at": "2024-04-27T06:48:30.542Z",
      "ends_at": "2024-04-27T06:48:30.542Z"
    },
    "user_identity_id": "text",
    "user_identity_full_name": "text",
    "user_identity_email_address": "text",
    "user_identity_phone_number": "text",
    "full_name": "text",
    "email": "[e-mail]",
    "email_address": "[e-mail]",
    "phone_number": "text"
  },
  "ok": false
}

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

Parameter	Type	Description
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, [phone])
access_schedule	Object Optional	starts_at and ends_at dates/times for the new ACS user's access

Sample Request

Python

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="[e-mail]",
  phone_number="[phone]",
  access_schedule={
    "starts_at": "2024-03-01T10:40:00Z",
    "ends_at": "2024-03-04T10:40:00Z"
  }
)

cURL (bash)

curl -X 'POST' \
  'https://connect.getseam.com/acs/users/create' \
  -H 'accept: application/json' \
  -H "Authorization: Bearer ${API_KEY}" \
  -H 'Content-Type: application/json' \
  -d '{
  "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": "[e-mail]",
  "phone_number": "[phone]",
  "access_schedule": {
    "starts_at": "2024-03-01T10:40:00Z",
    "ends_at": "2024-03-04T10:40:00Z"
  }
}'

JavaScript

await 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: "[e-mail]",
  phone_number: "[phone]",
  access_schedule: {
    "starts_at": "2024-03-01T10:40:00Z",
    "ends_at": "2024-03-04T10:40:00Z"
  }
});

Ruby

# Coming soon!

PHP

$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: "[e-mail]",
  phone_number: "[phone]",
  access_schedule: array(
    "starts_at" => "2024-03-01T10:40:00Z",
    "ends_at" => "2024-03-04T10:40:00Z"
  )
);

C#

seam.UsersAcs.Create(
  acsSystemId: "11111111-1111-1111-1111-111111111111",
  userIdentityId: "22222222-2222-2222-2222-222222222222",
  acsAccessGroupIds: new List<string>(new string[] {"44444444-4444-4444-4444-444444444444"}),
  fullName: "Jane Doe",
  emailAddress: "[e-mail]",
  phoneNumber: "[phone]",
  accessSchedule: new Dictionary<string, string>()
    {
      {"starts_at", "2024-03-01T10:40:00Z"},
      {"ends_at", "2024-03-04T10:40:00Z"}
    }
);

Java

// Coming soon!

Go

startsAt, err := time.Parse(time.RFC3339, "2024-03-01T10:40:00Z")
endsAt, err := time.Parse(time.RFC3339, "2024-03-04T10:40:00Z")
if err != nil {
  return err
}

acs_user, uErr := client.Acs.Users.Create(
  context.Background(), &acs.UsersCreateRequest{
    AcsSystemId: "11111111-1111-1111-1111-111111111111",
    UserIdentityId: api.String("22222222-2222-2222-2222-222222222222"),
    AcsAccessGroupIds: []string{"44444444-4444-4444-4444-444444444444"},
    FullName: api.String("Jane Doe"),
    EmailAddress: api.String("[e-mail]"),
    PhoneNumber: api.String("[phone]"),
    AccessSchedule: &acs.UsersCreateRequestAccessSchedule{
      StartsAt: startsAt,
      EndsAt: endsAt,
    },
  },
)

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'
)

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"
  },
  "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:28:06.012Z',
  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'
}

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

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

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:57:05.323Z",
    "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"
  },
  "ok": true
}