Src/Support/Google.Apis.Auth/OAuth2/IOIdCTokenProvider.cs

/*
Copyright 2020 Google Inc

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

using System.Threading;
using System.Threading.Tasks;

namespace Google.Apis.Auth.OAuth2
{
    /// <summary>
    /// Represents an OIDC token provider.
    /// </summary>
    public interface IOidcTokenProvider
    {
        /// <summary>
        /// Returns an OIDC token for the given options.
        /// </summary>
        /// <param name="options">The options to create the token from.</param>
        /// <param name="cancellationToken">The cancellation token that may be used to cancel the request.</param>
        /// <returns>The OIDC token.</returns>
        Task<OidcToken> GetOidcTokenAsync(OidcTokenOptions options, CancellationToken cancellationToken = default);
    }
}