Interface AuthProviderOrBuilder (2.26.0)

Version 2.26.0

• 2.50.0 (latest)
• 2.49.0
• 2.48.0
• 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 interface AuthProviderOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAudiences()

public abstract 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 abstract 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 abstract 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 abstract 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.

getId()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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
Name	Description
index	int

Returns
Type	Description
JwtLocation

getJwtLocationsCount()

public abstract 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
Type	Description
int

getJwtLocationsList()

public abstract 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
Type	Description
List<JwtLocation>

getJwtLocationsOrBuilder(int index)

public abstract 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
Name	Description
index	int

Returns
Type	Description
JwtLocationOrBuilder

getJwtLocationsOrBuilderList()

public abstract 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
Type	Description
List<? extends com.google.api.JwtLocationOrBuilder>