Apex Reference Guide

Apex Reference Guide
Release Notes
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
AuthConfiguration Class
AuthProviderCallbackState Class
AuthProviderPlugin Interface
AuthProviderPluginClass Class
AuthProviderTokenResponse Class
AuthProviderTokenResponse Constructors
AuthProviderTokenResponse Properties
AuthToken Class
CommunitiesUtil Class
ConfigurableSelfRegHandler Interface
ConfirmUserRegistrationHandler Interface
ConnectedAppPlugin Class
CustomOneTimePasswordDeliveryHandler Interface
CustomOneTimePasswordDeliveryResult Enum
ExternalClientAppOauthHandler Class
GeneratedUserData Class
HeadlessSelfRegistrationHandler Interface
HeadlessUserDiscoveryHandler Interface
HeadlessUserDiscoveryResponse Class
HttpCalloutMockUtil Class
IntegratingAppType Enum
InvocationContext Enum
JsonValueOutput Class
JWS Class
JWT Class
JWTBearerTokenExchange Class
JWTUtil Class
LightningLoginEligibility Enum
LoginDiscoveryHandler Interface
LoginDiscoveryMethod Enum
MyDomainLoginDiscoveryHandler Interface
Oauth2TokenExchangeHandler Class
OAuth2TokenExchangeType Enum
OAuthRefreshResult Class
OauthToken Class
OauthTokenType Enum
RegistrationHandler Interface
SamlJitHandler Interface
SessionManagement Class
SessionLevel Enum
TokenValidationResult Class
UserData Class
VerificationAction Enum
VerificationMethod Enum
VerificationPolicy Enum
VerificationResult Class
Auth Exceptions
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommerceBuyGrp Namespace
CommerceExtension Namespace
CommerceOrders Namespace
CommercePayments Namespace
CommerceTax Namespace
ComplianceMgmt Namespace
Compression Namespace
ConnectApi Namespace
Context Namespace
Database Namespace
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
embeddedai Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
Flowtesting Namespace
flowuiruntime Namespace
FormulaEval Namespace
fsccashflow Namespace
Functions Namespace
ise_bots_apex Namespace
IssueCreditMemo Namespace
ind_mfg_sample_mgmt_apex Namespace
industriesNlpSvc
IndustriesDigitalLending Namespace
Invocable Namespace
InvoiceWriteOff Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
PlaceQuote Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
renew_assets_summary Namespace
Reports Namespace
RevSignaling Namespace
RevSalesTrxn Namespace
RichMessaging Namespace
RulesAppln Namespace
runtime_industries_cpq Namespace
runtime_industries_insurance Namespace
Schema Namespace
Search Namespace
setup_flow_performance Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Sfdc_Enablement Namespace
sfdc_surveys Namespace
sfdw Namespace
sfsqlquery Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

AuthProviderTokenResponse Class

Stores the response from the AuthProviderPlugin.handleCallback method.

Namespace

Auth

AuthProviderTokenResponse Constructors

The following are constructors for AuthProviderTokenResponse.

AuthProviderTokenResponse(provider, oauthToken, oauthSecretOrRefreshToken, state)

Creates an instance of the AuthProviderTokenResponse class for a custom authentication provider plug-in using the specified arguments.

Signature

public AuthProviderTokenResponse(String provider, String oauthToken, String oauthSecretOrRefreshToken, String state)

Parameters

  • provider:

    Type: String

    The custom authentication provider.

  • oauthToken:

    Type: String

    The OAuth access token.

  • oauthSecretOrRefreshToken:

    Type: String

    The OAuth secret or refresh token for the currently logged-in user.

  • state:

    Type: String

    The state passed in to initiate the authentication request for the user.

AuthProviderTokenResponse(provider, oauthToken, oauthSecretOrRefreshToken, state, idToken)

Creates an instance of the AuthProviderTokenResponse class for a custom authentication provider plug-in using the specified arguments. This constructor includes a parameter for the ID token.

Signature

public AuthProviderTokenResponse(String provider, String oauthToken, String oauthSecretOrRefreshToken, String state, String idToken)

Parameters

  • provider: Type: String The custom authentication provider.
  • oauthToken: Type: String The OAuth access token.
  • oauthSecretOrRefreshToken: Type: String The OAuth secret or refresh token for the currently logged-in user.
  • state: Type: String The state passed in to initiate the authentication request for the user.
  • idToken: Type: String The ID token in encoded JWT format.

AuthProviderTokenResponse Properties

The following are properties for AuthProviderTokenResponse.

oauthSecretOrRefreshToken

The OAuth secret or refresh token for the currently logged-in user.

Signature

public String oauthSecretOrRefreshToken {get; set;}

Property Value

Type: String

oauthToken

The OAuth access token.

Signature

public String oauthToken {get; set;}

Property Value

Type: String

provider

The authentication provider.

Signature

public String provider {get; set;}

Property Value

Type: String

state

The state passed in to initiate the authentication request for the user.

Signature

public String state {get; set;}

Property Value

Type: String

idToken

The ID token from the third party in encoded JWT format.

Signature

public String idToken {get; set;}

Property Value

Type: String