Class: Google::Api::AuthRequirement

Inherits:

Object

• Object
• Google::Api::AuthRequirement

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/api/auth.rb

Overview

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

Instance Attribute Summary

• #audiences ⇒ ::String

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

• #provider_id ⇒ ::String

  id from authentication provider.

Instance Attribute Details

#audiences ⇒ ::String

Returns 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.

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

# File 'proto_docs/google/api/auth.rb', line 247

class AuthRequirement
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#provider_id ⇒ ::String

Returns id from authentication provider.

Example:

provider_id: bookstore_auth.

Returns:

• (::String) —

  id from authentication provider.

  Example:

  provider_id: bookstore_auth
  

# File 'proto_docs/google/api/auth.rb', line 247

class AuthRequirement
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end