Skip to content

Scopes

The following section lists the available scopes which partner applications can request when registering their OAuth clients with Tapkey.

All the scopes below are available for the Grant Types supported by Tapkey. To see the supported Grant Types head to the Authorization Options for OAuth Apps page.

Each individual scope will give your application access to a set of endpoints in the Tapkey Management API. Head to the Operations section to check the endpoints available and which scopes they require.

Locks, Cards and Contacts (AKA Core entities)

Scope identifier Access Level Description
read:core:entities Read-only Allow to view NFC transponders, locks and smartphone users.
write:core:entities Read and write Allow to manage NFC transponders, locks and smartphone users.

Grants

Scope identifier Access Level Description
read:grants Read-only Allow to list grants.
write:grants Read and write Allow to add and revoke grants.

Owner Accounts

Scope identifier Access Level Description
read:owneraccounts Read-only Allow to view owner accounts.
write:owneraccounts Read and write Allow manage owner accounts.

Permissions

Scope identifier Access Level Description
read:owneraccount:permissions Read-only Allow to view owner account admins.
write:owneraccount:permissions Read and write Allow to manage owner account admins.