1. class
  2. Google
  3. \
  4. Api
  5. \
  6. AuthRequirement

AuthRequirement

class AuthRequirement extends Message

User-defined authentication requirements, including support for JSON Web Token (JWT).

Generated from protobuf message google.api.AuthRequirement

Methods

__construct(array $data = NULL)

Constructor.

string
getProviderId()

[id][google.api.AuthProvider.id] from authentication provider.

$this
setProviderId(string $var)

[id][google.api.AuthProvider.id] from authentication provider.

string
getAudiences()

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

$this
setAudiences(string $var)

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

Details

at line 72
__construct(array $data = NULL)

Constructor.

Parameters

array $data { Optional. Data for populating the Message object.

@type string $provider_id
      [id][google.api.AuthProvider.id] from authentication provider.
      Example:
          provider_id: bookstore_auth
@type string $audiences
      NOTE: This will be deprecated soon, once AuthProvider.audiences is
      implemented and accepted in all the runtime components.
      The list of JWT
      [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).
      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

}

at line 85
string getProviderId()

[id][google.api.AuthProvider.id] from authentication provider.

Example: provider_id: bookstore_auth

Generated from protobuf field string provider_id = 1;

Return Value

string

at line 99
$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;

Parameters

string $var

Return Value

$this

at line 125
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;

Return Value

string

at line 149
$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;

Parameters

string $var

Return Value

$this