GoogleApi.ServiceControl.V2.Model.Auth (google_api_service_control v0.36.4) View Source

This message defines request authentication attributes. Terminology is based on the JSON Web Token (JWT) standard, but the terms also correlate to concepts in other standards.


  • accessLevels (type: list(String.t), default: nil) - A list of access level resource names that allow resources to be accessed by authenticated requester. It is part of Secure GCP processing for the incoming request. An access level string has the format: "//{api_service_name}/accessPolicies/{policy_id}/accessLevels/{short_name}" Example: "//"
  • audiences (type: list(String.t), default: nil) - The intended audience(s) for this authentication information. Reflects the audience (aud) claim within a JWT. The audience value(s) depends on the issuer, but typically include one or more of the following pieces of information: The services intended to receive the credential. For example, ["", ""]. A set of service-based scopes. For example, [""]. * The client id of an app, such as the Firebase project id for JWTs from Firebase Auth. Consult the documentation for the credential issuer to determine the information provided.
  • claims (type: map(), default: nil) - Structured claims presented with the credential. JWTs include {key: value} pairs for standard and private claims. The following is a subset of the standard required and optional claims that would typically be presented for a Google-based JWT: {'iss': '', 'sub': '113289723416554971153', 'aud': ['123456789012', ''], 'azp': '', 'email': '', 'iat': 1353601026, 'exp': 1353604926} SAML assertions are similarly specified, but with an identity provider dependent structure.
  • presenter (type: String.t, default: nil) - The authorized presenter of the credential. Reflects the optional Authorized Presenter (azp) claim within a JWT or the OAuth client id. For example, a Google Cloud Platform client id looks as follows: "".
  • principal (type: String.t, default: nil) - The authenticated principal. Reflects the issuer (iss) and subject (sub) claims within a JWT. The issuer and subject should be / delimited, with / percent-encoded within the subject fragment. For Google accounts, the principal format is: "{id}"

Link to this section Summary


Unwrap a decoded JSON object into its complex fields.

Link to this section Types


t() :: %GoogleApi.ServiceControl.V2.Model.Auth{
  accessLevels: [String.t()] | nil,
  audiences: [String.t()] | nil,
  claims: map() | nil,
  presenter: String.t() | nil,
  principal: String.t() | nil

Link to this section Functions


decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.