Skip to content

Auth

Labels_

Organize your users and grant custom permissions for subscriptions or VIP users with labels.

1 min read

Raw

Labels are a good way to categorize a user to grant them access to resources. For example, a subscriber label can be added to a user once they've purchased a subscription.

const sdk = require('node-appwrite');


const client = new sdk.Client()
    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
    .setProject('<PROJECT_ID>')                 // Your project ID
    .setKey('98fd4...a2ad2');                    // Your secret API key


const users = new sdk.Users(client);


const promise = users.updateLabels({
    userId: '<USER_ID>',
    labels: [ 'subscriber' ]
});


promise.then(function (response) {
    console.log(response); // Success
}, function (error) {
    console.log(error); // Failure
});

This would correspond with the permissions below.

DescriptionCode Snippet
ReadPermissions.read(Role.label('subscriber'))
UpdatePermissions.update(Role.label('subscriber'))
DeletePermissions.delete(Role.label('subscriber'))
CreatePermissions.create(Role.label('subscriber'))

Was this page helpful?

Share what worked or what we should fix. Once approved, our agents automatically apply suggested updates to the docs.