Copy POST /acs/users/create ⇒ { acs_user }
Creates a new ACS user .
JavaScript Python Ruby PHP Seam CLI Go
Request
Copy await seam . acs . users .create ({
acs_system_id : "123e4567-e89b-12d3-a456-426614174000" ,
});
Response
Copy {
"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" : "jane@example.com" ,
"phone_number" : "+15555550100"
}
Request
Copy seam . acs . users . create (acs_system_id = "123e4567-e89b-12d3-a456-426614174000" )
Response
Copy 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 = "jane@example.com" ,
phone_number = "+15555550100" ,
)
Request
Copy seam . acs . users . create(acs_system_id: "123e4567-e89b-12d3-a456-426614174000" )
Response
Copy {"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" => "jane@example.com", "phone_number" => "+15555550100"}
Request
Copy <? php
$seam -> acs -> users -> create (
acs_system_id : "123e4567-e89b-12d3-a456-426614174000"
) ;
Response
Copy <? 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" => "jane@example.com" ,
"phone_number" => "+15555550100" ,
];
Request
Copy seam acs users create --acs_system_id "123e4567-e89b-12d3-a456-426614174000"
Response
Copy {
"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": "jane@example.com",
"phone_number": "+15555550100"
}
Request
Copy 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
Copy 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: "jane@example.com", PhoneNumber: "+15555550100"}
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 may include both starts_at
and ends_at
. starts_at
defaults to the current time if not provided. ends_at
is optional and must be a time in the future and after starts_at
.
acs_access_group_ids
Type: array
Required: No
Array of access_group_id
s 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, +15555550100
).
user_identity_id
Type: string
Required: No
ID of the user identity with which to associate the new acs_user
.
Return Type
acs_user