public final class AuthProvider extends GeneratedMessageV3 implements AuthProviderOrBuilder
Configuration for an authentication provider, including support for
JSON Web Token
(JWT).
Protobuf type google.api.AuthProvider
Static Fields
AUDIENCES_FIELD_NUMBER
public static final int AUDIENCES_FIELD_NUMBER
Field Value
AUTHORIZATION_URL_FIELD_NUMBER
public static final int AUTHORIZATION_URL_FIELD_NUMBER
Field Value
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER
Field Value
ISSUER_FIELD_NUMBER
public static final int ISSUER_FIELD_NUMBER
Field Value
JWKS_URI_FIELD_NUMBER
public static final int JWKS_URI_FIELD_NUMBER
Field Value
JWT_LOCATIONS_FIELD_NUMBER
public static final int JWT_LOCATIONS_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static AuthProvider getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static AuthProvider.Builder newBuilder()
Returns
newBuilder(AuthProvider prototype)
public static AuthProvider.Builder newBuilder(AuthProvider prototype)
Parameter
Returns
public static AuthProvider parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static AuthProvider parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static AuthProvider parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AuthProvider parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static AuthProvider parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AuthProvider parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static AuthProvider parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static AuthProvider parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static AuthProvider parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static AuthProvider parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static AuthProvider parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AuthProvider parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<AuthProvider> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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;
| 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:
string audiences = 4;
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;
| 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;
| Type | Description |
| ByteString | The bytes for authorizationUrl.
|
getDefaultInstanceForType()
public AuthProvider getDefaultInstanceForType()
Returns
getId()
The unique identifier of the auth provider. It will be referred to by
AuthRequirement.provider_id.
Example: "bookstore_auth".
string id = 1;
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;
getIssuer()
public String getIssuer()
Returns
| Type | Description |
| String | The issuer.
|
getIssuerBytes()
public ByteString getIssuerBytes()
Returns
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;
| 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:
string jwks_uri = 3;
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;
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;
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;
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;
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;
| Type | Description |
| List<? extends com.google.api.JwtLocationOrBuilder> | |
getParserForType()
public Parser<AuthProvider> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public AuthProvider.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AuthProvider.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public AuthProvider.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
