twitter-api-client/dist/interfaces/params/AuthenticationParams.d.ts

Node.js / JavaScript client for Twitter API

export interface OauthAuthenticateParams {
    /**
    * Forces the user to enter their credentials to ensure the correct users account is authorized.
    */
    'force_login'?: boolean;
    /**
    * Prefills the username input box of the OAuth login screen with the given value.
    */
    'screen_name'?: string;
}
export interface OauthAuthorizeParams {
    /**
    * Forces the user to enter their credentials to ensure the correct users account is authorized.
    */
    'force_login'?: boolean;
    /**
    * Prefills the username input box of the OAuth login screen with the given value.
    */
    'screen_name'?: string;
}
export interface OauthAccessTokenParams {
    /**
    * If using the OAuth web-flow, set this parameter to the value of the oauth_verifier
  returned in the callback URL. If you are using out-of-band OAuth, set this value to the pin-code.
  For OAuth 1.0a compliance this parameter is required. OAuth 1.0a is strictly enforced
  and applications not using the oauth_verifier will fail to complete the OAuth flow.
  
    */
    'oauth_verifier'?: string;
}
export interface OauthInvalidateTokenParams {
    /**
    * The access_token of user to be invalidated
    */
    'access_token': string;
    /**
    * The access_token_secret of user to be invalidated
    */
    'access_token_secret': string;
}
export interface Oauth2InvalidateTokenParams {
    /**
    * The value of the bearer token to revoke
    */
    'access_token': string;
}
export interface OauthRequestTokenParams {
    /**
    * For OAuth 1.0a compliance this parameter is required.
  The value you specify here will be used as the URL a user is redirected to should they approve
  your application's access to their account. Set this to oob for out-of-band pin mode.
  This is also how you specify custom callbacks for use in desktop/mobile applications.
  Always send an oauth_callback on this step, regardless of a pre-registered callback.
  We require that any callback URL used with this endpoint will have to be
  whitelisted within the app settings on developer.twitter.com*
  
    */
    'oauth_callback'?: string;
    /**
    * Overrides the access level an application requests to a users account.
  Supported values are read or write. This parameter is intended to allow a developer to
  register a read/write application but also request read only access when appropriate.
  
    */
    'x_auth_access_type'?: string;
}
export interface Oauth2TokenParams {
    /**
    * Specifies the type of grant being requested by the application.
  At this time, only client_credentials is allowed. See Application-Only Authentication
  for more information.
  
    */
    'grant_type': string;
}