Create an ACS User
Creates a new access system user.
Code
Creates a new ACS user.
await seam.acs.users.create({
acs_system_id: "123e4567-e89b-12d3-a456-426614174000",
full_name: "Jane Doe",
email_address: "[email protected]",
phone_number: "+15555550100",
});
Output
{
"acs_user_id": "123e4567-e89b-12d3-a456-426614174000",
"acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
"workspace_id": "123e4567-e89b-12d3-a456-426614174000",
"created_at": "2024-04-05T07:57:05.323Z",
"display_name": "Jane Doe",
"full_name": "Jane Doe",
"email_address": "[email protected]",
"phone_number": "+15555550100"
}
Request Parameters
acs_system_id
String (Required)
ID of the access system to which you want to add the new access system user.
full_name
String (Required)
Full name of the new access system user.
access_schedule
Object
starts_at
and ends_at
timestamps for the new access system user's access. If you specify an access_schedule
, you may include both starts_at
and ends_at
. If you omit starts_at
, it defaults to the current time. ends_at
is optional and must be a time in the future and after starts_at
.
acs_access_group_ids
Array of UUIDs
Array of access group IDs to indicate the access groups to which you want to add the new access system user.
email
String
email_address
String
Email address of the ACS user.
phone_number
String
Phone number of the ACS user in E.164 format (for example, +15555550100
).
user_identity_id
String
ID of the user identity with which you want to associate the new access system user.
Response
Examples
Create a new ACS user
Creates a new ACS user with an access schedule.
Code
await seam.acs.users.create({
acs_system_id: "123e4567-e89b-12d3-a456-426614174000",
full_name: "Jane Doe",
email_address: "[email protected]",
phone_number: "+15555550100",
access_schedule: {
starts_at: "2024-11-01T15:00:00.000Z",
ends_at: "2024-11-04T11:00:00.000Z",
},
});
Output
{
"acs_user_id": "123e4567-e89b-12d3-a456-426614174000",
"acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
"workspace_id": "123e4567-e89b-12d3-a456-426614174000",
"created_at": "2024-04-05T07:57:05.323Z",
"display_name": "Jane Doe",
"full_name": "Jane Doe",
"email_address": "[email protected]",
"phone_number": "+15555550100"
}
Create a new ACS user in an access group
Creates a new ACS user and assigns the new user to an access group.
Code
await seam.acs.users.create({
acs_system_id: "123e4567-e89b-12d3-a456-426614174000",
full_name: "Jane Doe",
email_address: "[email protected]",
phone_number: "+15555550100",
acs_access_group_ids: ["123e4567-e89b-12d3-a456-426614174000"],
});
Output
{
"acs_user_id": "123e4567-e89b-12d3-a456-426614174000",
"acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
"workspace_id": "123e4567-e89b-12d3-a456-426614174000",
"created_at": "2024-04-05T07:57:05.323Z",
"display_name": "Jane Doe",
"full_name": "Jane Doe",
"email_address": "[email protected]",
"phone_number": "+15555550100"
}
Last updated
Was this helpful?