com.oracle.bmc.auth.internal

Interface FederationClient

All Known Implementing Classes:

AbstractFederationClient, FileBasedResourcePrincipalFederationClient, FixedContentResourcePrincipalFederationClient, ResourcePrincipalsFederationClient, ResourcePrincipalsV3FederationClient, ResourcePrincipalV2FederationClient, X509FederationClient

public interface FederationClient

Defines a basic interface for a federation endpoint that provides a security token for authentication.

Method Summary

Modifier and Type	Method and Description
String	getSecurityToken() Gets a security token from the federation endpoint.
String	getStringClaim(String key) Get a claim embedded in the security token.
String	refreshAndGetSecurityToken() Gets a security token from the federation endpoint.

Method Detail

getSecurityToken

String getSecurityToken()

Gets a security token from the federation endpoint. May use a cached token if it judged to still be valid.

Returns:

A security token that can be used to authenticate requests.

refreshAndGetSecurityToken

String refreshAndGetSecurityToken()

Gets a security token from the federation endpoint. This will always retreive a new token from the federation endpoint and does not use a cached token.

Returns:

A security token that can be used to authenticate requests.

getStringClaim

String getStringClaim(String key)

Get a claim embedded in the security token. May use the cached token if it is judged to still be valid.