Comment on page

getUserByID( )

Function to return a user by ID. Can optionally return a user for an organization.
Usage
const { data } = await client.user.getUserByID({
    userID: 'user.1234',
});
​
console.log('User Wallet: ', data?.wallet)
Return Value
{
    data?: {
        id: string;
        clientID: string;
        organizationID?: string;
        wallet: string;
        nickname?: string;
        roles: string[];
        metadata?: ObjectMap;
        createdAt: string;
        updatedAt: string;
    };
    error: ErrorMessage | null;
    headers: Object;
    statusCode: number;
}
Configuration
userID
String that represents a user's ID.
const { data } = await client.user.getUserByID({
    userID: 'user.1234',
});
​
console.log('User Wallet: ', data?.wallet)
organizationID (optional)
String that represents an organization's ID.
const { data } = await client.user.getUserByID({
    userID: 'user.1234',
    organizationID: 'org.abc',
});
​
console.log('User Wallet: ', data?.wallet)

hasRoleWallet( )

getUsers( )

Last modified 10mo ago