class Google::Apis::ServicemanagementV1::AuthProvider

Configuration for an authentication provider, including support for [JSON Web Token (JWT)](tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).

Attributes

audiences[RW]

The list of JWT [audiences](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, JWTs with audiences: - “[service.name]/[google.protobuf.Api.name]” - “https://[ service.name]/” will be accepted. For example, if no audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - library-example.googleapis.com/google.example.library.v1. LibraryService - library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps. googleusercontent.com Corresponds to the JSON property `audiences` @return [String]

authorization_url[RW]

Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec. Corresponds to the JSON property `authorizationUrl` @return [String]

id[RW]

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` @return [String]

issuer[RW]

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

jwks_uri[RW]

URL of the provider's public key set to validate signature of the JWT. See [ OpenID Discovery](openid.net/specs/openid-connect-discovery-1_0.html# ProviderMetadata). Optional if the key set document: - can be retrieved from [ OpenID Discovery](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: www.googleapis.com/oauth2/v1/certs Corresponds to the JSON property `jwksUri` @return [String]

jwt_locations[RW]

Defines the locations to extract the JWT. JWT locations can be either from HTTP headers or URL query parameters. The rule is that the first match wins. The checking order is: checking all headers first, then URL query parameters. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: “Bearer ” - header: x-goog-iap-jwt-assertion - query: access_token Corresponds to the JSON property `jwtLocations` @return [Array<Google::Apis::ServicemanagementV1::JwtLocation>]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/servicemanagement_v1/classes.rb, line 253
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/servicemanagement_v1/classes.rb, line 258
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)
  @jwt_locations = args[:jwt_locations] if args.key?(:jwt_locations)
end