public static final class AuthProvider.Builder extends GeneratedMessageV3.Builder<AuthProvider.Builder> implements AuthProviderOrBuilderConfiguration 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.BuilderImplements
AuthProviderOrBuilderStatic 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. 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 |
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. 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 |
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. 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 |
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. 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 | |
|---|---|
| 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. 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 | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
JwtLocation.Builder |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| 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 |
|
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 |
|
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 |
|
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: 1234567-compute@developer.gserviceaccount.com
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).
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. 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 |
AuthProvider.Builder |
|
clearOneof(Descriptors.OneofDescriptor oneof)
public AuthProvider.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
AuthProvider.Builder |
|
clone()
public AuthProvider.Builder clone()| Returns | |
|---|---|
| Type | Description |
AuthProvider.Builder |
|
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 |
|
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: 1234567-compute@developer.gserviceaccount.com
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: 1234567-compute@developer.gserviceaccount.com
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).
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).
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. 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 |
|
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 | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
List<? extends com.google.api.JwtLocationOrBuilder> |
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public AuthProvider.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
AuthProvider.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final AuthProvider.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
AuthProvider.Builder |
|
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 | |
|---|---|
| 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 |
StringThe 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 |
ByteStringThe 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 |
StringThe 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 |
ByteStringThe 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 |
|
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 |
StringThe 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 |
ByteStringThe 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: 1234567-compute@developer.gserviceaccount.com
string issuer = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe 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: 1234567-compute@developer.gserviceaccount.com
string issuer = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe 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).
string jwks_uri = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe 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).
string jwks_uri = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe 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. 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 | |
|---|---|
| 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. 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 | |
|---|---|
| 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 |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final AuthProvider.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
AuthProvider.Builder |
|