Sign UpSupported Devices
Edit

Add a User to an Access Group

Add a specified ACS user to a specified access group

Adds a specified ACS user to a specified access group.

/acs/access_groups/add_user

post

Adds a specified access system user to a specified access group.

Authorizations
Body
acs_access_group_idstring · uuidRequired

ID of the access group to which you want to add an access system user.

acs_user_idstring · uuidOptional

ID of the access system user that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id.

user_identity_idstring · uuidOptional

ID of the desired user identity that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same email_address or phone_number as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.

Responses
200

OK

application/json
post
/acs/access_groups/add_user
POST /acs/access_groups/add_user HTTP/1.1
Host: connect.getseam.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 173

{
  "acs_access_group_id": "123e4567-e89b-12d3-a456-426614174000",
  "acs_user_id": "123e4567-e89b-12d3-a456-426614174000",
  "user_identity_id": "123e4567-e89b-12d3-a456-426614174000"
}
{
  "ok": true
}

Request

Specify the desired access group and user by including the corresponding acs_access_group_id and acs_user_id in the request body.

Request Body Parameters

Parameter
Type
Description

acs_access_group_id

String (UUID) Required

ID of the desired access group

acs_user_id

String (UUID) Required

ID of the desired user

Sample Request

seam.acs.access_groups.add_user(
  acs_access_group_id="44444444-4444-4444-4444-444444444444",
  acs_user_id="33333333-3333-3333-3333-333333333333"
)

Response

Returns a Boolean ok status indicator or void.

Sample Response

None
PreviousGet an Access GroupNextRemove a User from an Access Group

Last updated

Was this helpful?