Revoke Keys

By default revokes all Keys in a Project. 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.
  • Use excludeSubprojectKeys to avoid revoking Keys from Subprojects.

Note:

Required Scopeproject.admin
Required ModulemobileKey
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

ID of the Project. Must match the one in the JWT.

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 the API call exclude subproject Keys. Defaults to false.

boolean

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

Responses

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