Grant an ACS User Access to an Entrance

• Request Parameters

• Response

• Examples

Grants a specified access system user access to a specified access system entrance.

JavaScript

Grants a specified access system user access to a specified access system entrance, using the associated user identity.

Code

await seam.acs.entrances.grantAccess({
  acs_entrance_id: "d23d7180-c1ee-4bbe-8630-05df5031ce35",
  user_identity_id: "c6247b75-f1cb-493a-9915-a85a0b9639ae",
});

Output

// void

cURL

Grants a specified access system user access to a specified access system entrance, using the associated user identity.

Code

curl --include --request POST "https://connect.getseam.com/acs/entrances/grant_access" \
  --header "Authorization: Bearer $SEAM_API_KEY" \
  --json @- <<EOF
{
  "acs_entrance_id": "d23d7180-c1ee-4bbe-8630-05df5031ce35",
  "user_identity_id": "c6247b75-f1cb-493a-9915-a85a0b9639ae"
}
EOF

Output

{}

Python

Grants a specified access system user access to a specified access system entrance, using the associated user identity.

Code

seam.acs.entrances.grant_access(
    acs_entrance_id="d23d7180-c1ee-4bbe-8630-05df5031ce35",
    user_identity_id="c6247b75-f1cb-493a-9915-a85a0b9639ae",
)

Output

None

Ruby

Grants a specified access system user access to a specified access system entrance, using the associated user identity.

Code

seam.acs.entrances.grant_access(
  acs_entrance_id: "d23d7180-c1ee-4bbe-8630-05df5031ce35",
  user_identity_id: "c6247b75-f1cb-493a-9915-a85a0b9639ae",
)

Output

nil

PHP

Grants a specified access system user access to a specified access system entrance, using the associated user identity.

Code

<?php
$seam->acs->entrances->grant_access(
    acs_entrance_id: "d23d7180-c1ee-4bbe-8630-05df5031ce35",
    user_identity_id: "c6247b75-f1cb-493a-9915-a85a0b9639ae"
);

Output

null

Seam CLI

Grants a specified access system user access to a specified access system entrance, using the associated user identity.

Code

seam acs entrances grant-access --acs_entrance_id "d23d7180-c1ee-4bbe-8630-05df5031ce35" --user_identity_id "c6247b75-f1cb-493a-9915-a85a0b9639ae"

Output

{}

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_entrance_id String (Required)

ID of the entrance to which you want to grant an access system user access.

---

acs_user_id String

ID of the access system user to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id.

---

user_identity_id String

ID of the user identity to whom you want to grant access to an entrance. 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

Grant an access system user access to an entrance

Grants a specified access system user access to a specified access system entrance.

JavaScript

Code

await seam.acs.entrances.grantAccess({
  acs_entrance_id: "d23d7180-c1ee-4bbe-8630-05df5031ce35",
  acs_user_id: "ace1dabe-7a25-4271-8d76-50e74ee4ae1f",
});

Output

// void

cURL

Code

curl --include --request POST "https://connect.getseam.com/acs/entrances/grant_access" \
  --header "Authorization: Bearer $SEAM_API_KEY" \
  --json @- <<EOF
{
  "acs_entrance_id": "d23d7180-c1ee-4bbe-8630-05df5031ce35",
  "acs_user_id": "ace1dabe-7a25-4271-8d76-50e74ee4ae1f"
}
EOF

Output

{}

Python

Code

seam.acs.entrances.grant_access(
    acs_entrance_id="d23d7180-c1ee-4bbe-8630-05df5031ce35",
    acs_user_id="ace1dabe-7a25-4271-8d76-50e74ee4ae1f",
)

Output

None

Ruby

Code

seam.acs.entrances.grant_access(
  acs_entrance_id: "d23d7180-c1ee-4bbe-8630-05df5031ce35",
  acs_user_id: "ace1dabe-7a25-4271-8d76-50e74ee4ae1f",
)

Output

nil

PHP

Code

<?php
$seam->acs->entrances->grant_access(
    acs_entrance_id: "d23d7180-c1ee-4bbe-8630-05df5031ce35",
    acs_user_id: "ace1dabe-7a25-4271-8d76-50e74ee4ae1f"
);

Output

null

Seam CLI

Code

seam acs entrances grant-access --acs_entrance_id "d23d7180-c1ee-4bbe-8630-05df5031ce35" --acs_user_id "ace1dabe-7a25-4271-8d76-50e74ee4ae1f"

Output

{}