Interface Credentials

interface Credentials {
    apiKey?: string;
    authCode?: string;
    code?: string;
    codeVerifier?: string;
    guestRegistrationToken?: string;
    jwtToken?: string;
    oauthConfig?: Config;
    password?: string;
    publicOnly?: boolean;
    secret?: string;
    session?: IRevSessionState;
    username?: string;
    webcastId?: string;
}

Hierarchy (View Summary)

API Key Login

apiKey? secret?

Custom Login

publicOnly? session?

Guest Login

guestRegistrationToken? webcastId?

JWT Login

jwtToken?

OAuth Login

authCode? code? codeVerifier? oauthConfig?

Username Login

password? username?

API Key Login

OptionalapiKey

apiKey?: string

API Key forRev User (for login) - this or username must be specified

Optionalsecret

secret?: string

API Secret for Rev User (for login) - this or password must be specified

Custom Login

OptionalpublicOnly

publicOnly?: boolean

use public APIs only - no authentication

Optionalsession

session?: IRevSessionState

existing token/extend session details

Guest Login

OptionalguestRegistrationToken

guestRegistrationToken?: string

Webcast Guest Registration

OptionalwebcastId

webcastId?: string

Webcast ID for Guest Registration

JWT Login

OptionaljwtToken

jwtToken?: string

JWT Token

OAuth Login

OptionalauthCode

authCode?: string

authCode from deprecated legacy oauth authorization flow

Deprecated

Optionalcode

code?: string

code from oauth2 authorization flow

OptionalcodeVerifier

codeVerifier?: string

code verifier from oauth2 authorization flow

OptionaloauthConfig

oauthConfig?: Config

oauth configuration values for oauth token management

Username Login

Optionalpassword

password?: string

Password of Rev User (for login) - this or secret must be specified

Optionalusername

username?: string

Username of Rev User (for login) - this or apiKey must be specified

Settings

Member Visibility

On This Page

API Key Login
Custom Login
Guest Login
JWT Login
OAuth Login
Username Login