API Reference
API ReferenceGuides

Create Access Group

post
https://api.unloc.app/v2/projects//access-groups

Creates a new Access Group for this Project. Adding Users and Locks to this Access Group will result in a Key for each combination of User and Lock.

Note:

  • An Access Group can at most have 100 000 access, meaning the product of the number of App Users and Locks cannot exceed 100 000.
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.

Body Params
string
required
length between 4 and 128

The name of this Access Group.

lockIds
array of strings
required

A list of Lock IDs to associate with this Access Group.

lockIds*
appUserIds
array of strings
required

A list of App User IDs to associate with this Access Group.

appUserIds*
string
length between 4 and 1024

The description of this Access Group.

recurrence
object

Days of the week when Keys created for this Access Group will be usable.

string

Whether users should be allowed to share keys to the locks in this Access Group. Not allowed in combination with recurrence

metadata
object

Additional custom data linked to this entity presented in a key–value pairs format. Use this to store additional data that is not part of the core data model. Up to 20 key–value pairs are supported. Each key's length can be up to 40 characters long, and each value's maximum length is 256. Metadata Keys with the prefix unloc is reserved, and can be overwritten by the system.

Responses

Updated 29 days ago

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

Updated 29 days ago