Create an ACS User

POST /acs/users/create ⇒ { acs_user }

Creates a new ACS user.

JavaScript

Request

await seam.acs.users.create({
  acs_system_id: "123e4567-e89b-12d3-a456-426614174000",
});

Response

{
  "acs_user_id": "123e4567-e89b-12d3-a456-426614174000",
  "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
  "acs_access_group_ids": ["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": "[e-mail]",
  "phone_number": "[phone]"
}

Python

Request

seam.acs.users.create(acs_system_id="123e4567-e89b-12d3-a456-426614174000")

Response

AcsUser(
    acs_user_id="123e4567-e89b-12d3-a456-426614174000",
    acs_system_id="123e4567-e89b-12d3-a456-426614174000",
    acs_access_group_ids=["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="[e-mail]",
    phone_number="[phone]",
)

Ruby

Request

seam.acs.users.create(acs_system_id: "123e4567-e89b-12d3-a456-426614174000")

Response

{"acs_user_id" => "123e4567-e89b-12d3-a456-426614174000", "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000", "acs_access_group_ids" => ["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" => "[e-mail]", "phone_number" => "[phone]"}

PHP

Request

<?php
$seam->acs->users->create(
    acs_system_id: "123e4567-e89b-12d3-a456-426614174000"
);

Response

<?php
[
    "acs_user_id" => "123e4567-e89b-12d3-a456-426614174000",
    "acs_system_id" => "123e4567-e89b-12d3-a456-426614174000",
    "acs_access_group_ids" => ["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" => "[e-mail]",
    "phone_number" => "[phone]",
];

Seam CLI

Request

seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000"

Response

{
  "acs_user_id": "123e4567-e89b-12d3-a456-426614174000",
  "acs_system_id": "123e4567-e89b-12d3-a456-426614174000",
  "acs_access_group_ids": ["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": "[e-mail]",
  "phone_number": "[phone]"
}

Go

Request

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

Response

api.AcsUser{AcsUserId: "123e4567-e89b-12d3-a456-426614174000", AcsSystemId: "123e4567-e89b-12d3-a456-426614174000", AcsAccessGroupIds: []string{"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: "[e-mail]", PhoneNumber: "[phone]"}

Request Parameters

access_schedule

Type: object Required: No

starts_at and ends_at timestamps for the new acs_user's access. If you specify an access_schedule, you must include both starts_at and ends_at. ends_at must be a time in the future and after starts_at. Only applicable to Salto KS access control systems.

---

acs_access_group_ids

Type: array Required: No

Array of access_group_ids to indicate the access groups to which to add the new acs_user.

---

acs_system_id

Type: string Required: Yes

ID of the acs_system to which to add the new acs_user.

---

email

Type: string Required: No

---

email_address

Type: string Required: No

Email address of the acs_user.

---

full_name

Type: string Required: No

Full name of the acs_user.

---

phone_number

Type: string Required: No

Phone number of the acs_user in E.164 format (for example, [phone]).

---

user_identity_id

Type: string Required: No

ID of the user identity with which to associate the new acs_user.

---

Return Type

acs_user