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

Generated from protobuf message google.api.AuthProvider

CloneableInstantiable
ExtendsGoogle\Protobuf\Internal\Message
Methods
public __construct( $data = NULL)
 
Constructor.

    public Google\Protobuf\Internal\Message::byteSize()
     


    • ignore
    public Google\Protobuf\Internal\Message::clear()
    public Google\Protobuf\Internal\Message::discardUnknownFields()
    public getAudiences()
     
    The list of JWT [audiences](https://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, only JWTs with audience
    "https://[Service_name][google.api.Service.name]/[API_name][google.protobuf.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
    

    Generated from protobuf field string audiences = 4;

    • return string
    public getAuthorizationUrl()
     
    Redirect URL if JWT token is required but no present or is expired.

    Implement authorizationUrl of securityDefinitions in OpenAPI spec.

    Generated from protobuf field string authorization_url = 5;

    • return string
    public getId()
     
    The unique identifier of the auth provider. It will be referred to by `AuthRequirement.provider_id`.

    Example: "bookstore_auth".

    Generated from protobuf field string id = 1;

    • return string
    public getIssuer()
     
    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

    Generated from protobuf field string issuer = 2;

    • return string
    public getJwksUri()
     
    URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).

    Optional if the key set document:

    Generated from protobuf field string jwks_uri = 3;

    • return string
    public Google\Protobuf\Internal\Message::jsonByteSize()
     


    • ignore
    public Google\Protobuf\Internal\Message::mergeFrom( $msg)
    public Google\Protobuf\Internal\Message::mergeFromJsonString( $data)
    public Google\Protobuf\Internal\Message::mergeFromString( $data)
    public Google\Protobuf\Internal\Message::parseFromJsonStream( $input)
     


    • ignore
    public Google\Protobuf\Internal\Message::parseFromStream( $input)
     


    • ignore
    public Google\Protobuf\Internal\Message::serializeToJsonStream( $output)
     


    • ignore
    public Google\Protobuf\Internal\Message::serializeToJsonString()
     
    Serialize the message to json string.

    • return string Serialized json protobuf data.
    public Google\Protobuf\Internal\Message::serializeToStream( $output)
     


    • ignore
    public Google\Protobuf\Internal\Message::serializeToString()
     
    Serialize the message to string.

    • return string Serialized binary protobuf data.
    public setAudiences( $var)
     
    The list of JWT [audiences](https://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, only JWTs with audience
    "https://[Service_name][google.api.Service.name]/[API_name][google.protobuf.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
    

    Generated from protobuf field string audiences = 4;

    • return $this
    public setAuthorizationUrl( $var)
     
    Redirect URL if JWT token is required but no present or is expired.

    Implement authorizationUrl of securityDefinitions in OpenAPI spec.

    Generated from protobuf field string authorization_url = 5;

    • return $this
    public setId( $var)
     
    The unique identifier of the auth provider. It will be referred to by `AuthRequirement.provider_id`.

    Example: "bookstore_auth".

    Generated from protobuf field string id = 1;

    • return $this
    public setIssuer( $var)
     
    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

    Generated from protobuf field string issuer = 2;

    • return $this
    public setJwksUri( $var)
     
    URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).

    Optional if the key set document:

    Generated from protobuf field string jwks_uri = 3;

    • return $this
    Methods
    protected Google\Protobuf\Internal\Message::mergeFromArray(array $array)
    protected Google\Protobuf\Internal\Message::mergeFromJsonArray( $array)
    protected Google\Protobuf\Internal\Message::readOneof( $number)
    protected Google\Protobuf\Internal\Message::readWrapperValue( $member)
    protected Google\Protobuf\Internal\Message::whichOneof( $oneof_name)
    protected Google\Protobuf\Internal\Message::writeOneof( $number, $value)
    protected Google\Protobuf\Internal\Message::writeWrapperValue( $member, $value)
    Properties
    private $audiences
     
    The list of JWT [audiences](https://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, only JWTs with audience
    "https://[Service_name][google.api.Service.name]/[API_name][google.protobuf.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
    

    Generated from protobuf field string audiences = 4;

    private $authorization_url
     
    Redirect URL if JWT token is required but no present or is expired.

    Implement authorizationUrl of securityDefinitions in OpenAPI spec.

    Generated from protobuf field string authorization_url = 5;

    private $id
     
    The unique identifier of the auth provider. It will be referred to by `AuthRequirement.provider_id`.

    Example: "bookstore_auth".

    Generated from protobuf field string id = 1;

    private $issuer
     
    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

    Generated from protobuf field string issuer = 2;

    private $jwks_uri
     
    URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).

    Optional if the key set document:

    Generated from protobuf field string jwks_uri = 3;

    Methods
    private Google\Protobuf\Internal\Message::appendHelper( $field, $append_value)
    private Google\Protobuf\Internal\Message::convertJsonValueToProtoValue( $value, $field, $is_map_key = false)
    private Google\Protobuf\Internal\Message::defaultValue( $field)
     


    • ignore
    private Google\Protobuf\Internal\Message::existField( $field)
     


    • ignore
    private Google\Protobuf\Internal\Message::fieldByteSize( $field)
     


    • ignore
    private Google\Protobuf\Internal\Message::fieldDataOnlyByteSize( $field, $value)
     


    • ignore
    private Google\Protobuf\Internal\Message::fieldDataOnlyJsonByteSize( $field, $value)
     


    • ignore
    private Google\Protobuf\Internal\Message::fieldJsonByteSize( $field)
     


    • ignore
    private Google\Protobuf\Internal\Message::initWithDescriptor(Google\Protobuf\Internal\Descriptor $desc)
     


    • ignore
    private Google\Protobuf\Internal\Message::initWithGeneratedPool()
     


    • ignore
    private Google\Protobuf\Internal\Message::kvUpdateHelper( $field, $update_key, $update_value)
    private Google\Protobuf\Internal\Message::mergeFromArrayJsonImpl( $array)
    private static Google\Protobuf\Internal\Message::normalizeArrayElementsToMessageType( $value, $class)
     
    Tries to normalize the elements in $value into a provided protobuf wrapper type $class. If $value is any type other than array, we do not do any conversion, and instead rely on the existing protobuf type checking. If $value is an array, we process each element and try to convert it to an instance of $class.

      private static Google\Protobuf\Internal\Message::normalizeToMessageType( $value, $class)
       
      Tries to normalize $value into a provided protobuf wrapper type $class.

      If $value is any type other than an object, we attempt to construct an
      instance of $class and assign $value to it using the setValue method
      shared by all wrapper types.

      This method will raise an error if it receives a type that cannot be
      assigned to the wrapper type via setValue.

        private Google\Protobuf\Internal\Message::parseFieldFromStream( $tag, $input, $field)
         


        • ignore
        private static Google\Protobuf\Internal\Message::parseFieldFromStreamNoTag( $input, $field, $value)
         


        • ignore
        private Google\Protobuf\Internal\Message::repeatedFieldDataOnlyByteSize( $field)
         


        • ignore
        private Google\Protobuf\Internal\Message::serializeFieldToJsonStream( $output, $field)
         


        • ignore
        private Google\Protobuf\Internal\Message::serializeFieldToStream( $output, $field)
         


        • ignore
        private Google\Protobuf\Internal\Message::serializeMapFieldToStream( $field, $output)
         


        • ignore
        private Google\Protobuf\Internal\Message::serializeRepeatedFieldToStream( $field, $output)
         


        • ignore
        private Google\Protobuf\Internal\Message::serializeSingularFieldToStream( $field, $output)
         


        • ignore
        private Google\Protobuf\Internal\Message::skipField( $input, $tag)
         


        • ignore
        Methods
        private static Google\Protobuf\Internal\Message::normalizeArrayElementsToMessageType( $value, $class)
         
        Tries to normalize the elements in $value into a provided protobuf wrapper type $class. If $value is any type other than array, we do not do any conversion, and instead rely on the existing protobuf type checking. If $value is an array, we process each element and try to convert it to an instance of $class.

          private static Google\Protobuf\Internal\Message::normalizeToMessageType( $value, $class)
           
          Tries to normalize $value into a provided protobuf wrapper type $class.

          If $value is any type other than an object, we attempt to construct an
          instance of $class and assign $value to it using the setValue method
          shared by all wrapper types.

          This method will raise an error if it receives a type that cannot be
          assigned to the wrapper type via setValue.

            private static Google\Protobuf\Internal\Message::parseFieldFromStreamNoTag( $input, $field, $value)
             


            • ignore
            © 2020 Bruce Wells
            Search Namespaces \ Classes
            ConfigurationNumbers (0-9.) only