Type alias UserHandle

UserHandle: {
    id: string;
} | {
    appLoginToken: string;
}

User handle can be used by many API calls that relate to a specific user.

If the user handle does not contain an id, it is inferred by verifying the login token.

This avoids having to make multiple requests to obtain user information.

IMPORTANT: Generally, a user handle may be set by the requester and should not be trusted until verified.

Passing an unverified UserHandle to any API call will automatically attempt to verify it and raise an authentication error if invalid.

See

UserToken for an authenticated UserHandle.

Generated using TypeDoc