Create an ACS User
Last updated
Was this helpful?
Last updated
Was this helpful?
Creates a new .
API key
Personal access token
Must also include the seam-workspace
header in the request.
To learn more, see .
acs_system_id
(Required)
ID of the access system to which you want to add the new access system user.
full_name
(Required)
Full name of the new access system user.
access_schedule
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
of UUIDs
Array of access group IDs to indicate the access groups to which you want to add the new access system user.
email
email_address
phone_number
user_identity_id
ID of the user identity with which you want to associate the new access system user.
Code
await seam.acs.users.create({
acs_system_id: "123e4567-e89b-12d3-a456-426614174000",
full_name: "Jane Doe",
email_address: "jane@example.com",
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": "jane@example.com",
"phone_number": "+15555550100"
}
Code
seam.acs.users.create(
acs_system_id="123e4567-e89b-12d3-a456-426614174000",
full_name="Jane Doe",
email_address="jane@example.com",
phone_number="+15555550100",
)
Output
AcsUser(
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="jane@example.com",
phone_number="+15555550100",
)
Code
seam.acs.users.create(
acs_system_id: "123e4567-e89b-12d3-a456-426614174000",
full_name: "Jane Doe",
email_address: "jane@example.com",
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" => "jane@example.com",
"phone_number" => "+15555550100",
}
Code
<?php
$seam->acs->users->create(
acs_system_id: "123e4567-e89b-12d3-a456-426614174000",
full_name: "Jane Doe",
email_address: "jane@example.com",
phone_number: "+15555550100"
);
Output
<?php
[
"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" => "jane@example.com",
"phone_number" => "+15555550100",
];
Code
seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --full_name "Jane Doe" --email_address "jane@example.com" --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": "jane@example.com",
"phone_number": "+15555550100"
}
Code
package main
import api "github.com/seamapi/go"
import users "github.com/seamapi/go/users"
func main() {
client.Acs.Users.Create(
context.Background(),
users.UsersCreateRequest{
AcsSystemId: api.String("123e4567-e89b-12d3-a456-426614174000"),
FullName: api.String("Jane Doe"),
EmailAddress: api.String("jane@example.com"),
PhoneNumber: api.String("+15555550100"),
},
)
}
Output
api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"}
Code
curl --include --request POST "https://connect.getseam.com/acs/users/create" \
--header "Authorization: Bearer $SEAM_API_KEY" \
--json @- <<EOF
{
"acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
"full_name": "Jane Doe",
"email_address": "jane@example.com",
"phone_number": "+15555550100"
}
EOF
Output
{
"acs_user": {
"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": "jane@example.com",
"phone_number": "+15555550100"
}
}
Code
await seam.acs.users.create({
acs_system_id: "123e4567-e89b-12d3-a456-426614174000",
full_name: "Jane Doe",
email_address: "jane@example.com",
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": "jane@example.com",
"phone_number": "+15555550100"
}
Code
seam.acs.users.create(
acs_system_id="123e4567-e89b-12d3-a456-426614174000",
full_name="Jane Doe",
email_address="jane@example.com",
phone_number="+15555550100",
access_schedule={
"starts_at": "2024-11-01T15:00:00.000Z",
"ends_at": "2024-11-04T11:00:00.000Z",
},
)
Output
AcsUser(
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="jane@example.com",
phone_number="+15555550100",
)
Code
seam.acs.users.create(
acs_system_id: "123e4567-e89b-12d3-a456-426614174000",
full_name: "Jane Doe",
email_address: "jane@example.com",
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" => "jane@example.com",
"phone_number" => "+15555550100",
}
Code
<?php
$seam->acs->users->create(
acs_system_id: "123e4567-e89b-12d3-a456-426614174000",
full_name: "Jane Doe",
email_address: "jane@example.com",
phone_number: "+15555550100",
access_schedule: [
"starts_at" => "2024-11-01T15:00:00.000Z",
"ends_at" => "2024-11-04T11:00:00.000Z",
]
);
Output
<?php
[
"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" => "jane@example.com",
"phone_number" => "+15555550100",
];
Code
seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --full_name "Jane Doe" --email_address "jane@example.com" --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": "jane@example.com",
"phone_number": "+15555550100"
}
Code
package main
import api "github.com/seamapi/go"
import users "github.com/seamapi/go/users"
func main() {
client.Acs.Users.Create(
context.Background(),
users.UsersCreateRequest{
AcsSystemId: api.String("123e4567-e89b-12d3-a456-426614174000"),
FullName: api.String("Jane Doe"),
EmailAddress: api.String("jane@example.com"),
PhoneNumber: api.String("+15555550100"),
AccessSchedule: users.UsersCreateRequestAccessSchedule{StartsAt: api.String("2024-11-01T15:00:00.000Z"), EndsAt: api.String("2024-11-04T11:00:00.000Z")},
},
)
}
Output
api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"}
Code
curl --include --request POST "https://connect.getseam.com/acs/users/create" \
--header "Authorization: Bearer $SEAM_API_KEY" \
--json @- <<EOF
{
"acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
"full_name": "Jane Doe",
"email_address": "jane@example.com",
"phone_number": "+15555550100",
"access_schedule": {
"starts_at": "2024-11-01T15:00:00.000Z",
"ends_at": "2024-11-04T11:00:00.000Z"
}
}
EOF
Output
{
"acs_user": {
"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": "jane@example.com",
"phone_number": "+15555550100"
}
}
Code
await seam.acs.users.create({
acs_system_id: "123e4567-e89b-12d3-a456-426614174000",
full_name: "Jane Doe",
email_address: "jane@example.com",
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": "jane@example.com",
"phone_number": "+15555550100"
}
Code
seam.acs.users.create(
acs_system_id="123e4567-e89b-12d3-a456-426614174000",
full_name="Jane Doe",
email_address="jane@example.com",
phone_number="+15555550100",
acs_access_group_ids=["123e4567-e89b-12d3-a456-426614174000"],
)
Output
AcsUser(
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="jane@example.com",
phone_number="+15555550100",
)
Code
seam.acs.users.create(
acs_system_id: "123e4567-e89b-12d3-a456-426614174000",
full_name: "Jane Doe",
email_address: "jane@example.com",
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" => "jane@example.com",
"phone_number" => "+15555550100",
}
Code
<?php
$seam->acs->users->create(
acs_system_id: "123e4567-e89b-12d3-a456-426614174000",
full_name: "Jane Doe",
email_address: "jane@example.com",
phone_number: "+15555550100",
acs_access_group_ids: ["123e4567-e89b-12d3-a456-426614174000"]
);
Output
<?php
[
"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" => "jane@example.com",
"phone_number" => "+15555550100",
];
Code
seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000" --full_name "Jane Doe" --email_address "jane@example.com" --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": "jane@example.com",
"phone_number": "+15555550100"
}
Code
package main
import api "github.com/seamapi/go"
import users "github.com/seamapi/go/users"
func main() {
client.Acs.Users.Create(
context.Background(),
users.UsersCreateRequest{
AcsSystemId: api.String("123e4567-e89b-12d3-a456-426614174000"),
FullName: api.String("Jane Doe"),
EmailAddress: api.String("jane@example.com"),
PhoneNumber: api.String("+15555550100"),
AcsAccessGroupIds: [1]string{api.String("123e4567-e89b-12d3-a456-426614174000")},
},
)
}
Output
api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", WorkspaceId: "123e4567-e89b-12d3-a456-426614174000", CreatedAt: "2024-04-05T07:57:05.323Z", DisplayName: "Jane Doe", FullName: "Jane Doe", EmailAddress: "jane@example.com", PhoneNumber: "+15555550100"}
Code
curl --include --request POST "https://connect.getseam.com/acs/users/create" \
--header "Authorization: Bearer $SEAM_API_KEY" \
--json @- <<EOF
{
"acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
"full_name": "Jane Doe",
"email_address": "jane@example.com",
"phone_number": "+15555550100",
"acs_access_group_ids": [
"123e4567-e89b-12d3-a456-426614174000"
]
}
EOF
Output
{
"acs_user": {
"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": "jane@example.com",
"phone_number": "+15555550100"
}
}
Email address of the .
Phone number of the in E.164 format (for example, +15555550100
).
Creates a new .
Creates a new with an access schedule.
Creates a new and assigns the new user to an .