Package com.google.rpc.context

Interface AttributeContext.AuthOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
All Known Implementing Classes:
AttributeContext.Auth, AttributeContext.Auth.Builder
Enclosing class:
AttributeContext
public static interface AttributeContext.AuthOrBuilder extends com.google.protobuf.MessageLiteOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAccessLevels(int index)
    A list of access level resource names that allow resources to be accessed by authenticated requester.
    com.google.protobuf.ByteString
    getAccessLevelsBytes(int index)
    A list of access level resource names that allow resources to be accessed by authenticated requester.
    int
    getAccessLevelsCount()
    A list of access level resource names that allow resources to be accessed by authenticated requester.
    List<String>
    getAccessLevelsList()
    A list of access level resource names that allow resources to be accessed by authenticated requester.
    String
    getAudiences(int index)
    The intended audience(s) for this authentication information.
    com.google.protobuf.ByteString
    getAudiencesBytes(int index)
    The intended audience(s) for this authentication information.
    int
    getAudiencesCount()
    The intended audience(s) for this authentication information.
    List<String>
    getAudiencesList()
    The intended audience(s) for this authentication information.
    com.google.protobuf.Struct
    getClaims()
    Structured claims presented with the credential.
    String
    getPresenter()
    The authorized presenter of the credential.
    com.google.protobuf.ByteString
    getPresenterBytes()
    The authorized presenter of the credential.
    String
    getPrincipal()
    The authenticated principal.
    com.google.protobuf.ByteString
    getPrincipalBytes()
    The authenticated principal.
    boolean
    hasClaims()
    Structured claims presented with the credential.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • getPrincipal

      String getPrincipal()
       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:
 "https://accounts.google.com/{id}"
      string principal = 1 [json_name = "principal"];
      Returns:
      The principal.

    • getPrincipalBytes

      com.google.protobuf.ByteString getPrincipalBytes()
       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:
 "https://accounts.google.com/{id}"
      string principal = 1 [json_name = "principal"];
      Returns:
      The bytes for principal.

    • getAudiencesList

      List<String> getAudiencesList()
       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,
 ["https://pubsub.googleapis.com/", "https://storage.googleapis.com/"].
 *  A set of service-based scopes. For example,
 ["https://www.googleapis.com/auth/cloud-platform"].
 *  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.
      repeated string audiences = 2 [json_name = "audiences"];
      Returns:
      A list containing the audiences.

    • getAudiencesCount

      int getAudiencesCount()
       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,
 ["https://pubsub.googleapis.com/", "https://storage.googleapis.com/"].
 *  A set of service-based scopes. For example,
 ["https://www.googleapis.com/auth/cloud-platform"].
 *  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.
      repeated string audiences = 2 [json_name = "audiences"];
      Returns:
      The count of audiences.

    • getAudiences

      String getAudiences(int index)
       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,
 ["https://pubsub.googleapis.com/", "https://storage.googleapis.com/"].
 *  A set of service-based scopes. For example,
 ["https://www.googleapis.com/auth/cloud-platform"].
 *  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.
      repeated string audiences = 2 [json_name = "audiences"];
      Parameters:
      index - The index of the element to return.
      Returns:
      The audiences at the given index.

    • getAudiencesBytes

      com.google.protobuf.ByteString getAudiencesBytes(int index)
       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,
 ["https://pubsub.googleapis.com/", "https://storage.googleapis.com/"].
 *  A set of service-based scopes. For example,
 ["https://www.googleapis.com/auth/cloud-platform"].
 *  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.
      repeated string audiences = 2 [json_name = "audiences"];
      Parameters:
      index - The index of the element to return.
      Returns:
      The audiences at the given index.

    • getPresenter

      String getPresenter()
       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: "123456789012.apps.googleusercontent.com".
      string presenter = 3 [json_name = "presenter"];
      Returns:
      The presenter.

    • getPresenterBytes

      com.google.protobuf.ByteString getPresenterBytes()
       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: "123456789012.apps.googleusercontent.com".
      string presenter = 3 [json_name = "presenter"];
      Returns:
      The bytes for presenter.

    • hasClaims

      boolean hasClaims()
       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': 'accounts.google.com',
 'sub': '113289723416554971153',
 'aud': ['123456789012', 'pubsub.googleapis.com'],
 'azp': '123456789012.apps.googleusercontent.com',
 'email': 'jsmith@example.com',
 'iat': 1353601026,
 'exp': 1353604926}

 SAML assertions are similarly specified, but with an identity provider
 dependent structure.
      .google.protobuf.Struct claims = 4 [json_name = "claims"];
      Returns:
      Whether the claims field is set.

    • getClaims

      com.google.protobuf.Struct getClaims()
       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': 'accounts.google.com',
 'sub': '113289723416554971153',
 'aud': ['123456789012', 'pubsub.googleapis.com'],
 'azp': '123456789012.apps.googleusercontent.com',
 'email': 'jsmith@example.com',
 'iat': 1353601026,
 'exp': 1353604926}

 SAML assertions are similarly specified, but with an identity provider
 dependent structure.
      .google.protobuf.Struct claims = 4 [json_name = "claims"];
      Returns:
      The claims.

    • getAccessLevelsList

      List<String> getAccessLevelsList()
       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:
 "//accesscontextmanager.googleapis.com/accessPolicies/MY_POLICY_ID/accessLevels/MY_LEVEL"
      repeated string access_levels = 5 [json_name = "accessLevels"];
      Returns:
      A list containing the accessLevels.

    • getAccessLevelsCount

      int getAccessLevelsCount()
       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:
 "//accesscontextmanager.googleapis.com/accessPolicies/MY_POLICY_ID/accessLevels/MY_LEVEL"
      repeated string access_levels = 5 [json_name = "accessLevels"];
      Returns:
      The count of accessLevels.

    • getAccessLevels

      String getAccessLevels(int index)
       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:
 "//accesscontextmanager.googleapis.com/accessPolicies/MY_POLICY_ID/accessLevels/MY_LEVEL"
      repeated string access_levels = 5 [json_name = "accessLevels"];
      Parameters:
      index - The index of the element to return.
      Returns:
      The accessLevels at the given index.

    • getAccessLevelsBytes

      com.google.protobuf.ByteString getAccessLevelsBytes(int index)
       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:
 "//accesscontextmanager.googleapis.com/accessPolicies/MY_POLICY_ID/accessLevels/MY_LEVEL"
      repeated string access_levels = 5 [json_name = "accessLevels"];
      Parameters:
      index - The index of the element to return.
      Returns:
      The accessLevels at the given index.