Google.Apis.Auth.PlatformServices.xml
|
<?xml version="1.0"?>
<doc> <assembly> <name>Google.Apis.Auth.PlatformServices</name> </assembly> <members> <member name="T:Google.Apis.Auth.OAuth2.GoogleWebAuthorizationBroker"> <summary>A helper utility to manage the authorization code flow.</summary> </member> <member name="F:Google.Apis.Auth.OAuth2.GoogleWebAuthorizationBroker.Folder"> <summary>The folder which is used by the <see cref="T:Google.Apis.Util.Store.FileDataStore"/>.</summary> <remarks> The reason that this is not 'private const' is that a user can change it and store the credentials in a different location. </remarks> </member> <member name="M:Google.Apis.Auth.OAuth2.GoogleWebAuthorizationBroker.AuthorizeAsync(Google.Apis.Auth.OAuth2.ClientSecrets,System.Collections.Generic.IEnumerable{System.String},System.String,System.Threading.CancellationToken,Google.Apis.Util.Store.IDataStore,Google.Apis.Auth.OAuth2.ICodeReceiver)"> <summary>Asynchronously authorizes the specified user.</summary> <remarks> In case no data store is specified, <see cref="T:Google.Apis.Util.Store.FileDataStore"/> will be used by default. </remarks> <param name="clientSecrets">The client secrets.</param> <param name="scopes"> The scopes which indicate the Google API access your application is requesting. </param> <param name="user">The user to authorize.</param> <param name="taskCancellationToken">Cancellation token to cancel an operation.</param> <param name="dataStore">The data store, if not specified a file data store will be used.</param> <param name="codeReceiver">The code receiver, if not specified a local server code receiver will be used.</param> <returns>User credential.</returns> </member> <member name="M:Google.Apis.Auth.OAuth2.GoogleWebAuthorizationBroker.AuthorizeAsync(System.IO.Stream,System.Collections.Generic.IEnumerable{System.String},System.String,System.Threading.CancellationToken,Google.Apis.Util.Store.IDataStore,Google.Apis.Auth.OAuth2.ICodeReceiver)"> <summary>Asynchronously authorizes the specified user.</summary> <remarks> In case no data store is specified, <see cref="T:Google.Apis.Util.Store.FileDataStore"/> will be used by default. </remarks> <param name="clientSecretsStream"> The client secrets stream. The authorization code flow constructor is responsible for disposing the stream. </param> <param name="scopes"> The scopes which indicate the Google API access your application is requesting. </param> <param name="user">The user to authorize.</param> <param name="taskCancellationToken">Cancellation token to cancel an operation.</param> <param name="dataStore">The data store, if not specified a file data store will be used.</param> <param name="codeReceiver">The code receiver, if not specified a local server code receiver will be used.</param> <returns>User credential.</returns> </member> <member name="M:Google.Apis.Auth.OAuth2.GoogleWebAuthorizationBroker.ReauthorizeAsync(Google.Apis.Auth.OAuth2.UserCredential,System.Threading.CancellationToken,Google.Apis.Auth.OAuth2.ICodeReceiver)"> <summary> Asynchronously reauthorizes the user. This method should be called if the users want to authorize after they revoked the token. </summary> <param name="userCredential">The current user credential. Its <see cref="P:Google.Apis.Auth.OAuth2.UserCredential.Token"/> will be updated. </param> <param name="taskCancellationToken">Cancellation token to cancel an operation.</param> <param name="codeReceiver">The code receiver, if not specified a local server code receiver will be used.</param> </member> <member name="M:Google.Apis.Auth.OAuth2.GoogleWebAuthorizationBroker.AuthorizeAsync(Google.Apis.Auth.OAuth2.Flows.GoogleAuthorizationCodeFlow.Initializer,System.Collections.Generic.IEnumerable{System.String},System.String,System.Threading.CancellationToken,Google.Apis.Util.Store.IDataStore,Google.Apis.Auth.OAuth2.ICodeReceiver)"> <summary>The core logic for asynchronously authorizing the specified user.</summary> <param name="initializer">The authorization code initializer.</param> <param name="scopes"> The scopes which indicate the Google API access your application is requesting. </param> <param name="user">The user to authorize.</param> <param name="taskCancellationToken">Cancellation token to cancel an operation.</param> <param name="dataStore">The data store, if not specified a file data store will be used.</param> <param name="codeReceiver">The code receiver, if not specified a local server code receiver will be used.</param> <returns>User credential.</returns> </member> <member name="T:Google.Apis.Auth.OAuth2.LocalServerCodeReceiver"> <summary> OAuth 2.0 verification code receiver that runs a local server on a free port and waits for a call with the authorization verification code. </summary> </member> <member name="F:Google.Apis.Auth.OAuth2.LocalServerCodeReceiver.LoopbackCallback"> <summary>The call back format. Expects one port parameter.</summary> </member> <member name="F:Google.Apis.Auth.OAuth2.LocalServerCodeReceiver.ClosePageResponse"> <summary>Close HTML tag to return the browser so it will close itself.</summary> </member> <member name="M:Google.Apis.Auth.OAuth2.LocalServerCodeReceiver.GetRandomUnusedPort"> <summary>Returns a random, unused port.</summary> </member> <member name="T:Google.Apis.Auth.OAuth2.DefaultCredentialProvider"> <summary> Provides the Application Default Credential from the environment. An instance of this class represents the per-process state used to get and cache the credential and allows overriding the state and environment for testing purposes. </summary> </member> <member name="F:Google.Apis.Auth.OAuth2.DefaultCredentialProvider.CredentialEnvironmentVariable"> <summary> Environment variable override which stores the default application credentials file path. </summary> </member> <member name="F:Google.Apis.Auth.OAuth2.DefaultCredentialProvider.WellKnownCredentialsFile"> <summary>Well known file which stores the default application credentials.</summary> </member> <member name="F:Google.Apis.Auth.OAuth2.DefaultCredentialProvider.AppdataEnvironmentVariable"> <summary>Environment variable which contains the Application Data settings.</summary> </member> <member name="F:Google.Apis.Auth.OAuth2.DefaultCredentialProvider.HomeEnvironmentVariable"> <summary>Environment variable which contains the location of home directory on UNIX systems.</summary> </member> <member name="F:Google.Apis.Auth.OAuth2.DefaultCredentialProvider.CloudSDKConfigDirectoryWindows"> <summary>GCloud configuration directory in Windows, relative to %APPDATA%.</summary> </member> <member name="F:Google.Apis.Auth.OAuth2.DefaultCredentialProvider.HelpPermalink"> <summary>Help link to the application default credentials feature.</summary> </member> <member name="F:Google.Apis.Auth.OAuth2.DefaultCredentialProvider.CloudSDKConfigDirectoryUnix"> <summary>GCloud configuration directory on Linux/Mac, relative to $HOME.</summary> </member> <member name="F:Google.Apis.Auth.OAuth2.DefaultCredentialProvider.cachedCredentialTask"> <summary>Caches result from first call to <c>GetApplicationDefaultCredentialAsync</c> </summary> </member> <member name="M:Google.Apis.Auth.OAuth2.DefaultCredentialProvider.#ctor"> <summary>Constructs a new default credential provider.</summary> </member> <member name="M:Google.Apis.Auth.OAuth2.DefaultCredentialProvider.GetDefaultCredentialAsync"> <summary> Returns the Application Default Credentials. Subsequent invocations return cached value from first invocation. See <see cref="M:Google.Apis.Auth.OAuth2.GoogleCredential.GetApplicationDefaultAsync"/> for details. </summary> </member> <member name="M:Google.Apis.Auth.OAuth2.DefaultCredentialProvider.CreateDefaultCredentialAsync"> <summary>Creates a new default credential.</summary> </member> <member name="M:Google.Apis.Auth.OAuth2.DefaultCredentialProvider.CreateDefaultCredentialFromFile(System.String)"> <summary>Creates a default credential from a JSON file.</summary> </member> <member name="M:Google.Apis.Auth.OAuth2.DefaultCredentialProvider.CreateDefaultCredentialFromStream(System.IO.Stream)"> <summary>Creates a default credential from a stream that contains JSON credential data.</summary> </member> <member name="M:Google.Apis.Auth.OAuth2.DefaultCredentialProvider.CreateDefaultCredentialFromJson(Google.Apis.Auth.OAuth2.JsonCredentialParameters)"> <summary>Creates a default credential from JSON data.</summary> </member> <member name="M:Google.Apis.Auth.OAuth2.DefaultCredentialProvider.CreateUserCredentialFromJson(Google.Apis.Auth.OAuth2.JsonCredentialParameters)"> <summary>Creates a user credential from JSON data.</summary> </member> <member name="M:Google.Apis.Auth.OAuth2.DefaultCredentialProvider.CreateServiceAccountCredentialFromJson(Google.Apis.Auth.OAuth2.JsonCredentialParameters)"> <summary>Creates a <see cref="T:Google.Apis.Auth.OAuth2.ServiceAccountCredential"/> from JSON data.</summary> </member> <member name="M:Google.Apis.Auth.OAuth2.DefaultCredentialProvider.GetWellKnownCredentialFilePath"> <summary> Returns platform-specific well known credential file path. This file is created by <a href="https://cloud.google.com/sdk/gcloud/reference/auth/login">gcloud auth login</a> </summary> </member> <member name="M:Google.Apis.Auth.OAuth2.DefaultCredentialProvider.GetEnvironmentVariable(System.String)"> <summary> Gets the environment variable. This method is protected so it could be overriden for testing purposes only. </summary> </member> <member name="M:Google.Apis.Auth.OAuth2.DefaultCredentialProvider.GetStream(System.String)"> <summary> Opens file as a stream. This method is protected so it could be overriden for testing purposes only. </summary> </member> <member name="T:Google.Apis.Auth.OAuth2.GoogleCredential"> <summary> Credential for authorizing calls using OAuth 2.0. It is a convenience wrapper that allows handling of different types of credentials (like <see cref="T:Google.Apis.Auth.OAuth2.ServiceAccountCredential"/>, <see cref="T:Google.Apis.Auth.OAuth2.ComputeCredential"/> or <see cref="T:Google.Apis.Auth.OAuth2.UserCredential"/>) in a unified way. <para> See <see cref="M:Google.Apis.Auth.OAuth2.GoogleCredential.GetApplicationDefaultAsync"/> for the credential retrieval logic. </para> </summary> </member> <member name="F:Google.Apis.Auth.OAuth2.GoogleCredential.defaultCredentialProvider"> <summary>Provider implements the logic for creating the application default credential.</summary> </member> <member name="F:Google.Apis.Auth.OAuth2.GoogleCredential.credential"> <summary>The underlying credential being wrapped by this object.</summary> </member> <member name="M:Google.Apis.Auth.OAuth2.GoogleCredential.#ctor(Google.Apis.Auth.OAuth2.ICredential)"> <summary>Creates a new <c>GoogleCredential</c>.</summary> </member> <member name="M:Google.Apis.Auth.OAuth2.GoogleCredential.GetApplicationDefaultAsync"> <summary> <para>Returns the Application Default Credentials which are ambient credentials that identify and authorize the whole application.</para> <para>The ambient credentials are determined as following order:</para> <list type="number"> <item> <description> The environment variable GOOGLE_APPLICATION_CREDENTIALS is checked. If this variable is specified, it should point to a file that defines the credentials. The simplest way to get a credential for this purpose is to create a service account using the <a href="https://console.developers.google.com">Google Developers Console</a> in the section APIs & Auth, in the sub-section Credentials. Create a service account or choose an existing one and select Generate new JSON key. Set the environment variable to the path of the JSON file downloaded. </description> </item> <item> <description> If you have installed the Google Cloud SDK on your machine and have run the command <a href="https://cloud.google.com/sdk/gcloud/reference/auth/login">GCloud Auth Login</a>, your identity can be used as a proxy to test code calling APIs from that machine. </description> </item> <item> <description> If you are running in Google Compute Engine production, the built-in service account associated with the virtual machine instance will be used. </description> </item> <item> <description> If all previous steps have failed, <c>InvalidOperationException</c> is thrown. </description> </item> </list> </summary> </member> <member name="M:Google.Apis.Auth.OAuth2.GoogleCredential.FromStream(System.IO.Stream)"> <summary> Loads credential from stream containing JSON credential data. <para> The stream can contain a Service Account key file in JSON format from the Google Developers Console or a stored user credential using the format supported by the Cloud SDK. </para> </summary> </member> <member name="P:Google.Apis.Auth.OAuth2.GoogleCredential.IsCreateScopedRequired"> <summary> <para>Returns <c>true</c> only if this credential type has no scopes by default and requires a call to <see cref="o:CreateScoped"/> before use.</para> <para>Credentials need to have scopes in them before they can be used to access Google services. Some Credential types have scopes built-in, and some don't. This property indicates whether the Credential type has scopes built-in.</para> <list type="number"> <item> <description> <see cref="T:Google.Apis.Auth.OAuth2.ComputeCredential"/> has scopes built-in. Nothing additional is required. </description> </item> <item> <description> <see cref="T:Google.Apis.Auth.OAuth2.UserCredential"/> has scopes built-in, as they were obtained during the consent screen. Nothing additional is required.</description> </item> <item> <description> <see cref="T:Google.Apis.Auth.OAuth2.ServiceAccountCredential"/> does not have scopes built-in by default. Caller should invoke <see cref="o:CreateScoped"/> to add scopes to the credential. </description> </item> </list> </summary> </member> <member name="M:Google.Apis.Auth.OAuth2.GoogleCredential.CreateScoped(System.Collections.Generic.IEnumerable{System.String})"> <summary> If the credential supports scopes, creates a copy with the specified scopes. Otherwise, it returns the same instance. </summary> </member> <member name="M:Google.Apis.Auth.OAuth2.GoogleCredential.CreateScoped(System.String[])"> <summary> If the credential supports scopes, creates a copy with the specified scopes. Otherwise, it returns the same instance. </summary> </member> <member name="P:Google.Apis.Auth.OAuth2.GoogleCredential.UnderlyingCredential"> <summary> Gets the underlying credential instance being wrapped. </summary> </member> <member name="M:Google.Apis.Auth.OAuth2.GoogleCredential.FromCredential(Google.Apis.Auth.OAuth2.ServiceAccountCredential)"> <summary>Creates a <c>GoogleCredential</c> wrapping a <see cref="T:Google.Apis.Auth.OAuth2.ServiceAccountCredential"/>.</summary> </member> <member name="T:Google.Apis.Auth.OAuth2.GoogleCredential.ServiceAccountGoogleCredential"> <summary> Wraps <c>ServiceAccountCredential</c> as <c>GoogleCredential</c>. We need this subclass because wrapping <c>ServiceAccountCredential</c> (unlike other wrapped credential types) requires special handling for <c>IsCreateScopedRequired</c> and <c>CreateScoped</c> members. </summary> </member> <member name="T:Google.Apis.Auth.OAuth2.Pkcs8.Asn1"> <summary> An incomplete ASN.1 decoder, only implements what's required to decode a Service Credential. </summary> </member> <member name="T:Google.Apis.Auth.OAuth2.PromptCodeReceiver"> <summary>OAuth 2.0 verification code receiver that reads the authorization code from the user input.</summary> </member> <member name="T:Google.Apis.Auth.OAuth2.ServiceAccountCredential"> <summary> Google OAuth 2.0 credential for accessing protected resources using an access token. The Google OAuth 2.0 Authorization Server supports server-to-server interactions such as those between a web application and Google Cloud Storage. The requesting application has to prove its own identity to gain access to an API, and an end-user doesn't have to be involved. <para> Take a look in https://developers.google.com/accounts/docs/OAuth2ServiceAccount for more details. </para> <para> Since version 1.9.3, service account credential also supports JSON Web Token access token scenario. In this scenario, instead of sending a signed JWT claim to a token server and exchanging it for an access token, a locally signed JWT claim bound to an appropriate URI is used as an access token directly. See <see cref="M:Google.Apis.Auth.OAuth2.ServiceAccountCredential.GetAccessTokenForRequestAsync(System.String,System.Threading.CancellationToken)"/> for explanation when JWT access token is used and when regular OAuth2 token is used. </para> </summary> </member> <member name="T:Google.Apis.Auth.OAuth2.ServiceAccountCredential.Initializer"> <summary>An initializer class for the service account credential. </summary> </member> <member name="P:Google.Apis.Auth.OAuth2.ServiceAccountCredential.Initializer.Id"> <summary>Gets the service account ID (typically an e-mail address).</summary> </member> <member name="P:Google.Apis.Auth.OAuth2.ServiceAccountCredential.Initializer.User"> <summary> Gets or sets the email address of the user the application is trying to impersonate in the service account flow or <c>null</c>. </summary> </member> <member name="P:Google.Apis.Auth.OAuth2.ServiceAccountCredential.Initializer.Scopes"> <summary>Gets the scopes which indicate API access your application is requesting.</summary> </member> <member name="P:Google.Apis.Auth.OAuth2.ServiceAccountCredential.Initializer.Key"> <summary> Gets or sets the key which is used to sign the request, as specified in https://developers.google.com/accounts/docs/OAuth2ServiceAccount#computingsignature. </summary> </member> <member name="M:Google.Apis.Auth.OAuth2.ServiceAccountCredential.Initializer.#ctor(System.String)"> <summary>Constructs a new initializer using the given id.</summary> </member> <member name="M:Google.Apis.Auth.OAuth2.ServiceAccountCredential.Initializer.#ctor(System.String,System.String)"> <summary>Constructs a new initializer using the given id and the token server URL.</summary> </member> <member name="M:Google.Apis.Auth.OAuth2.ServiceAccountCredential.Initializer.FromPrivateKey(System.String)"> <summary>Extracts the <see cref="P:Google.Apis.Auth.OAuth2.ServiceAccountCredential.Initializer.Key"/> from the given PKCS8 private key.</summary> </member> <member name="M:Google.Apis.Auth.OAuth2.ServiceAccountCredential.Initializer.FromCertificate(System.Security.Cryptography.X509Certificates.X509Certificate2)"> <summary>Extracts a <see cref="P:Google.Apis.Auth.OAuth2.ServiceAccountCredential.Initializer.Key"/> from the given certificate.</summary> </member> <member name="F:Google.Apis.Auth.OAuth2.ServiceAccountCredential.UnixEpoch"> <summary>Unix epoch as a <c>DateTime</c></summary> </member> <member name="P:Google.Apis.Auth.OAuth2.ServiceAccountCredential.Id"> <summary>Gets the service account ID (typically an e-mail address).</summary> </member> <member name="P:Google.Apis.Auth.OAuth2.ServiceAccountCredential.User"> <summary> Gets the email address of the user the application is trying to impersonate in the service account flow or <c>null</c>. </summary> </member> <member name="P:Google.Apis.Auth.OAuth2.ServiceAccountCredential.Scopes"> <summary>Gets the service account scopes.</summary> </member> <member name="P:Google.Apis.Auth.OAuth2.ServiceAccountCredential.Key"> <summary> Gets the key which is used to sign the request, as specified in https://developers.google.com/accounts/docs/OAuth2ServiceAccount#computingsignature. </summary> </member> <member name="P:Google.Apis.Auth.OAuth2.ServiceAccountCredential.HasScopes"> <summary><c>true</c> if this credential has any scopes associated with it.</summary> </member> <member name="M:Google.Apis.Auth.OAuth2.ServiceAccountCredential.#ctor(Google.Apis.Auth.OAuth2.ServiceAccountCredential.Initializer)"> <summary>Constructs a new service account credential using the given initializer.</summary> </member> <member name="M:Google.Apis.Auth.OAuth2.ServiceAccountCredential.FromServiceAccountData(System.IO.Stream)"> <summary> Creates a new <see cref="T:Google.Apis.Auth.OAuth2.ServiceAccountCredential"/> instance from JSON credential data. </summary> <param name="credentialData">The stream from which to read the JSON key data for a service account. Must not be null.</param> <exception cref="T:System.InvalidOperationException"> The <paramref name="credentialData"/> does not contain valid JSON service account key data. </exception> <returns>The credentials parsed from the service account key data.</returns> </member> <member name="M:Google.Apis.Auth.OAuth2.ServiceAccountCredential.RequestAccessTokenAsync(System.Threading.CancellationToken)"> <summary> Requests a new token as specified in https://developers.google.com/accounts/docs/OAuth2ServiceAccount#makingrequest. </summary> <param name="taskCancellationToken">Cancellation token to cancel operation.</param> <returns><c>true</c> if a new token was received successfully.</returns> </member> <member name="M:Google.Apis.Auth.OAuth2.ServiceAccountCredential.GetAccessTokenForRequestAsync(System.String,System.Threading.CancellationToken)"> <summary> Gets an access token to authorize a request. If <paramref name="authUri"/> is set and this credential has no scopes associated with it, a locally signed JWT access token for given <paramref name="authUri"/> is returned. Otherwise, an OAuth2 access token obtained from token server will be returned. A cached token is used if possible and the token is only refreshed once it's close to its expiry. </summary> <param name="authUri">The URI the returned token will grant access to.</param> <param name="cancellationToken">The cancellation token.</param> <returns>The access token.</returns> </member> <member name="M:Google.Apis.Auth.OAuth2.ServiceAccountCredential.CreateJwtAccessToken(System.String)"> <summary> Creates a JWT access token than can be used in request headers instead of an OAuth2 token. This is achieved by signing a special JWT using this service account's private key. <param name="authUri">The URI for which the access token will be valid.</param> </summary> </member> <member name="M:Google.Apis.Auth.OAuth2.ServiceAccountCredential.CreateAssertionFromPayload(Google.Apis.Auth.JsonWebSignature.Payload)"> <summary> Signs JWT token using the private key and returns the serialized assertion. </summary> <param name="payload">the JWT payload to sign.</param> </member> <member name="M:Google.Apis.Auth.OAuth2.ServiceAccountCredential.CreateSignature(System.Byte[])"> <summary> Creates a base64 encoded signature for the SHA-256 hash of the specified data. </summary> <param name="data">The data to hash and sign. Must not be null.</param> <returns>The base-64 encoded signature.</returns> </member> <member name="M:Google.Apis.Auth.OAuth2.ServiceAccountCredential.CreateSerializedHeader"> <summary> Creates a serialized header as specified in https://developers.google.com/accounts/docs/OAuth2ServiceAccount#formingheader. </summary> </member> <member name="M:Google.Apis.Auth.OAuth2.ServiceAccountCredential.CreatePayload"> <summary> Creates a claim set as specified in https://developers.google.com/accounts/docs/OAuth2ServiceAccount#formingclaimset. </summary> </member> <member name="M:Google.Apis.Auth.OAuth2.ServiceAccountCredential.UrlSafeBase64Encode(System.String)"> <summary>Encodes the provided UTF8 string into an URL safe base64 string.</summary> <param name="value">Value to encode.</param> <returns>The URL safe base64 string.</returns> </member> <member name="M:Google.Apis.Auth.OAuth2.ServiceAccountCredential.UrlSafeBase64Encode(System.Byte[])"> <summary>Encodes the byte array into an URL safe base64 string.</summary> <param name="bytes">Byte array to encode.</param> <returns>The URL safe base64 string.</returns> </member> <member name="M:Google.Apis.Auth.OAuth2.ServiceAccountCredential.UrlSafeEncode(System.String)"> <summary>Encodes the base64 string into an URL safe string.</summary> <param name="base64Value">The base64 string to make URL safe.</param> <returns>The URL safe base64 string.</returns> </member> </members> </doc> |