docs/src/data/paths.yaml at b0250c5945fcbad9ccca106361acf95f7d52ced5 · seamapi/docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
---
/acs:
  title: Access Control Systems
  description: Systems for managing and monitoring access to physical spaces
  overview: |
    Access control systems centralize access authorization for buildings, which means that you can use a single system to grant users access to one or more entrances. An access control system manages the following elements:

    - Who has access
    - The entrances to which users have access
    - The access schedule for each user and entrance
    - The access mechanism—PIN codes, mobile keys, or plastic cards—for each access grant

    To grant access using the Seam access control system API, use the following basic process:

    1. Create `acs_user`s.
    2. Configure access for these users.
       For some access control systems, configure the allowed entrances and access schedule. For other systems, use `acs_access_group`s. For details, see the [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems) for your access control system.
    3. Create `acs_credential`s, which are the digital means of granting access to users, such as PIN codes, mobile keys, and plastic (RFID) cards.
       If you are developing a mobile app to provide access for your users, you can also use [Seam's iOS and Android SDKs](https://docs.seam.co/latest/capability-guides/mobile-access/mobile-device-sdks) that pair with the Seam API to create and manage mobile keys.

/acs/systems:
  title: Systems
  resources:
    - acs_system

/acs/users:
  title: ACS Users
  resources:
    - acs_user

/acs/entrances:
  title: Entrances
  resources:
    - acs_entrance

/acs/access_groups:
  title: Access Groups
  resources:
    - acs_access_group

/acs/credentials:
  title: Credentials
  resources:
    - acs_credential

/acs/encoders:
  title: Encoders
  resources:
    - acs_encoder

/acs/encoders/simulate:
  title: Encoder Simulations

/phones:
  title: Phones
  resources:
    - phone

/phones/simulate:
  title: Phone Simulations

/thermostats:
  title: Thermostats
  resources: []

/thermostats/simulate:
  title: Thermostat Simulations

/thermostats/schedules:
  title: Thermostat Schedules
  resources:
    - thermostat_schedule

/user_identities:
  title: User Identities
  resources:
    - user_identity

/user_identities/enrollment_automations:
  title: Enrollment Automations
  resources:
    - enrollment_automation

/workspaces:
  title: Workspaces
  resources:
    - workspace