IRefreshableCloudCredentials Interface Reference

A wrapper on CloudCredentials which allows for automatically or manually refreshing the credentials using its refresh token. More...

Inheritance diagram for IRefreshableCloudCredentials:

Public Member Functions
CloudCredentials	Get ()
	Gets the current cloud credentials.
Task	Refresh (CancellationToken cancellationToken)
	Refreshes credentials using the OIDC token endpoint.
Task	RefreshIfExpiring (CancellationToken cancellationToken)
	Refreshes credentials using the OIDC token endpoint if the token is expired or will soon.

Detailed Description

A wrapper on CloudCredentials which allows for automatically or manually refreshing the credentials using its refresh token.

Member Function Documentation

Get()

CloudCredentials Get

(

)

Gets the current cloud credentials.

Implemented in RefreshableCloudCredentials.

Refresh()

Task Refresh

(

CancellationToken

cancellationToken

)

Refreshes credentials using the OIDC token endpoint.

Exceptions

ArgumentException	Thrown if the current credentials don't have a valid refresh token.
InvalidOperationException	Thrown if the token refresh request failed.
JsonException	Thrown if the token refresh request content could not be deserialized.

Implemented in RefreshableCloudCredentials.

RefreshIfExpiring()

Task RefreshIfExpiring

(

CancellationToken

cancellationToken

)

Refreshes credentials using the OIDC token endpoint if the token is expired or will soon.

Exceptions

ArgumentException	Thrown if the current credentials don't have a valid refresh token.
InvalidOperationException	Thrown if the token refresh request failed.
JsonException	Thrown if the token refresh request content could not be deserialized.

Implemented in RefreshableCloudCredentials.

---

The documentation for this interface was generated from the following file:

• Runtime/Cloud/Auth/RefreshableCloudCredentials.cs