Any property with the prefix "alias" indicates that this property can be used for searching or removing access without the need to keep track of IDs generated in Parakey.

Using Alias Id on Keys (Access)

With Alias Id, you can handle access without the need to save Parakey Access Id in your database. Instead, you can use your own Id and configure this in Parakey and we will handle the mapping between your Id and the Parakey Access Id.

Please note that alias id is optional and you should only use either an alias Id or the Access Id.

Create or update Alias Id

To use alias Id in your API calls, you need to enter the Alias Id in the Parakey web portal. This should represent a unique identifier in your system, for example, a room id.

1. When creating a new key or find the key you want to update and press "Change settings". 
2. From the settings screen make sure "Allow API integration" is active
3. Press "+ Show optional settings" to view all Key settings.
4. Enter an alias Id
   We always recommend using a prefix for you alias id, since the id has to be unique within the Parakey system. For example prefix with your company name.

To use the alias id, simply use this instead of the Access Id.

{
 "insert": [{
   "access": { "aliasId": "Parakey-123ABC" },
   "user": { "email": "emil@parakey.co" }
 }
} 

Use Alias Tag on the individual AccessKey

You can also assign each AccessKey with an alias tag. This is different from the Alias Id and can be used to tag a group of users, for example, by a booking id. This makes it possible to delete all AccessKeys all users with the same booking by using the booking Id.

For example, if you grant access to multiple users with the same alias tag.

{
  "insert": [{
    "access": { "id": "RZglGYR2Je" },
    "user": { "email": "emil@parakey.co" },
    "aliasTag": "booking-123"
  },{
   "access": { "id": "RZglGYR2Je" },
   "user": { "email": "erik@parakey.co" },
   "aliasTag": "booking-123"
 }]
}

Then if you want to cancel the booking or event, simply pass the same alias tag and we will remove access from every user with that tag.

{
  "delete": [{
    "aliasTag": "booking-1234"
  }]
}