Comment on page

hasRole( )

Function to check whether the user has a specific role by a user ID.  If the user does not have that role, the function returns an error.
Usage
const { data } = await client.user.hasRole({
    userID: 'user.1234',
    role: 'Member'
});
​
console.log('HasRole: ', data?.hasRole);
Return Value
{
    data?: {
        hasRole: boolean;
    };
    error: ErrorMessage | null;
    headers: Object;
    statusCode: number;
}
Configuration
userID 
String that represents a users ID.
const { data } = await client.user.hasRole({
    userID: 'user.1234',
    role: 'Member'
});
​
console.log('HasRole: ', data?.hasRole);
role
String that represents a role.
const { data } = await client.user.hasRole({
    userID: 'user.1234',
    role: 'Member'
});
​
console.log('HasRole: ', data?.hasRole);
organizationID (optional)
String that represents an organization's ID.
const { data } = await client.user.hasRole({
    userID: 'user.1234',
    role: 'Member',
    organizationID: 'org.abc',
});
​
console.log('HasRole: ', data?.hasRole);

validateToken( )

hasRoleToken( )

Last modified 10mo ago