google_api_service_management v0.15.0 GoogleApi.ServiceManagement.V1.Model.AuthProvider View Source

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

Attributes

  • audiences (type: String.t, default: nil) - 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
  • authorizationUrl (type: String.t, default: nil) - Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec.

  • id (type: String.t, default: nil) - The unique identifier of the auth provider. It will be referred to by AuthRequirement.provider_id.

    Example: "bookstore_auth".

  • issuer (type: String.t, default: nil) - 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

  • jwksUri (type: String.t, default: nil) - 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

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Link to this type

t()

View Source
t() :: %GoogleApi.ServiceManagement.V1.Model.AuthProvider{
  audiences: String.t(),
  authorizationUrl: String.t(),
  id: String.t(),
  issuer: String.t(),
  jwksUri: String.t()
}

Link to this section Functions

Link to this function

decode(value, options)

View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.