com.google.api

Interface AuthProviderOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

AuthProvider, AuthProvider.Builder

public interface AuthProviderOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAudiences() The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
ByteString	getAudiencesBytes() The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
java.lang.String	getAuthorizationUrl() Redirect URL if JWT token is required but not present or is expired.
ByteString	getAuthorizationUrlBytes() Redirect URL if JWT token is required but not present or is expired.
java.lang.String	getId() The unique identifier of the auth provider.
ByteString	getIdBytes() The unique identifier of the auth provider.
java.lang.String	getIssuer() Identifies the principal that issued the JWT.
ByteString	getIssuerBytes() Identifies the principal that issued the JWT.
java.lang.String	getJwksUri() URL of the provider's public key set to validate signature of the JWT.
ByteString	getJwksUriBytes() URL of the provider's public key set to validate signature of the JWT.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getId

java.lang.String getId()

 The unique identifier of the auth provider. It will be referred to by
 `AuthRequirement.provider_id`.
 Example: "bookstore_auth".
 

string id = 1;

getIdBytes

ByteString getIdBytes()

 The unique identifier of the auth provider. It will be referred to by
 `AuthRequirement.provider_id`.
 Example: "bookstore_auth".
 

string id = 1;

getIssuer

java.lang.String getIssuer()

 Identifies the principal that issued the JWT. See
 https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1
 Usually a URL or an email address.
 Example: https://securetoken.google.com
 Example: 1234567-compute@developer.gserviceaccount.com
 

string issuer = 2;

getIssuerBytes

ByteString getIssuerBytes()

 Identifies the principal that issued the JWT. See
 https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1
 Usually a URL or an email address.
 Example: https://securetoken.google.com
 Example: 1234567-compute@developer.gserviceaccount.com
 

string issuer = 2;

getJwksUri

java.lang.String getJwksUri()

 URL of the provider's public key set to validate signature of the JWT. See
 [OpenID
 Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).
 Optional if the key set document:
  - can be retrieved from
    [OpenID
    Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of
    the issuer.
  - can be inferred from the email domain of the issuer (e.g. a Google
  service account).
 Example: https://www.googleapis.com/oauth2/v1/certs
 

string jwks_uri = 3;

getJwksUriBytes

ByteString getJwksUriBytes()

 URL of the provider's public key set to validate signature of the JWT. See
 [OpenID
 Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).
 Optional if the key set document:
  - can be retrieved from
    [OpenID
    Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html of
    the issuer.
  - can be inferred from the email domain of the issuer (e.g. a Google
  service account).
 Example: https://www.googleapis.com/oauth2/v1/certs
 

string jwks_uri = 3;

getAudiences

java.lang.String getAudiences()

 The list of JWT
 [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
 that are allowed to access. A JWT containing any of these audiences will
 be accepted. When this setting is absent, only JWTs with audience
 "https://[Service_name][google.api.Service.name]/[API_name][google.protobuf.Api.name]"
 will be accepted. For example, if no audiences are in the setting,
 LibraryService API will only accept JWTs with the following audience
 "https://library-example.googleapis.com/google.example.library.v1.LibraryService".
 Example:
     audiences: bookstore_android.apps.googleusercontent.com,
                bookstore_web.apps.googleusercontent.com
 

string audiences = 4;

getAudiencesBytes

ByteString getAudiencesBytes()

 The list of JWT
 [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
 that are allowed to access. A JWT containing any of these audiences will
 be accepted. When this setting is absent, only JWTs with audience
 "https://[Service_name][google.api.Service.name]/[API_name][google.protobuf.Api.name]"
 will be accepted. For example, if no audiences are in the setting,
 LibraryService API will only accept JWTs with the following audience
 "https://library-example.googleapis.com/google.example.library.v1.LibraryService".
 Example:
     audiences: bookstore_android.apps.googleusercontent.com,
                bookstore_web.apps.googleusercontent.com
 

string audiences = 4;

getAuthorizationUrl

java.lang.String getAuthorizationUrl()

 Redirect URL if JWT token is required but not present or is expired.
 Implement authorizationUrl of securityDefinitions in OpenAPI spec.
 

string authorization_url = 5;

getAuthorizationUrlBytes

ByteString getAuthorizationUrlBytes()

 Redirect URL if JWT token is required but not present or is expired.
 Implement authorizationUrl of securityDefinitions in OpenAPI spec.
 

string authorization_url = 5;