Class: Google::Apis::ServicemanagementV1::AuthProvider

Inherits:

Object

• Object
• Google::Apis::ServicemanagementV1::AuthProvider

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

generated/google/apis/servicemanagement_v1/classes.rb,
generated/google/apis/servicemanagement_v1/representations.rb,
generated/google/apis/servicemanagement_v1/representations.rb

Overview

Configuration for an anthentication provider, including support for JSON Web Token (JWT).

Instance Attribute Summary

• #audiences ⇒ String

  The list of JWT audiences.

• #id ⇒ String

  The unique identifier of the auth provider.

• #issuer ⇒ String

  Identifies the principal that issued the JWT.

• #jwks_uri ⇒ String

  URL of the provider's public key set to validate signature of the JWT.

Instance Method Summary

• #initialize(**args) ⇒ AuthProvider constructor

  A new instance of AuthProvider.

• #update!(**args) ⇒ Object

  Update properties of this object.

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ AuthProvider

Returns a new instance of AuthProvider

# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2746

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#audiences ⇒ String

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 Corresponds to the JSON property audiences

Returns:

• (String)

# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2728

def audiences
  @audiences
end

#id ⇒ String

The unique identifier of the auth provider. It will be referred to by AuthRequirement.provider_id. Example: "bookstore_auth". Corresponds to the JSON property id

Returns:

• (String)

# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2735

def id
  @id
end

#issuer ⇒ String

Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example: https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com Corresponds to the JSON property issuer

Returns:

• (String)

# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2744

def issuer
  @issuer
end

#jwks_uri ⇒ String

URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery. Optional if the key set document:

• can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0. html of the issuer.
• can be inferred from the email domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs Corresponds to the JSON property jwksUri

Returns:

• (String)

# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2711

def jwks_uri
  @jwks_uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'generated/google/apis/servicemanagement_v1/classes.rb', line 2751

def update!(**args)
  @jwks_uri = args[:jwks_uri] if args.key?(:jwks_uri)
  @audiences = args[:audiences] if args.key?(:audiences)
  @id = args[:id] if args.key?(:id)
  @issuer = args[:issuer] if args.key?(:issuer)
end