SalesforceSDK/com.salesforce.androidsdk.auth/OAuth2/refreshAuthToken

refreshAuthToken

open fun refreshAuthToken(httpAccessor: HttpAccess, loginServer: URI, clientId: String, refreshToken: String, addlParams: Map<String, String>): OAuth2.TokenEndpointResponse

Gets a new auth token using the refresh token.

Return

Token response.

Parameters

httpAccessor

HttpAccess instance.

loginServer

Login server.

clientId

Client ID.

refreshToken

Refresh token.

addlParams

Additional parameters.

Throws

open fun refreshAuthToken(httpAccessor: HttpAccess, loginServer: URI, clientId: String, refreshToken: String, addlParams: Map<String, String>, @Nullable credentialsIdentifier: String): OAuth2.TokenEndpointResponse

Gets a new auth token using the refresh token. Overload that accepts a credentials identifier so DPoP proof can be attached when enabled. Delegates to the fully-parameterized overload with a null token type.

Return

Token response.

Parameters

httpAccessor

HttpAccess instance.

loginServer

Login server.

clientId

Client ID.

refreshToken

Refresh token.

addlParams

Additional parameters.

credentialsIdentifier

Identifier used to look up the DPoP keypair, or null.

Throws

open fun refreshAuthToken(httpAccessor: HttpAccess, loginServer: URI, clientId: String, refreshToken: String, addlParams: Map<String, String>, @Nullable credentialsIdentifier: String, @Nullable tokenType: String): OAuth2.TokenEndpointResponse

Gets a new auth token using the refresh token. Fully-parameterized overload that accepts the credential's persisted token type. When the credential is DPoP-bound the refresh request carries a DPoP proof — independent of the global isUseDPoP switch, which only gates new logins.

Return

Token response.

Parameters

httpAccessor

HttpAccess instance.

loginServer

Login server.

clientId

Client ID.

refreshToken

Refresh token.

addlParams

Additional parameters.

credentialsIdentifier

Identifier used to look up the DPoP keypair, or null.

tokenType

Token type persisted on the credential (e.g. "DPoP" or null / "Bearer").

Throws