Interface User

User object that can be passed to tracer.setUser().

interface User {
    email?: string;
    id: string;
    name?: string;
    role?: string;
    scope?: string;
    session_id?: string;
    [key: string]: string | undefined;
}

Indexable

[key: string]: string | undefined

Custom fields to attach to the user (RBAC, Oauth, etc…).

Properties

email? id name? role? scope? session_id?

Properties

Optional email

email?: string

Email of the user.

id

id: string

Unique identifier of the user. Mandatory.

Optional name

name?: string

User-friendly name of the user.

Optional role

role?: string

Role the user is making the request under.

Optional scope

scope?: string

Scopes or granted authorizations the user currently possesses. The value could come from the scope associated with an OAuth2 Access Token or an attribute value in a SAML 2 Assertion.

Optional session_id

session_id?: string

Session ID of the user.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc