Skip to content

Commit a754e08

Browse files
sybohyclaude
andcommitted
feat: relegate legacy granting guides to a Low-Level APIs section
Access Grants are now the recommended way to grant access. The legacy granting recipes move to a new "Low-Level APIs" section at the very bottom of the nav, with warning banners steering readers to Access Grants: - Move smart-locks/access-codes/** and access-systems/ managing-credentials/** to low-level-apis/ with .gitbook.yaml redirects for every old URL - New Low-Level APIs landing page documenting the remaining legitimate low-level uses (custom PIN values, backup/offline code pools, unmanaged-code migration, direct credential inspection) - Warning banners on the moved guides: no longer recommended for granting access; deprecation expected in the medium term - Pointer hints (not moved) on ACS quick starts and Managing ACS Users - Scope guard: lock/unlock, encoders, user suspension, access groups, and other non-granting guides stay where they are Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 25eb343 commit a754e08

36 files changed

Lines changed: 150 additions & 86 deletions

.gitbook.yaml

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,6 @@ redirects:
1616
core-concepts/workspaces/client-session-tokens: core-concepts/authentication/client-session-tokens/README.md
1717
core-concepts/workspaces/client-session-tokens/implementing-client-sessions-for-device-management-in-the-backend: core-concepts/authentication/client-session-tokens/implementing-client-sessions-for-device-management-in-the-backend.md
1818
products/access-systems/user-management: capability-guides/access-systems/user-management.md
19-
capability-guides/access-systems/managing-credentials: capability-guides/access-systems/managing-credentials.md
20-
capability-guides/access-systems/assigning-credentials-to-users: capability-guides/access-systems/managing-credentials/assigning-credentials-to-users.md
2119
products/access-systems/suspending-and-unsuspending-users: capability-guides/access-systems/user-management/suspending-and-unsuspending-users.md
2220
products/seam-bridge-in-development: capability-guides/seam-bridge.md
2321
core-concepts/connect-webviews: core-concepts/connect-webviews/README.md
@@ -33,3 +31,21 @@ redirects:
3331
capability-guides/access-grants/updating-an-access-grant: use-cases/granting-access/updating-an-access-grant.md
3432
capability-guides/access-grants/revoking-an-access-method: use-cases/granting-access/revoking-an-access-method.md
3533
capability-guides/access-grants/deleting-an-access-grant: use-cases/granting-access/deleting-an-access-grant.md
34+
capability-guides/smart-locks/access-codes: low-level-apis/access-codes/README.md
35+
capability-guides/smart-locks/access-codes/creating-access-codes: low-level-apis/access-codes/creating-access-codes/README.md
36+
capability-guides/smart-locks/access-codes/creating-access-codes/understanding-code-constraints: low-level-apis/access-codes/creating-access-codes/understanding-code-constraints.md
37+
capability-guides/smart-locks/access-codes/retrieving-access-codes: low-level-apis/access-codes/retrieving-access-codes.md
38+
capability-guides/smart-locks/access-codes/modifying-access-codes: low-level-apis/access-codes/modifying-access-codes.md
39+
capability-guides/smart-locks/access-codes/deleting-access-codes: low-level-apis/access-codes/deleting-access-codes.md
40+
capability-guides/smart-locks/access-codes/lifecycle-of-access-codes: low-level-apis/access-codes/lifecycle-of-access-codes.md
41+
capability-guides/smart-locks/access-codes/access-code-requirements-for-door-locks: low-level-apis/access-codes/access-code-requirements-for-door-locks.md
42+
capability-guides/smart-locks/access-codes/accommodating-manufacturer-mobile-apps: low-level-apis/access-codes/accommodating-manufacturer-mobile-apps.md
43+
capability-guides/smart-locks/access-codes/troubleshooting-access-code-issues: low-level-apis/access-codes/troubleshooting-access-code-issues.md
44+
capability-guides/smart-locks/access-codes/backup-access-codes: low-level-apis/access-codes/backup-access-codes.md
45+
capability-guides/smart-locks/access-codes/offline-access-codes: low-level-apis/access-codes/offline-access-codes.md
46+
capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes: low-level-apis/access-codes/creating-and-updating-multiple-linked-access-codes.md
47+
capability-guides/smart-locks/access-codes/migrating-existing-access-codes: low-level-apis/access-codes/migrating-existing-access-codes.md
48+
capability-guides/access-systems/managing-credentials: low-level-apis/managing-credentials.md
49+
capability-guides/access-systems/managing-credentials/assigning-credentials-to-users: low-level-apis/managing-credentials/assigning-credentials-to-users.md
50+
capability-guides/access-systems/managing-credentials/listing-credentials-and-associated-entrances: low-level-apis/managing-credentials/listing-credentials-and-associated-entrances.md
51+
capability-guides/access-systems/assigning-credentials-to-users: low-level-apis/managing-credentials/assigning-credentials-to-users.md

docs/guides/SUMMARY.md

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -60,20 +60,6 @@
6060
* [Smart Locks](capability-guides/smart-locks/README.md)
6161
* [Get started with Smart Locks](capability-guides/smart-locks/get-started-with-smartlocks-api.md)
6262
* [Locking and Unlocking Smart Locks](capability-guides/smart-locks/lock-and-unlock.md)
63-
* [Creating and Managing Smart Lock Access Codes](capability-guides/smart-locks/access-codes/README.md)
64-
* [Creating Access Codes](capability-guides/smart-locks/access-codes/creating-access-codes/README.md)
65-
* [Understanding Code Constraints](capability-guides/smart-locks/access-codes/creating-access-codes/understanding-code-constraints.md)
66-
* [Retrieving Access Codes](capability-guides/smart-locks/access-codes/retrieving-access-codes.md)
67-
* [Modifying Access Codes](capability-guides/smart-locks/access-codes/modifying-access-codes.md)
68-
* [Deleting Access Codes](capability-guides/smart-locks/access-codes/deleting-access-codes.md)
69-
* [Lifecycle of Access Codes](capability-guides/smart-locks/access-codes/lifecycle-of-access-codes.md)
70-
* [Access Code Requirements for Door Locks](capability-guides/smart-locks/access-codes/access-code-requirements-for-door-locks.md)
71-
* [Streamlining Access Code Management from the Manufacturer App](capability-guides/smart-locks/access-codes/accommodating-manufacturer-mobile-apps.md)
72-
* [Troubleshooting Access Codes](capability-guides/smart-locks/access-codes/troubleshooting-access-code-issues.md)
73-
* [Managing Backup Access Codes](capability-guides/smart-locks/access-codes/backup-access-codes.md)
74-
* [Managing Offline Access Codes](capability-guides/smart-locks/access-codes/offline-access-codes.md)
75-
* [Creating and Updating Multiple Linked Access Codes](capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes.md)
76-
* [Migrating Existing Unmanaged Access Codes](capability-guides/smart-locks/access-codes/migrating-existing-access-codes.md)
7763
* [Access Control Systems](capability-guides/access-systems/README.md)
7864
* [Access System Quick Starts](capability-guides/access-systems/acs-quick-starts/README.md)
7965
* [PIN Code Quick Start](capability-guides/access-systems/acs-quick-starts/pin-code-quick-start.md)
@@ -87,9 +73,6 @@
8773
* [Suspending and Unsuspending ACS Users](capability-guides/access-systems/user-management/suspending-and-unsuspending-users.md)
8874
* [Assigning ACS Users to Access Groups](capability-guides/access-systems/user-management/assigning-users-to-access-groups.md)
8975
* [Retrieving Entrance Details](capability-guides/access-systems/retrieving-entrance-details.md)
90-
* [Managing Credentials](capability-guides/access-systems/managing-credentials.md)
91-
* [Assigning Credentials to ACS Users](capability-guides/access-systems/managing-credentials/assigning-credentials-to-users.md)
92-
* [Listing Credentials and Associated Entrances](capability-guides/access-systems/managing-credentials/listing-credentials-and-associated-entrances.md)
9376
* [Working with Card Encoders and Scanners](capability-guides/access-systems/working-with-card-encoders-and-scanners/README.md)
9477
* [Creating and Encoding Card-based Credentials](capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials.md)
9578
* [Creating and Encoding Card Access Methods](capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-access-methods.md)
@@ -195,3 +178,24 @@
195178
* [Creating Intercom CRUD Endpoints](device-manufacturer-guidance/creating-a-seam-compatible-intercom-api/creating-intercom-crud-endpoints.md)
196179
* [Creating Access Code CRUD Endpoints](device-manufacturer-guidance/creating-a-seam-compatible-intercom-api/creating-access-code-crud-endpoints.md)
197180
* [Creating the Health Endpoint](device-manufacturer-guidance/creating-a-seam-compatible-intercom-api/creating-the-health-endpoint.md)
181+
182+
## Low-Level APIs
183+
184+
* [Low-Level APIs](low-level-apis/README.md)
185+
* [Creating and Managing Smart Lock Access Codes](low-level-apis/access-codes/README.md)
186+
* [Creating Access Codes](low-level-apis/access-codes/creating-access-codes/README.md)
187+
* [Understanding Code Constraints](low-level-apis/access-codes/creating-access-codes/understanding-code-constraints.md)
188+
* [Retrieving Access Codes](low-level-apis/access-codes/retrieving-access-codes.md)
189+
* [Modifying Access Codes](low-level-apis/access-codes/modifying-access-codes.md)
190+
* [Deleting Access Codes](low-level-apis/access-codes/deleting-access-codes.md)
191+
* [Lifecycle of Access Codes](low-level-apis/access-codes/lifecycle-of-access-codes.md)
192+
* [Access Code Requirements for Door Locks](low-level-apis/access-codes/access-code-requirements-for-door-locks.md)
193+
* [Streamlining Access Code Management from the Manufacturer App](low-level-apis/access-codes/accommodating-manufacturer-mobile-apps.md)
194+
* [Troubleshooting Access Codes](low-level-apis/access-codes/troubleshooting-access-code-issues.md)
195+
* [Managing Backup Access Codes](low-level-apis/access-codes/backup-access-codes.md)
196+
* [Managing Offline Access Codes](low-level-apis/access-codes/offline-access-codes.md)
197+
* [Creating and Updating Multiple Linked Access Codes](low-level-apis/access-codes/creating-and-updating-multiple-linked-access-codes.md)
198+
* [Migrating Existing Unmanaged Access Codes](low-level-apis/access-codes/migrating-existing-access-codes.md)
199+
* [Managing ACS Credentials](low-level-apis/managing-credentials.md)
200+
* [Assigning Credentials to ACS Users](low-level-apis/managing-credentials/assigning-credentials-to-users.md)
201+
* [Listing Credentials and Associated Entrances](low-level-apis/managing-credentials/listing-credentials-and-associated-entrances.md)

docs/guides/capability-guides/access-systems/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,5 +70,5 @@ Find out more about using Seam to manage access control system resources. See th
7070
6. Learn about available entrances.
7171
* [Retrieving Entrance Details](../../capability-guides/access-systems/retrieving-entrance-details.md)
7272
7. Create credentials for ACS users.
73-
* [Managing Credentials](../../capability-guides/access-systems/managing-credentials.md)
73+
* [Managing Credentials](../../low-level-apis/managing-credentials.md)
7474
8. See the Seam [Access Control Systems API reference](https://docs.seam.co/latest/api/acs/).

docs/guides/capability-guides/access-systems/acs-quick-starts/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ description: >-
77

88
# Access System Quick Starts
99

10+
{% hint style="success" %}
11+
**Granting access?** [Access Grants](../../../use-cases/granting-access/README.md) are the default and recommended way to issue PIN codes, key cards, and mobile keys across access systems and standalone smart locks. Start with the [Access Grant Quick Start](../../../use-cases/granting-access/access-grant-quick-start.md).
12+
{% endhint %}
13+
1014
* [PIN Code Quick Start](pin-code-quick-start.md)\
1115
Create your first PIN code credential to grant an access system user scheduled access to a virtual entrance that has a keypad.
1216
* [Encodable Key Card Quick Start](encodable-key-card-quick-start.md)\

docs/guides/capability-guides/access-systems/acs-quick-starts/encodable-key-card-quick-start.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ This quick start walks you through the following basic steps:
2222
* To get started quickly, use a virtual ACS in a [sandbox workspace](../../../core-concepts/workspaces/#sandbox-workspaces).
2323
2. Install a Seam SDK and create an API key.
2424
3. Create an [ACS user](../user-management.md).
25-
4. Create an encodable key card [ACS credential](../managing-credentials.md) for the ACS user.
25+
4. Create an encodable key card [ACS credential](../../../low-level-apis/managing-credentials.md) for the ACS user.
2626

2727
This credential contains both the set of entrances to which the user has access and the access schedule for the user.\
2828
While some access control systems specify allowed entrances directly within the credential, others use access groups. For more details, see [Access Permission Assignment Variations](../connect-an-acs-to-seam/understanding-access-control-system-differences.md#access-permission-assignment-variations).
@@ -807,7 +807,7 @@ For a deeper dive into ACS concepts and instructions, see the following topics:
807807
4. Learn about available entrances.
808808
* [Retrieving Entrance Details](../retrieving-entrance-details.md)
809809
5. Create credentials for ACS users.
810-
* [Managing Credentials](../managing-credentials.md)
810+
* [Managing Credentials](../../../low-level-apis/managing-credentials.md)
811811
6. For relevant access control systems, encode credentials onto key cards.
812812
* [Working with Card Encoders and Scanners](../working-with-card-encoders-and-scanners/)
813813
7. See the Seam [Access Control Systems API reference](https://docs.seam.co/latest/api/acs/).

docs/guides/capability-guides/access-systems/acs-quick-starts/mobile-key-quick-start.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ This quick start walks you through the following basic steps:
2424
4. Assign the user identity to an [access group](../user-management/assigning-users-to-access-groups.md).
2525
* Access groups are preconfigured to grant access to specific entrances.\
2626
While some access control systems use access groups, others specify allowed entrances directly within the credential. For more details, see [Access Permission Assignment Variations](../connect-an-acs-to-seam/understanding-access-control-system-differences.md#access-permission-assignment-variations).
27-
5. Create a mobile key [ACS credential](../managing-credentials.md) for the user identity.
27+
5. Create a mobile key [ACS credential](../../../low-level-apis/managing-credentials.md) for the user identity.
2828
6. View the list of entrances to which the user now has access.
2929

3030
:rocket: Let's get started!
@@ -613,7 +613,7 @@ For a deeper dive into ACS concepts and instructions, see the following topics:
613613
4. Learn about available entrances.
614614
* [Retrieving Entrance Details](../retrieving-entrance-details.md)
615615
5. Create credentials for ACS users.
616-
* [Managing Credentials](../managing-credentials.md)
616+
* [Managing Credentials](../../../low-level-apis/managing-credentials.md)
617617
6. Learn more about the Seam mobile access solution.
618618
* [Mobile Access](../../mobile-access/)
619619
* [Integrating into your mobile application](../../mobile-access/mobile-device-sdks/)

docs/guides/capability-guides/access-systems/acs-quick-starts/pin-code-quick-start.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ This quick start walks you through the following basic steps:
2424
4. Assign the ACS user to an [access group](../user-management/assigning-users-to-access-groups.md).
2525
* Access groups are preconfigured to grant access to specific entrances.\
2626
While some access control systems use access groups, others specify allowed entrances directly within the credential. For more details, see [Access Permission Assignment Variations](../connect-an-acs-to-seam/understanding-access-control-system-differences.md#access-permission-assignment-variations).
27-
5. Create a PIN code [ACS credential](../managing-credentials.md) for the ACS user.
27+
5. Create a PIN code [ACS credential](../../../low-level-apis/managing-credentials.md) for the ACS user.
2828
6. View the following information about your successfully-created credential:
2929
* The PIN code for the credential.
3030
* The access schedule for the ACS user.
@@ -650,5 +650,5 @@ For a deeper dive into ACS concepts and instructions, see the following topics:
650650
4. Learn about available entrances.
651651
* [Retrieving Entrance Details](../retrieving-entrance-details.md)
652652
5. Create credentials for ACS users.
653-
* [Managing Credentials](../managing-credentials.md)
653+
* [Managing Credentials](../../../low-level-apis/managing-credentials.md)
654654
6. See the Seam [Access Control Systems API reference](https://docs.seam.co/latest/api/acs/).

0 commit comments

Comments
 (0)