| Characteristic | Creation Parameter | Description |
|---|---|---|
| Who |
user\_identity\_id or user\_identity
|
The user to whom to grant access. You can either create a user identity separately and specify the ID to the Access Grant or create a new user identity as part of the Access Grant creation action. |
| Where |
device\_ids, space\_ids, or{' '}
acs\_entrance\_ids
|
The access points to which to grant access. Specify one or more devices (such as standalone smart locks) by ID, one or more access system entrances by ID, or both. Alternately, you can define{' '} spaces that contain groups of related devices and entrances and then specify one or more spaces by ID. |
| When |
starts\_at and ends\_at
|
The access schedule. |
| How |
requested\_access\_methods and mode
|
The access methods that you want to grant for the user. In each{' '}
requested\_access\_method, specify the desired{' '}
mode of access, such as a PIN code, key card, or mobile key
(with an{' '}
Instant Key
).
|
| Step | Description |
|---|---|
|
To connect your devices or access system to Seam, we recommend embedding
a{' '}
Connect Webview
{' '}
in your application. The Connect Webview flow guides the property
manager through each step of the connection process.
For standalone smart locks, this is all the setup you need. For on-premises access systems, use Seam Bridge to connect the access system securely to Seam. For details, see{' '} Connect an Access System to Seam . |
|
If you are granting access to access system entrances, confirm hardware capabilities and make sure that you have the required licenses. For example, if you plan to use mobile keys or Instant Keys, your lock hardware must support Bluetooth Low Energy (BLE) keys. Also, to use mobile keys with your access system, you may need to purchase licenses or subscriptions to activate certain software features. These requirements vary by access system. For details, see{' '} Setting Up Your Site for Instant Keys {' '} and the{' '} system integration guide {' '} for your access system. |
|
You can use spaces to create groups of devices and entrances for
efficiency. For example, a user staying in Room 101 may need access to
the Room 101 door, the main entrance door, and the nearest elevator. You
could create a space that includes these access points and then use this
space when creating an Access Grant.
For details, see{' '} spaces. |
|
User identities represent your users—the people to whom you want to
grant access. You can create a user identity before creating an Access
Grant, or you can create a user identity as part of creating the Access
Grant.
See{' '} Managing Mobile App User Accounts with User Identities . |
|
When you create an Access Grant, you specify the user identity to whom
you want to grant access, the access schedule, the set of devices,
entrances, or spaces, and one or more access methods that you want to
request.
See{' '} Creating an Access Grant Using Devices ,{' '} Creating an Access Grant Using Spaces , and{' '} Creating an Access Grant Using Entrances . You can poll for access method status changes or watch for Access Grant and access method lifecycle events that alert you to next steps, such as how and when to deliver each created access method to your user. |
|
Once Seam alerts you that your access methods are ready, deliver them to your user. Delivery steps depend on the mode of access, such as PIN code, plastic key card, or mobile key.
See{' '} Delivering Access Methods. |