Interface AuthRequirementOrBuilder (2.42.0)

public interface AuthRequirementOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAudiences()

public abstract String getAudiences()

NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components.

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, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService".

Example:

 audiences: bookstore_android.apps.googleusercontent.com,
            bookstore_web.apps.googleusercontent.com

string audiences = 2;

Returns
Type Description
String

The audiences.

getAudiencesBytes()

public abstract ByteString getAudiencesBytes()

NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components.

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, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService".

Example:

 audiences: bookstore_android.apps.googleusercontent.com,
            bookstore_web.apps.googleusercontent.com

string audiences = 2;

Returns
Type Description
ByteString

The bytes for audiences.

getProviderId()

public abstract String getProviderId()

id from authentication provider.

Example:

 provider_id: bookstore_auth

string provider_id = 1;

Returns
Type Description
String

The providerId.

getProviderIdBytes()

public abstract ByteString getProviderIdBytes()

id from authentication provider.

Example:

 provider_id: bookstore_auth

string provider_id = 1;

Returns
Type Description
ByteString

The bytes for providerId.