Class: Google::Apis::ServiceuserV1::AuthProvider

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/serviceuser_v1/classes.rb,
generated/google/apis/serviceuser_v1/representations.rb,
generated/google/apis/serviceuser_v1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

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



165
166
167
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 165

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) 


126
127
128
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 126

def audiences
  @audiences
end

#authorization_url ⇒ String

Redirect URL if JWT token is required but no present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec. Corresponds to the JSON property authorizationUrl

Returns:

  • (String) 


132
133
134
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 132

def authorization_url
  @authorization_url
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) 


139
140
141
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 139

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) 


148
149
150
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 148

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:

Returns:

  • (String) 


163
164
165
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 163

def jwks_uri
  @jwks_uri
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



170
171
172
173
174
175
176
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 170

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