Revoke Keys in Subproject

By default revokes all Keys in a Subproject. Use query parameters to filter what Keys to revoke.

  • Use the appUserId parameter to revoke all Keys for a specific App User.
  • Use the lockId parameter to revoke all Keys for a specific Lock.

Note:

  • The endpoint will not revoke Access Group Keys. These can only be removed by removing users/locks from the relevant Access Groups using the Update Access Group Accesses endpoint.
  • The endpoint will not revoke Keys shared by App Users. These can only be removed by using the Revoke Shared Keys endpoint.
Required Scopeproject.admin
Required Modulesubproject
Path Params
string
required

ID of the Subproject.

Query Params
string

ID of the user. E.164 formatted mobile phone number you want to filter for.

string

ID of the Lock you want for filter for.

boolean

Should notify Key invitee that Key is revoked. Defaults to true.

Responses

Language
Credentials
Bearer
JWT
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json