getAuthorizationUrl

open fun getAuthorizationUrl(useWebServerAuthentication: Boolean, useHybridAuthentication: Boolean, loginServer: URI, clientId: String, callbackUrl: String, scopes: Array<String>, displayType: String, codeChallenge: String, addlParams: Map<String, String>): URI

Builds the URL to the authorization web page for this login server. You need not provide the 'refresh_token' scope, as it is provided automatically.

This overload defaults `loginHint` to null and does not enable Salesforce Welcome Login hint.

Return

A URL to start the OAuth flow in a web browser/view.

Parameters

useWebServerAuthentication

True to use web server flow, False to use user agent flow

useHybridAuthentication

True to use "hybrid" flow

loginServer

Base protocol and server to use (e.g. https://login.salesforce.com).

clientId

OAuth client ID.

callbackUrl

OAuth callback URL or redirect URL.

scopes

A list of OAuth scopes to request (e.g. {"visualforce", "api"}). If null, the default OAuth scope is provided.

displayType

OAuth display type. If null, the default of 'touch' is used.

codeChallenge

Code challenge to use when using web server flow

addlParams

Any additional parameters to add to the authorization request.

See also

<a href="https://help.salesforce.com/apex/HTViewHelpDoc?language=en&id=remoteaccess_oauth_scopes.htm">RemoteAccess OAuth Scopes</a>

open fun getAuthorizationUrl(useWebServerAuthentication: Boolean, useHybridAuthentication: Boolean, loginServer: URI, clientId: String, callbackUrl: String, scopes: Array<String>, loginHint: String, displayType: String, codeChallenge: String, addlParams: Map<String, String>): URI

Builds the URL to the authorization web page for this login server. You need not provide the 'refresh_token' scope, as it is provided automatically.

Return

A URL to start the OAuth flow in a web browser/view.

Parameters

useWebServerAuthentication

True to use web server flow, False to use user agent flow

useHybridAuthentication

True to use "hybrid" flow

loginServer

Base protocol and server to use (e.g. https://login.salesforce.com).

clientId

OAuth client ID.

callbackUrl

OAuth callback URL or redirect URL.

scopes

A list of OAuth scopes to request (e.g. {"visualforce", "api"}). If null, the default OAuth scope is provided.

loginHint

When applicable, the Salesforce Welcome Login hint

displayType

OAuth display type. If null, the default of 'touch' is used.

codeChallenge

Code challenge to use when using web server flow

addlParams

Any additional parameters to add to the authorization request.

See also

<a href="https://help.salesforce.com/apex/HTViewHelpDoc?language=en&id=remoteaccess_oauth_scopes.htm">RemoteAccess OAuth Scopes</a>