AuthProvider
class AuthProvider extends Message
Configuration for an anthentication provider, including support for JSON Web Token (JWT).
Protobuf type Google\Api\AuthProvider
Methods
No description
The unique identifier of the auth provider. It will be referred to by
AuthRequirement.provider_id.
The unique identifier of the auth provider. It will be referred to by
AuthRequirement.provider_id.
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.
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.
URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery.
URL of the provider's public key set to validate signature of the JWT. See OpenID Discovery.
The list of JWT audiences.
The list of JWT audiences.
Details
at line 67
__construct()
at line 80
string
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;
at line 93
setId(string $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;
at line 109
string
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;
at line 124
setIssuer(string $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;
at line 143
string
getJwksUri()
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
Generated from protobuf field string jwks_uri = 3;
at line 161
setJwksUri(string $var)
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
Generated from protobuf field string jwks_uri = 3;
at line 183
string
getAudiences()
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][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;
at line 204
setAudiences(string $var)
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][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;