Add an ACS User to an Access Group

• Request Parameters

• Response

• Examples

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

Signature

PUT /acs/access_groups/add_user ⇒ void

Authentication Methods

• API key

• Personal access token Must also include the seam-workspace header in the request.

To learn more, see Authentication.

Request Parameters

acs_access_group_id String (Required)

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

---

acs_user_id String

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_id String

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.

---

Response

void

---

Examples

Add an ACS user to an access group

Specify the acs_access_group_id and acs_user_id to add an ACS user to an access group.

JavaScript

Code

await seam.acs.accessGroups.addUser({
  acs_access_group_id: "44444444-4444-4444-4444-444444444444",
  acs_user_id: "33333333-3333-3333-3333-333333333333",
});

Output

// void

Python

Code

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

Output

None

Ruby

Code

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

Output

nil

PHP

Code

<?php
$seam->acs->access_groups->add_user(
    acs_access_group_id: "44444444-4444-4444-4444-444444444444",
    acs_user_id: "33333333-3333-3333-3333-333333333333"
);

Output

null

Seam CLI

Code

seam acs access-groups add-user --acs_access_group_id "44444444-4444-4444-4444-444444444444" --acs_user_id "33333333-3333-3333-3333-333333333333"

Output

{}

Go

Code

package main

import api "github.com/seamapi/go"
import accessgroups "github.com/seamapi/go/accessgroups"

func main() {
	client.Acs.AccessGroups.AddUser(
		context.Background(),
		accessgroups.AccessGroupsAddUserRequest{
			AcsAccessGroupId: api.String("44444444-4444-4444-4444-444444444444"),
			AcsUserId:        api.String("33333333-3333-3333-3333-333333333333"),
		},
	)
}

Output

nil

cURL

Code

curl --include --request POST "https://connect.getseam.com/acs/access_groups/add_user" \
  --header "Authorization: Bearer $SEAM_API_KEY" \
  --json @- <<EOF
{
  "acs_access_group_id": "44444444-4444-4444-4444-444444444444",
  "acs_user_id": "33333333-3333-3333-3333-333333333333"
}
EOF

Output

{}