AuthRequirement
class AuthRequirement extends Message
User-defined authentication requirements, including support for JSON Web Token (JWT).
Generated from protobuf message google.api.AuthRequirement
Methods
No description
[id][google.api.AuthProvider.id] from authentication provider.
[id][google.api.AuthProvider.id] from authentication provider.
NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components.
NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components.
Details
at line 46
__construct()
at line 59
string
getProviderId()
[id][google.api.AuthProvider.id] from authentication provider.
Example: provider_id: bookstore_auth
Generated from protobuf field string provider_id = 1;
at line 73
$this
setProviderId(string $var)
[id][google.api.AuthProvider.id] from authentication provider.
Example: provider_id: bookstore_auth
Generated from protobuf field string provider_id = 1;
at line 99
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][google.api.Service.name]/[API_name][google.protobuf.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
Generated from protobuf field string audiences = 2;
at line 123
$this
setAudiences(string $var)
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][google.api.Service.name]/[API_name][google.protobuf.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
Generated from protobuf field string audiences = 2;