com.ibm.cos.v2.identity.spi

Interface Identity

All Known Subinterfaces:

AwsCredentials, AwsCredentialsIdentity, AwsSessionCredentialsIdentity, IBMOAuthCredentials, IBMOAuthIdentity, NoAuthAuthScheme.AnonymousIdentity, S3ExpressSessionCredentials, SdkToken, TokenIdentity

All Known Implementing Classes:

AwsBasicCredentials, AwsSessionCredentials, BasicIBMOAuthCredentials, DefaultAwsCredentialsIdentity, DefaultAwsSessionCredentialsIdentity, DefaultIAMCredentialsIdentity, DefaultS3ExpressSessionCredentials

@ThreadSafe
public interface Identity

Interface to represent who is using the SDK, i.e., the identity of the caller, used for authentication.

Examples include AwsCredentialsIdentity and TokenIdentity.

See Also:

IdentityProvider

Method Summary

Modifier and Type	Method and Description
default Optional<Instant>	expirationTime() The time after which this identity will no longer be valid.
default Optional<String>	providerName() The source that resolved this identity, normally an identity provider.

Method Detail

expirationTime

default Optional<Instant> expirationTime()

The time after which this identity will no longer be valid. If this is empty, an expiration time is not known (but the identity may still expire at some time in the future).

providerName

default Optional<String> providerName()

The source that resolved this identity, normally an identity provider. Note that this string value would be set by an identity provider implementation and is intended to be used for for tracking purposes. Avoid building logic on its value.