Class AuthProvider.Builder (2.37.1)

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllJwtLocations(Iterable<? extends JwtLocation> values)

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

Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension x-google-jwt-locations

JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins.

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
NameDescription
valuesIterable<? extends com.google.api.JwtLocation>
Returns
TypeDescription
AuthProvider.Builder

addJwtLocations(JwtLocation value)

public AuthProvider.Builder addJwtLocations(JwtLocation value)

Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension x-google-jwt-locations

JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins.

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
NameDescription
valueJwtLocation
Returns
TypeDescription
AuthProvider.Builder

addJwtLocations(JwtLocation.Builder builderForValue)

public AuthProvider.Builder addJwtLocations(JwtLocation.Builder builderForValue)

Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension x-google-jwt-locations

JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins.

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
NameDescription
builderForValueJwtLocation.Builder
Returns
TypeDescription
AuthProvider.Builder

addJwtLocations(int index, JwtLocation value)

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

Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension x-google-jwt-locations

JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins.

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
NameDescription
indexint
valueJwtLocation
Returns
TypeDescription
AuthProvider.Builder

addJwtLocations(int index, JwtLocation.Builder builderForValue)

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

Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension x-google-jwt-locations

JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins.

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
NameDescription
indexint
builderForValueJwtLocation.Builder
Returns
TypeDescription
AuthProvider.Builder

addJwtLocationsBuilder()

public JwtLocation.Builder addJwtLocationsBuilder()

Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension x-google-jwt-locations

JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins.

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
TypeDescription
JwtLocation.Builder

addJwtLocationsBuilder(int index)

public JwtLocation.Builder addJwtLocationsBuilder(int index)

Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension x-google-jwt-locations

JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins.

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
NameDescription
indexint
Returns
TypeDescription
JwtLocation.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AuthProvider.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
AuthProvider.Builder
Overrides

build()

public AuthProvider build()
Returns
TypeDescription
AuthProvider

buildPartial()

public AuthProvider buildPartial()
Returns
TypeDescription
AuthProvider

clear()

public AuthProvider.Builder clear()
Returns
TypeDescription
AuthProvider.Builder
Overrides

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:

string audiences = 4;

Returns
TypeDescription
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
TypeDescription
AuthProvider.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public AuthProvider.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
AuthProvider.Builder
Overrides

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
TypeDescription
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: 1234567-compute@developer.gserviceaccount.com

string issuer = 2;

Returns
TypeDescription
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:

string jwks_uri = 3;

Returns
TypeDescription
AuthProvider.Builder

This builder for chaining.

clearJwtLocations()

public AuthProvider.Builder clearJwtLocations()

Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension x-google-jwt-locations

JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins.

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
TypeDescription
AuthProvider.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public AuthProvider.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
AuthProvider.Builder
Overrides

clone()

public AuthProvider.Builder clone()
Returns
TypeDescription
AuthProvider.Builder
Overrides

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:

string audiences = 4;

Returns
TypeDescription
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:

string audiences = 4;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for authorizationUrl.

getDefaultInstanceForType()

public AuthProvider getDefaultInstanceForType()
Returns
TypeDescription
AuthProvider

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
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: 1234567-compute@developer.gserviceaccount.com

string issuer = 2;

Returns
TypeDescription
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: 1234567-compute@developer.gserviceaccount.com

string issuer = 2;

Returns
TypeDescription
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:

string jwks_uri = 3;

Returns
TypeDescription
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:

string jwks_uri = 3;

Returns
TypeDescription
ByteString

The bytes for jwksUri.

getJwtLocations(int index)

public JwtLocation getJwtLocations(int index)

Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension x-google-jwt-locations

JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins.

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
NameDescription
indexint
Returns
TypeDescription
JwtLocation

getJwtLocationsBuilder(int index)

public JwtLocation.Builder getJwtLocationsBuilder(int index)

Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension x-google-jwt-locations

JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins.

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
NameDescription
indexint
Returns
TypeDescription
JwtLocation.Builder

getJwtLocationsBuilderList()

public List<JwtLocation.Builder> getJwtLocationsBuilderList()

Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension x-google-jwt-locations

JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins.

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
TypeDescription
List<Builder>

getJwtLocationsCount()

public int getJwtLocationsCount()

Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension x-google-jwt-locations

JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins.

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
TypeDescription
int

getJwtLocationsList()

public List<JwtLocation> getJwtLocationsList()

Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension x-google-jwt-locations

JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins.

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
TypeDescription
List<JwtLocation>

getJwtLocationsOrBuilder(int index)

public JwtLocationOrBuilder getJwtLocationsOrBuilder(int index)

Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension x-google-jwt-locations

JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins.

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
NameDescription
indexint
Returns
TypeDescription
JwtLocationOrBuilder

getJwtLocationsOrBuilderList()

public List<? extends JwtLocationOrBuilder> getJwtLocationsOrBuilderList()

Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension x-google-jwt-locations

JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins.

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
TypeDescription
List<? extends com.google.api.JwtLocationOrBuilder>

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(AuthProvider other)

public AuthProvider.Builder mergeFrom(AuthProvider other)
Parameter
NameDescription
otherAuthProvider
Returns
TypeDescription
AuthProvider.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AuthProvider.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AuthProvider.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public AuthProvider.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
AuthProvider.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AuthProvider.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
AuthProvider.Builder
Overrides

removeJwtLocations(int index)

public AuthProvider.Builder removeJwtLocations(int index)

Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension x-google-jwt-locations

JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins.

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
NameDescription
indexint
Returns
TypeDescription
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:

string audiences = 4;

Parameter
NameDescription
valueString

The audiences to set.

Returns
TypeDescription
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:

string audiences = 4;

Parameter
NameDescription
valueByteString

The bytes for audiences to set.

Returns
TypeDescription
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
NameDescription
valueString

The authorizationUrl to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for authorizationUrl to set.

Returns
TypeDescription
AuthProvider.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public AuthProvider.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
AuthProvider.Builder
Overrides

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
NameDescription
valueString

The id to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for id to set.

Returns
TypeDescription
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: 1234567-compute@developer.gserviceaccount.com

string issuer = 2;

Parameter
NameDescription
valueString

The issuer to set.

Returns
TypeDescription
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: 1234567-compute@developer.gserviceaccount.com

string issuer = 2;

Parameter
NameDescription
valueByteString

The bytes for issuer to set.

Returns
TypeDescription
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:

string jwks_uri = 3;

Parameter
NameDescription
valueString

The jwksUri to set.

Returns
TypeDescription
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:

string jwks_uri = 3;

Parameter
NameDescription
valueByteString

The bytes for jwksUri to set.

Returns
TypeDescription
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. For now it is only used by the Cloud Endpoints to store the OpenAPI extension x-google-jwt-locations

JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins.

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
NameDescription
indexint
valueJwtLocation
Returns
TypeDescription
AuthProvider.Builder

setJwtLocations(int index, JwtLocation.Builder builderForValue)

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

Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension x-google-jwt-locations

JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is that the first match wins.

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
NameDescription
indexint
builderForValueJwtLocation.Builder
Returns
TypeDescription
AuthProvider.Builder

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

public AuthProvider.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
AuthProvider.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final AuthProvider.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
AuthProvider.Builder
Overrides