Service Usage V1 API - Class Google::Api::AuthRequirement (v0.7.0)

Reference documentation and code samples for the Service Usage V1 API class Google::Api::AuthRequirement.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#audiences

def audiences() -> ::String
Returns
  • (::String) —

    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" 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

#audiences=

def audiences=(value) -> ::String
Parameter
  • value (::String) —

    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" 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
Returns
  • (::String) —

    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" 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

#provider_id

def provider_id() -> ::String
Returns
  • (::String) —

    id from authentication provider.

    Example:

    provider_id: bookstore_auth

#provider_id=

def provider_id=(value) -> ::String
Parameter
  • value (::String) —

    id from authentication provider.

    Example:

    provider_id: bookstore_auth
Returns
  • (::String) —

    id from authentication provider.

    Example:

    provider_id: bookstore_auth