com.google.api

Class AuthProvider

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.api.AuthProvider

All Implemented Interfaces:

AuthProviderOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, java.io.Serializable

public final class AuthProvider
extends GeneratedMessageV3
implements AuthProviderOrBuilder

 Configuration for an authentication provider, including support for
 [JSON Web Token
 (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).
 

Protobuf type google.api.AuthProvider

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuthProvider.Builder Configuration for an authentication provider, including support for [JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable

Field Summary

Fields

Modifier and Type	Field and Description
static int	AUDIENCES_FIELD_NUMBER
static int	AUTHORIZATION_URL_FIELD_NUMBER
static int	ID_FIELD_NUMBER
static int	ISSUER_FIELD_NUMBER
static int	JWKS_URI_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
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.
static AuthProvider	getDefaultInstance()
AuthProvider	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
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.
Parser<AuthProvider>	getParserForType()
int	getSerializedSize()
UnknownFieldSet	getUnknownFields()
int	hashCode()
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static AuthProvider.Builder	newBuilder()
static AuthProvider.Builder	newBuilder(AuthProvider prototype)
AuthProvider.Builder	newBuilderForType()
protected AuthProvider.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
static AuthProvider	parseDelimitedFrom(java.io.InputStream input)
static AuthProvider	parseDelimitedFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static AuthProvider	parseFrom(byte[] data)
static AuthProvider	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static AuthProvider	parseFrom(java.nio.ByteBuffer data)
static AuthProvider	parseFrom(java.nio.ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static AuthProvider	parseFrom(ByteString data)
static AuthProvider	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static AuthProvider	parseFrom(CodedInputStream input)
static AuthProvider	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static AuthProvider	parseFrom(java.io.InputStream input)
static AuthProvider	parseFrom(java.io.InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<AuthProvider>	parser()
AuthProvider.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER

See Also:

Constant Field Values

ISSUER_FIELD_NUMBER

public static final int ISSUER_FIELD_NUMBER

See Also:

Constant Field Values

JWKS_URI_FIELD_NUMBER

public static final int JWKS_URI_FIELD_NUMBER

See Also:

Constant Field Values

AUDIENCES_FIELD_NUMBER

public static final int AUDIENCES_FIELD_NUMBER

See Also:

Constant Field Values

AUTHORIZATION_URL_FIELD_NUMBER

public static final int AUTHORIZATION_URL_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getId

public 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;

Specified by:

getId in interface AuthProviderOrBuilder

getIdBytes

public ByteString getIdBytes()

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

string id = 1;

Specified by:

getIdBytes in interface AuthProviderOrBuilder

getIssuer

public 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;

Specified by:

getIssuer in interface AuthProviderOrBuilder

getIssuerBytes

public 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;

Specified by:

getIssuerBytes in interface AuthProviderOrBuilder

getJwksUri

public 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;

Specified by:

getJwksUri in interface AuthProviderOrBuilder

getJwksUriBytes

public 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;

Specified by:

getJwksUriBytes in interface AuthProviderOrBuilder

getAudiences

public 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;

Specified by:

getAudiences in interface AuthProviderOrBuilder

getAudiencesBytes

public 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;

Specified by:

getAudiencesBytes in interface AuthProviderOrBuilder

getAuthorizationUrl

public 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;

Specified by:

getAuthorizationUrl in interface AuthProviderOrBuilder

getAuthorizationUrlBytes

public 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;

Specified by:

getAuthorizationUrlBytes in interface AuthProviderOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws java.io.IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

java.io.IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(java.lang.Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static AuthProvider parseFrom(java.nio.ByteBuffer data)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static AuthProvider parseFrom(java.nio.ByteBuffer data,
                                     ExtensionRegistryLite extensionRegistry)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static AuthProvider parseFrom(ByteString data)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static AuthProvider parseFrom(ByteString data,
                                     ExtensionRegistryLite extensionRegistry)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static AuthProvider parseFrom(byte[] data)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static AuthProvider parseFrom(byte[] data,
                                     ExtensionRegistryLite extensionRegistry)
                              throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static AuthProvider parseFrom(java.io.InputStream input)
                              throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static AuthProvider parseFrom(java.io.InputStream input,
                                     ExtensionRegistryLite extensionRegistry)
                              throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static AuthProvider parseDelimitedFrom(java.io.InputStream input)
                                       throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static AuthProvider parseDelimitedFrom(java.io.InputStream input,
                                              ExtensionRegistryLite extensionRegistry)
                                       throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static AuthProvider parseFrom(CodedInputStream input)
                              throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static AuthProvider parseFrom(CodedInputStream input,
                                     ExtensionRegistryLite extensionRegistry)
                              throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public AuthProvider.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static AuthProvider.Builder newBuilder()

newBuilder

public static AuthProvider.Builder newBuilder(AuthProvider prototype)

toBuilder

public AuthProvider.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected AuthProvider.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static AuthProvider getDefaultInstance()

parser

public static Parser<AuthProvider> parser()

getParserForType

public Parser<AuthProvider> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public AuthProvider getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder