Ask or search…
⌃K
Links

Create a User

Create a new user
Creates a new user (acs_user object).
post
https://connect.getseam.com
/acs/users/create
/acs/users/create

Request

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

Request Body Parameters

Parameter
Type
Description
acs_system_id
String Required
ID of the access control system to which to add the new user
acs_access_group_ids
Array of strings Optional
Array of access group IDs to indicate the access groups to which to add the new user
user_identity_id
String Optional
ID of the user identity with which to associate the new user
full_name
String Optional
Full name of the new user
email_address
String Optional
Email address of the new user
phone_number
String Optional
Phone number of the new user in E.164 format (for example, +15555550100)

Sample Request

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": "fc793d86-dcfd-4cfe-859f-0b9c1a5c1360",
"acs_access_group_ids": ["3adfb716-ba84-431e-ab30-ab521f2aa8e8"],
"full_name": "Jim Doe",
"email_address": "[email protected]",
"phone_number": "+15555550107"
}'

Response

Returns an acs_user containing the following properties:
Property
Description
acs_user_id
ID of the user
display_name
Display name for the user
full_name
Full name of the user
email_address
Email address of the user
phone_number
Phone number of the user in E.164 format (for example, +15555550100)
external_type
Brand-specific terminology for the user type
external_type_display_name
Display name that corresponds to the brand-specific terminology for the user type
acs_system_id
ID of the access control system that contains the user
workspace_id
ID of the workspace that contains the user
created_at
Date and time at which the user was created
is_suspended
Boolean value to indicate whether the user is currently suspended​
This response also includes a Boolean ok status indicator.

Sample Response

JSON
{
"acs_user": {
"acs_user_id": "4763daf5-e831-4076-82e5-3e59d36da8e3",
"display_name": "Jim Doe",
"full_name": "Jim Doe",
"email_address": "[email protected]",
"external_type": "pti_user",
"external_type_display_name": "PTI user",
"acs_system_id": "fc793d86-dcfd-4cfe-859f-0b9c1a5c1360",
"workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
"created_at": "2023-09-29T04:55:53.297Z",
"is_suspended": false
},
"ok": true
}
Last modified 1mo ago