unifi_access/docs/completion.md
Adam Goldsmith 5b0c72dbef Initial Commit
Really should have added this to version control earlier, but was
trying to fix all the pre-commit issues first...
2024-11-26 12:50:13 -05:00

13 KiB

Completion

  • AccessClient -> implemented in the client
  • offline/examples test -> has offline tests based on examples in the API reference pdf
  • live test -> is used in a test that runs against a real instance
Section/Endpoint AccessClient offline/examples test live test
3. User
└─ 3.2 User Registration
└─ 3.3 Update User
└─ 3.4 Fetch User
└─ 3.5 Fetch All Users
└─ 3.6 Assign Access Policy to User
└─ 3.7 Assign NFC Card to User
└─ 3.8 Unassign NFC Card from User
└─ 3.9 Assign PIN Code to User
└─ 3.10 Unassign PIN Code from User
└─ 3.11 Create User Group
└─ 3.12 Fetch All User Groups
└─ 3.13 Fetch User Group
└─ 3.14 Update User Group
└─ 3.15 Delete User Group
└─ 3.16 Assign User to User Group
└─ 3.17 Unassign User from User Group
└─ 3.18 Fetch Users in a User Group
└─ 3.19 Fetch All Users in a User Group
└─ 3.20 Fetch the Access Policies Assigned to a User
└─ 3.21 Assign Access Policy to User Group
└─ 3.22 Fetch the Access Policies Assigned to a User Group
4. Visitor
└─ 4.2 Create Visitor
└─ 4.3 Fetch Visitor
└─ 4.4 Fetch All Visitors
└─ 4.5 Update Visitor
└─ 4.6 Delete Visitor
└─ 4.7 Assign NFC Card To Visitor
└─ 4.8 Unassign NFC Card From Visitor
└─ 4.9 Assign PIN Code To Visitor
└─ 4.10 Unassign PIN Code From Visitor
5. Access Policy
└─ 5.2 Create Access Policy
└─ 5.3 Update Access Policy
└─ 5.4 Delete Access Policy
└─ 5.5 Fetch Access Policy
└─ 5.6 Fetch All Access Policies
└─ 5.8 Create Holiday Group
└─ 5.9 Update Holiday Group
└─ 5.10 Delete Holiday Group
└─ 5.11 Fetch Holiday Group
└─ 5.12 Fetch All Holiday Groups
└─ 5.14 Create Schedule
└─ 5.15 Update Schedule
└─ 5.16 Fetch Schedule
└─ 5.17 Fetch All Schedules
└─ 5.18 Delete Schedule
6. Credential
└─ 6.1 Generate PIN Code
└─ 6.2 Enroll NFC Card
└─ 6.3 Fetch NFC Card Enrollment Status
└─ 6.4 Remove a Session Created for NFC Card Enrollment
└─ 6.7 Fetch NFC Card
└─ 6.8 Fetch All NFC Cards
└─ 6.9 Delete NFC Card
7. Space
└─ 7.1 Fetch Door Group Topology
└─ 7.2 Create Door Group
└─ 7.3 Fetch Door Group
└─ 7.4 Update Door Group
└─ 7.5 Fetch All Door Groups
└─ 7.6 Delete Door Group
└─ 7.7 Fetch Door
└─ 7.8 Fetch All Doors
└─ 7.9 Remote Door Unlocking
└─ 7.10 Set Temporary Door Locking Rule
└─ 7.11 Fetch Door Locking Rule
└─ 7.12 Set Door Emergency Status
└─ 7.13 Fetch Door Emergency Status
8. Device
└─ 8.1 Fetch Devices
9. System Log
└─ 9.2 Fetch System Logs
└─ 9.3 Export System Logs
└─ 9.4 Fetch Resources in System Logs
└─ 9.5 Fetch Static Resources in System Logs
10. UniFi Identity
└─ 10.1 Send UniFi Identity Invitations
└─ 10.2 Fetch Available Resources
└─ 10.3 Assign Resources to Users
└─ 10.4 Fetch Resources Assigned to Users
└─ 10.5 Assign Resources to User Groups
└─ 10.6 Fetch the Resources Assigned to User Groups
11. Notification
└─ 11.1 Fetch Notifications [WebSocket]
└─ 11.2 List of Supported Webhook Events [Webhook]
└─ 11.3 Fetch Webhook Endpoints List [Webhook]
└─ 11.4 Add Webhook Endpoints [Webhook]
└─ 11.5 Update Webhook Endpoints [Webhook]
└─ 11.6 Delete Webhook Endpoints [Webhook]
12. API Server
└─ 12.1 Upload HTTPS Certificate
└─ 12.2 Delete HTTPS Certificate