Documentation

Auth extends Message
in package

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.

Generated from protobuf message google.rpc.context.AttributeContext.Auth

Table of Contents

Properties

$claims  : mixed
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.
$presenter  : mixed
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".
$principal  : mixed
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}"
$access_levels  : mixed
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"
$audiences  : mixed
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/"].

Methods

__construct()  : mixed
Constructor.
clearClaims()  : mixed
getAccessLevels()  : RepeatedField
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"
getAudiences()  : RepeatedField
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/"].
getClaims()  : Struct|null
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.
getPresenter()  : string
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".
getPrincipal()  : string
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}"
hasClaims()  : mixed
setAccessLevels()  : $this
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"
setAudiences()  : $this
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/"].
setClaims()  : $this
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.
setPresenter()  : $this
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".
setPrincipal()  : $this
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}"

Properties

$claims

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.

protected mixed $claims = null

Generated from protobuf field .google.protobuf.Struct claims = 4 [json_name = "claims"];

$presenter

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".

protected mixed $presenter = ''

Generated from protobuf field string presenter = 3 [json_name = "presenter"];

$principal

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}"

protected mixed $principal = ''

Generated from protobuf field string principal = 1 [json_name = "principal"];

$access_levels

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"

private mixed $access_levels

Generated from protobuf field repeated string access_levels = 5 [json_name = "accessLevels"];

$audiences

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/"].

private mixed $audiences
  • 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.

Generated from protobuf field repeated string audiences = 2 [json_name = "audiences"];

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $data = NULL ]) : mixed
Parameters
$data : array<string|int, mixed> = NULL

{ Optional. Data for populating the Message object.

@type string $principal
      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}"
@type array<string>|\Google\Protobuf\Internal\RepeatedField $audiences
      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.
@type string $presenter
      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".
@type \Google\Protobuf\Struct $claims
      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&#64;example.com',
          'iat': 1353601026,
          'exp': 1353604926}
      SAML assertions are similarly specified, but with an identity provider
      dependent structure.
@type array<string>|\Google\Protobuf\Internal\RepeatedField $access_levels
      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"

}

clearClaims()

public clearClaims() : mixed

getAccessLevels()

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"

public getAccessLevels() : RepeatedField

Generated from protobuf field repeated string access_levels = 5 [json_name = "accessLevels"];

Return values
RepeatedField

getAudiences()

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/"].

public getAudiences() : RepeatedField
  • 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.

Generated from protobuf field repeated string audiences = 2 [json_name = "audiences"];

Return values
RepeatedField

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&#64;example.com', 'iat': 1353601026, 'exp': 1353604926} SAML assertions are similarly specified, but with an identity provider dependent structure.

public getClaims() : Struct|null

Generated from protobuf field .google.protobuf.Struct claims = 4 [json_name = "claims"];

Return values
Struct|null

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".

public getPresenter() : string

Generated from protobuf field string presenter = 3 [json_name = "presenter"];

Return values
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}"

public getPrincipal() : string

Generated from protobuf field string principal = 1 [json_name = "principal"];

Return values
string

hasClaims()

public hasClaims() : mixed

setAccessLevels()

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"

public setAccessLevels(array<string|int, string>|RepeatedField $var) : $this

Generated from protobuf field repeated string access_levels = 5 [json_name = "accessLevels"];

Parameters
$var : array<string|int, string>|RepeatedField
Return values
$this

setAudiences()

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/"].

public setAudiences(array<string|int, string>|RepeatedField $var) : $this
  • 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.

Generated from protobuf field repeated string audiences = 2 [json_name = "audiences"];

Parameters
$var : array<string|int, string>|RepeatedField
Return values
$this

setClaims()

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&#64;example.com', 'iat': 1353601026, 'exp': 1353604926} SAML assertions are similarly specified, but with an identity provider dependent structure.

public setClaims(Struct $var) : $this

Generated from protobuf field .google.protobuf.Struct claims = 4 [json_name = "claims"];

Parameters
$var : Struct
Return values
$this

setPresenter()

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".

public setPresenter(string $var) : $this

Generated from protobuf field string presenter = 3 [json_name = "presenter"];

Parameters
$var : string
Return values
$this

setPrincipal()

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}"

public setPrincipal(string $var) : $this

Generated from protobuf field string principal = 1 [json_name = "principal"];

Parameters
$var : string
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results