Class AuthProvider.Builder (2.7.4)

Version 2.7.4

• 2.48.0 (latest)
• 2.46.0
• 2.45.1
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.1
• 2.38.0
• 2.37.1
• 2.36.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.1
• 2.22.1
• 2.21.1
• 2.15.0
• 2.14.3
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.6
• 2.8.4
• 2.7.4

public static final class AuthProvider.Builder extends GeneratedMessageV3.Builder<AuthProvider.Builder> implements AuthProviderOrBuilder

Configuration for an authentication provider, including support for JSON Web Token (JWT).

Protobuf type google.api.AuthProvider

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > AuthProvider.Builder

Implements

AuthProviderOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream)

AbstractMessage.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

Methods

addAllJwtLocations(Iterable<? extends JwtLocation> values)

public AuthProvider.Builder addAllJwtLocations(Iterable<? extends JwtLocation> values)

Defines the locations to extract the JWT. JWT locations can be either from HTTP headers or URL query parameters. The rule is that the first match wins. The checking order is: checking all headers first, then URL query parameters. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations:

• header: Authorization value_prefix: "Bearer "
• header: x-goog-iap-jwt-assertion
• query: access_token

repeated .google.api.JwtLocation jwt_locations = 6;

Parameter

Name	Description
values	Iterable<? extends com.google.api.JwtLocation>

Returns

Type	Description
AuthProvider.Builder

addJwtLocations(JwtLocation value)

public AuthProvider.Builder addJwtLocations(JwtLocation value)

Defines the locations to extract the JWT. JWT locations can be either from HTTP headers or URL query parameters. The rule is that the first match wins. The checking order is: checking all headers first, then URL query parameters. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations:

• header: Authorization value_prefix: "Bearer "
• header: x-goog-iap-jwt-assertion
• query: access_token

repeated .google.api.JwtLocation jwt_locations = 6;

Parameter

Name	Description
value	JwtLocation

Returns

Type	Description
AuthProvider.Builder

addJwtLocations(JwtLocation.Builder builderForValue)

public AuthProvider.Builder addJwtLocations(JwtLocation.Builder builderForValue)

Defines the locations to extract the JWT. JWT locations can be either from HTTP headers or URL query parameters. The rule is that the first match wins. The checking order is: checking all headers first, then URL query parameters. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations:

• header: Authorization value_prefix: "Bearer "
• header: x-goog-iap-jwt-assertion
• query: access_token

repeated .google.api.JwtLocation jwt_locations = 6;

Parameter

Name	Description
builderForValue	JwtLocation.Builder

Returns

Type	Description
AuthProvider.Builder

addJwtLocations(int index, JwtLocation value)

public AuthProvider.Builder addJwtLocations(int index, JwtLocation value)

Defines the locations to extract the JWT. JWT locations can be either from HTTP headers or URL query parameters. The rule is that the first match wins. The checking order is: checking all headers first, then URL query parameters. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations:

• header: Authorization value_prefix: "Bearer "
• header: x-goog-iap-jwt-assertion
• query: access_token

repeated .google.api.JwtLocation jwt_locations = 6;

Parameters

Name	Description
index	int
value	JwtLocation

Returns

Type	Description
AuthProvider.Builder

addJwtLocations(int index, JwtLocation.Builder builderForValue)

public AuthProvider.Builder addJwtLocations(int index, JwtLocation.Builder builderForValue)

Defines the locations to extract the JWT. JWT locations can be either from HTTP headers or URL query parameters. The rule is that the first match wins. The checking order is: checking all headers first, then URL query parameters. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations:

• header: Authorization value_prefix: "Bearer "
• header: x-goog-iap-jwt-assertion
• query: access_token

repeated .google.api.JwtLocation jwt_locations = 6;

Parameters

Name	Description
index	int
builderForValue	JwtLocation.Builder

Returns

Type	Description
AuthProvider.Builder

addJwtLocationsBuilder()

public JwtLocation.Builder addJwtLocationsBuilder()

Defines the locations to extract the JWT. JWT locations can be either from HTTP headers or URL query parameters. The rule is that the first match wins. The checking order is: checking all headers first, then URL query parameters. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations:

• header: Authorization value_prefix: "Bearer "
• header: x-goog-iap-jwt-assertion
• query: access_token

repeated .google.api.JwtLocation jwt_locations = 6;

Returns

Type	Description
JwtLocation.Builder

addJwtLocationsBuilder(int index)

public JwtLocation.Builder addJwtLocationsBuilder(int index)

Defines the locations to extract the JWT. JWT locations can be either from HTTP headers or URL query parameters. The rule is that the first match wins. The checking order is: checking all headers first, then URL query parameters. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations:

• header: Authorization value_prefix: "Bearer "
• header: x-goog-iap-jwt-assertion
• query: access_token

repeated .google.api.JwtLocation jwt_locations = 6;

Parameter

Name	Description
index	int

Returns

Type	Description
JwtLocation.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AuthProvider.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
AuthProvider.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public AuthProvider build()

Returns

Type	Description
AuthProvider

buildPartial()

public AuthProvider buildPartial()

Returns

Type	Description
AuthProvider

clear()

public AuthProvider.Builder clear()

Returns

Type	Description
AuthProvider.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAudiences()

public AuthProvider.Builder clearAudiences()

The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences:

• "https://[service.name]/[google.protobuf.Api.name]"
• "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService
• https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com

string audiences = 4;

Returns

Type	Description
AuthProvider.Builder	This builder for chaining.

clearAuthorizationUrl()

public AuthProvider.Builder clearAuthorizationUrl()

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

string authorization_url = 5;

Returns

Type	Description
AuthProvider.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public AuthProvider.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	FieldDescriptor

Returns

Type	Description
AuthProvider.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearId()

public AuthProvider.Builder clearId()

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

string id = 1;

Returns

Type	Description
AuthProvider.Builder	This builder for chaining.

clearIssuer()

public AuthProvider.Builder clearIssuer()

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: [e-mail]

string issuer = 2;

Returns

Type	Description
AuthProvider.Builder	This builder for chaining.

clearJwksUri()

public AuthProvider.Builder clearJwksUri()

URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document:

• can be retrieved from OpenID Discovery 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;

Returns

Type	Description
AuthProvider.Builder	This builder for chaining.

clearJwtLocations()

public AuthProvider.Builder clearJwtLocations()

Defines the locations to extract the JWT. JWT locations can be either from HTTP headers or URL query parameters. The rule is that the first match wins. The checking order is: checking all headers first, then URL query parameters. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations:

• header: Authorization value_prefix: "Bearer "
• header: x-goog-iap-jwt-assertion
• query: access_token

repeated .google.api.JwtLocation jwt_locations = 6;

Returns

Type	Description
AuthProvider.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public AuthProvider.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	OneofDescriptor

Returns

Type	Description
AuthProvider.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clone()

public AuthProvider.Builder clone()

Returns

Type	Description
AuthProvider.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getAudiences()

public String getAudiences()

The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences:

• "https://[service.name]/[google.protobuf.Api.name]"
• "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService
• https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com

string audiences = 4;

Returns

Type	Description
String	The audiences.

getAudiencesBytes()

public ByteString getAudiencesBytes()

The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences:

• "https://[service.name]/[google.protobuf.Api.name]"
• "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService
• https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com

string audiences = 4;

Returns

Type	Description
ByteString	The bytes for audiences.

getAuthorizationUrl()

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

Returns

Type	Description
String	The authorizationUrl.

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;

Returns

Type	Description
ByteString	The bytes for authorizationUrl.

getDefaultInstanceForType()

public AuthProvider getDefaultInstanceForType()

Returns

Type	Description
AuthProvider

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getId()

public String getId()

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

string id = 1;

Returns

Type	Description
String	The id.

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;

Returns

Type	Description
ByteString	The bytes for id.

getIssuer()

public 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: [e-mail]

string issuer = 2;

Returns

Type	Description
String	The issuer.

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: [e-mail]

string issuer = 2;

Returns

Type	Description
ByteString	The bytes for issuer.

getJwksUri()

public String getJwksUri()

URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document:

• can be retrieved from OpenID Discovery 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;

Returns

Type	Description
String	The jwksUri.

getJwksUriBytes()

public ByteString getJwksUriBytes()

URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document:

• can be retrieved from OpenID Discovery 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;

Returns

Type	Description
ByteString	The bytes for jwksUri.

getJwtLocations(int index)

public JwtLocation getJwtLocations(int index)

Defines the locations to extract the JWT. JWT locations can be either from HTTP headers or URL query parameters. The rule is that the first match wins. The checking order is: checking all headers first, then URL query parameters. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations:

• header: Authorization value_prefix: "Bearer "
• header: x-goog-iap-jwt-assertion
• query: access_token

repeated .google.api.JwtLocation jwt_locations = 6;

Parameter

Name	Description
index	int

Returns

Type	Description
JwtLocation

getJwtLocationsBuilder(int index)

public JwtLocation.Builder getJwtLocationsBuilder(int index)

Defines the locations to extract the JWT. JWT locations can be either from HTTP headers or URL query parameters. The rule is that the first match wins. The checking order is: checking all headers first, then URL query parameters. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations:

• header: Authorization value_prefix: "Bearer "
• header: x-goog-iap-jwt-assertion
• query: access_token

repeated .google.api.JwtLocation jwt_locations = 6;

Parameter

Name	Description
index	int

Returns

Type	Description
JwtLocation.Builder

getJwtLocationsBuilderList()

public List<JwtLocation.Builder> getJwtLocationsBuilderList()

Defines the locations to extract the JWT. JWT locations can be either from HTTP headers or URL query parameters. The rule is that the first match wins. The checking order is: checking all headers first, then URL query parameters. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations:

• header: Authorization value_prefix: "Bearer "
• header: x-goog-iap-jwt-assertion
• query: access_token

repeated .google.api.JwtLocation jwt_locations = 6;

Returns

Type	Description
List<Builder>

getJwtLocationsCount()

public int getJwtLocationsCount()

Defines the locations to extract the JWT. JWT locations can be either from HTTP headers or URL query parameters. The rule is that the first match wins. The checking order is: checking all headers first, then URL query parameters. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations:

• header: Authorization value_prefix: "Bearer "
• header: x-goog-iap-jwt-assertion
• query: access_token

repeated .google.api.JwtLocation jwt_locations = 6;

Returns

Type	Description
int

getJwtLocationsList()

public List<JwtLocation> getJwtLocationsList()

Defines the locations to extract the JWT. JWT locations can be either from HTTP headers or URL query parameters. The rule is that the first match wins. The checking order is: checking all headers first, then URL query parameters. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations:

• header: Authorization value_prefix: "Bearer "
• header: x-goog-iap-jwt-assertion
• query: access_token

repeated .google.api.JwtLocation jwt_locations = 6;

Returns

Type	Description
List<JwtLocation>

getJwtLocationsOrBuilder(int index)

public JwtLocationOrBuilder getJwtLocationsOrBuilder(int index)

Defines the locations to extract the JWT. JWT locations can be either from HTTP headers or URL query parameters. The rule is that the first match wins. The checking order is: checking all headers first, then URL query parameters. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations:

• header: Authorization value_prefix: "Bearer "
• header: x-goog-iap-jwt-assertion
• query: access_token

repeated .google.api.JwtLocation jwt_locations = 6;

Parameter

Name	Description
index	int

Returns

Type	Description
JwtLocationOrBuilder

getJwtLocationsOrBuilderList()

public List<? extends JwtLocationOrBuilder> getJwtLocationsOrBuilderList()

Defines the locations to extract the JWT. JWT locations can be either from HTTP headers or URL query parameters. The rule is that the first match wins. The checking order is: checking all headers first, then URL query parameters. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations:

• header: Authorization value_prefix: "Bearer "
• header: x-goog-iap-jwt-assertion
• query: access_token

repeated .google.api.JwtLocation jwt_locations = 6;

Returns

Type	Description
List<? extends com.google.api.JwtLocationOrBuilder>

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(AuthProvider other)

public AuthProvider.Builder mergeFrom(AuthProvider other)

Parameter

Name	Description
other	AuthProvider

Returns

Type	Description
AuthProvider.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AuthProvider.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
AuthProvider.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public AuthProvider.Builder mergeFrom(Message other)

Parameter

Name	Description
other	Message

Returns

Type	Description
AuthProvider.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AuthProvider.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
AuthProvider.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeJwtLocations(int index)

public AuthProvider.Builder removeJwtLocations(int index)

Defines the locations to extract the JWT. JWT locations can be either from HTTP headers or URL query parameters. The rule is that the first match wins. The checking order is: checking all headers first, then URL query parameters. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations:

• header: Authorization value_prefix: "Bearer "
• header: x-goog-iap-jwt-assertion
• query: access_token

repeated .google.api.JwtLocation jwt_locations = 6;

Parameter

Name	Description
index	int

Returns

Type	Description
AuthProvider.Builder

setAudiences(String value)

public AuthProvider.Builder setAudiences(String value)

The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences:

• "https://[service.name]/[google.protobuf.Api.name]"
• "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService
• https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com

string audiences = 4;

Parameter

Name	Description
value	String The audiences to set.

Returns

Type	Description
AuthProvider.Builder	This builder for chaining.

setAudiencesBytes(ByteString value)

public AuthProvider.Builder setAudiencesBytes(ByteString value)

The list of JWT audiences. that are allowed to access. A JWT containing any of these audiences will be accepted. When this setting is absent, JWTs with audiences:

• "https://[service.name]/[google.protobuf.Api.name]"
• "https://[service.name]/" will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService
• https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com

string audiences = 4;

Parameter

Name	Description
value	ByteString The bytes for audiences to set.

Returns

Type	Description
AuthProvider.Builder	This builder for chaining.

setAuthorizationUrl(String value)

public AuthProvider.Builder setAuthorizationUrl(String value)

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

string authorization_url = 5;

Parameter

Name	Description
value	String The authorizationUrl to set.

Returns

Type	Description
AuthProvider.Builder	This builder for chaining.

setAuthorizationUrlBytes(ByteString value)

public AuthProvider.Builder setAuthorizationUrlBytes(ByteString value)

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

string authorization_url = 5;

Parameter

Name	Description
value	ByteString The bytes for authorizationUrl to set.

Returns

Type	Description
AuthProvider.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public AuthProvider.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	FieldDescriptor
value	Object

Returns

Type	Description
AuthProvider.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setId(String value)

public AuthProvider.Builder setId(String value)

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

string id = 1;

Parameter

Name	Description
value	String The id to set.

Returns

Type	Description
AuthProvider.Builder	This builder for chaining.

setIdBytes(ByteString value)

public AuthProvider.Builder setIdBytes(ByteString value)

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

string id = 1;

Parameter

Name	Description
value	ByteString The bytes for id to set.

Returns

Type	Description
AuthProvider.Builder	This builder for chaining.

setIssuer(String value)

public AuthProvider.Builder setIssuer(String value)

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: [e-mail]

string issuer = 2;

Parameter

Name	Description
value	String The issuer to set.

Returns

Type	Description
AuthProvider.Builder	This builder for chaining.

setIssuerBytes(ByteString value)

public AuthProvider.Builder setIssuerBytes(ByteString value)

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: [e-mail]

string issuer = 2;

Parameter

Name	Description
value	ByteString The bytes for issuer to set.

Returns

Type	Description
AuthProvider.Builder	This builder for chaining.

setJwksUri(String value)

public AuthProvider.Builder setJwksUri(String value)

URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document:

• can be retrieved from OpenID Discovery 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;

Parameter

Name	Description
value	String The jwksUri to set.

Returns

Type	Description
AuthProvider.Builder	This builder for chaining.

setJwksUriBytes(ByteString value)

public AuthProvider.Builder setJwksUriBytes(ByteString value)

URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document:

• can be retrieved from OpenID Discovery 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;

Parameter

Name	Description
value	ByteString The bytes for jwksUri to set.

Returns

Type	Description
AuthProvider.Builder	This builder for chaining.

setJwtLocations(int index, JwtLocation value)

public AuthProvider.Builder setJwtLocations(int index, JwtLocation value)

Defines the locations to extract the JWT. JWT locations can be either from HTTP headers or URL query parameters. The rule is that the first match wins. The checking order is: checking all headers first, then URL query parameters. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations:

• header: Authorization value_prefix: "Bearer "
• header: x-goog-iap-jwt-assertion
• query: access_token

repeated .google.api.JwtLocation jwt_locations = 6;

Parameters

Name	Description
index	int
value	JwtLocation

Returns

Type	Description
AuthProvider.Builder

setJwtLocations(int index, JwtLocation.Builder builderForValue)

public AuthProvider.Builder setJwtLocations(int index, JwtLocation.Builder builderForValue)

Defines the locations to extract the JWT. JWT locations can be either from HTTP headers or URL query parameters. The rule is that the first match wins. The checking order is: checking all headers first, then URL query parameters. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations:

• header: Authorization value_prefix: "Bearer "
• header: x-goog-iap-jwt-assertion
• query: access_token

repeated .google.api.JwtLocation jwt_locations = 6;

Parameters

Name	Description
index	int
builderForValue	JwtLocation.Builder

Returns

Type	Description
AuthProvider.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public AuthProvider.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters

Name	Description
field	FieldDescriptor
index	int
value	Object

Returns

Type	Description
AuthProvider.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final AuthProvider.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	UnknownFieldSet

Returns

Type	Description
AuthProvider.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)