2.9.1 (latest) 2.9.0 2.8.1 2.7.2 2.6.0 2.5.1 2.4.1 2.1.2 2.0.1 1.35.2 1.34.1 1.33.4

    public class GoogleIdTokenVerifier extends IdTokenVerifier

Beta   

Thread-safe Google ID token verifier.

Call [#verify(IdToken)](https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GoogleIdTokenVerifier#com_google_api_client_googleapis_auth_oauth2_GoogleIdTokenVerifier_verify_) to verify a ID token. Use the constructor [#GoogleIdTokenVerifier(HttpTransport, JsonFactory)](https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GoogleIdTokenVerifier#com_google_api_client_googleapis_auth_oauth2_GoogleIdTokenVerifier_GoogleIdTokenVerifier_com_google_api_client_http_HttpTransport_com_google_api_client_json_JsonFactory_) for the typical simpler case if your
application has only a single instance of [GoogleIdTokenVerifier](https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GoogleIdTokenVerifier). Otherwise, ideally you
should use [#GoogleIdTokenVerifier(GooglePublicKeysManager)](https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GoogleIdTokenVerifier#com_google_api_client_googleapis_auth_oauth2_GoogleIdTokenVerifier_GoogleIdTokenVerifier_com_google_api_client_googleapis_auth_oauth2_GooglePublicKeysManager_) with a shared global instance
of the [GooglePublicKeysManager](https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GooglePublicKeysManager) since that way the Google public keys are cached. Sample
usage:


     GoogleIdTokenVerifier verifier = new GoogleIdTokenVerifier.Builder(transport, jsonFactory)
            .setAudience(Arrays.asList("myClientId"))
            .build();

     ...

     if (!verifier.verify(googleIdToken)) {...}
     
## Inheritance

[java.lang.Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html) \> com.google.api.client.auth.openidconnect.IdTokenVerifier \> GoogleIdTokenVerifier

## Inherited Members

com.google.api.client.auth.openidconnect.IdTokenVerifier.getAcceptableTimeSkewSeconds() com.google.api.client.auth.openidconnect.IdTokenVerifier.getAudience() com.google.api.client.auth.openidconnect.IdTokenVerifier.getClock() com.google.api.client.auth.openidconnect.IdTokenVerifier.getIssuer() com.google.api.client.auth.openidconnect.IdTokenVerifier.getIssuers() com.google.api.client.auth.openidconnect.IdTokenVerifier.verify(com.google.api.client.auth.openidconnect.IdToken) com.google.api.client.auth.openidconnect.IdTokenVerifier.verifyOrThrow(com.google.api.client.auth.openidconnect.IdToken) com.google.api.client.auth.openidconnect.IdTokenVerifier.verifyPayload(com.google.api.client.auth.openidconnect.IdToken) [Object.clone()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--) [Object.equals(Object)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-) [Object.finalize()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--) [Object.getClass()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--) [Object.hashCode()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--) [Object.notify()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--) [Object.notifyAll()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--) [Object.toString()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--) [Object.wait()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--) [Object.wait(long)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-) [Object.wait(long,int)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-)

## Constructors

### GoogleIdTokenVerifier(GoogleIdTokenVerifier.Builder builder)

    protected GoogleIdTokenVerifier(GoogleIdTokenVerifier.Builder builder)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `builder` | `https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GoogleIdTokenVerifier.Builder` builder |

### GoogleIdTokenVerifier(GooglePublicKeysManager publicKeys)

    public GoogleIdTokenVerifier(GooglePublicKeysManager publicKeys)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `publicKeys` | `https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GooglePublicKeysManager` Google public keys manager |

### GoogleIdTokenVerifier(HttpTransport transport, JsonFactory jsonFactory)

    public GoogleIdTokenVerifier(HttpTransport transport, JsonFactory jsonFactory)

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `transport` | `com.google.api.client.http.HttpTransport` HTTP transport |
| `jsonFactory` | `com.google.api.client.json.JsonFactory` JSON factory |

## Methods

### getExpirationTimeMilliseconds() (deprecated)

    public final long getExpirationTimeMilliseconds()

**Deprecated.** *(scheduled to be removed in 1.18) Use [#getPublicKeysManager()](https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GoogleIdTokenVerifier#com_google_api_client_googleapis_auth_oauth2_GoogleIdTokenVerifier_getPublicKeysManager__) and [GooglePublicKeysManager#getExpirationTimeMilliseconds()](https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GooglePublicKeysManager#com_google_api_client_googleapis_auth_oauth2_GooglePublicKeysManager_getExpirationTimeMilliseconds__) instead.*

Returns the expiration time in milliseconds to be used with Clock#currentTimeMillis()
or `0` for none.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |   |

### getJsonFactory()

    public final JsonFactory getJsonFactory()

Returns the JSON factory.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `com.google.api.client.json.JsonFactory` |   |

### getPublicCertsEncodedUrl() (deprecated)

    public final String getPublicCertsEncodedUrl()

**Deprecated.** *(scheduled to be removed in 1.18) Use [#getPublicKeysManager()](https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GoogleIdTokenVerifier#com_google_api_client_googleapis_auth_oauth2_GoogleIdTokenVerifier_getPublicKeysManager__) and [GooglePublicKeysManager#getPublicCertsEncodedUrl()](https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GooglePublicKeysManager#com_google_api_client_googleapis_auth_oauth2_GooglePublicKeysManager_getPublicCertsEncodedUrl__) instead.*

Returns the public certificates encoded URL.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |   |

### getPublicKeys() (deprecated)

    public final List<PublicKey> getPublicKeys()

**Deprecated.** *(scheduled to be removed in 1.18) Use [#getPublicKeysManager()](https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GoogleIdTokenVerifier#com_google_api_client_googleapis_auth_oauth2_GoogleIdTokenVerifier_getPublicKeysManager__) and [GooglePublicKeysManager#getPublicKeys()](https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GooglePublicKeysManager#com_google_api_client_googleapis_auth_oauth2_GooglePublicKeysManager_getPublicKeys__) instead.*

Returns the public keys.

Upgrade warning: in prior version 1.16 it may return `null` and not throw any
exceptions, but starting with version 1.17 it cannot return `null` and may throw [GeneralSecurityException](https://docs.oracle.com/javase/8/docs/api/java/security/GeneralSecurityException.html) or [IOException](https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html).

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/List.html<https://docs.oracle.com/javase/8/docs/api/java/security/PublicKey.html>` |   |

| **Exceptions** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/security/GeneralSecurityException.html` |   |
| `https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html` |   |

### getPublicKeysManager()

    public final GooglePublicKeysManager getPublicKeysManager()

Returns the Google public keys manager.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GooglePublicKeysManager` |   |

### getTransport()

    public final HttpTransport getTransport()

Returns the HTTP transport.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `com.google.api.client.http.HttpTransport` |   |

### loadPublicCerts() (deprecated)

    public GoogleIdTokenVerifier loadPublicCerts()

**Deprecated.** *(scheduled to be removed in 1.18) Use [#getPublicKeysManager()](https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GoogleIdTokenVerifier#com_google_api_client_googleapis_auth_oauth2_GoogleIdTokenVerifier_getPublicKeysManager__) and [GooglePublicKeysManager#refresh()](https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GooglePublicKeysManager#com_google_api_client_googleapis_auth_oauth2_GooglePublicKeysManager_refresh__) instead.*

Downloads the public keys from the public certificates endpoint at [#getPublicCertsEncodedUrl](https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GoogleIdTokenVerifier#com_google_api_client_googleapis_auth_oauth2_GoogleIdTokenVerifier_getPublicCertsEncodedUrl_).

This method is automatically called if the public keys have not yet been initialized or if
the expiration time is very close, so normally this doesn't need to be called. Only call this
method explicitly to force the public keys to be updated.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GoogleIdTokenVerifier` |   |

| **Exceptions** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/security/GeneralSecurityException.html` |   |
| `https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html` |   |

### verify(GoogleIdToken googleIdToken)

    public boolean verify(GoogleIdToken googleIdToken)

Verifies that the given ID token is valid using the cached public keys.

It verifies:

- The RS256 signature, which uses RSA and SHA-256 based on the public keys downloaded from the public certificate endpoint.
- The current time against the issued at and expiration time (allowing for a 5 minute clock skew).
- The issuer is `"accounts.google.com"` or `"https://accounts.google.com"`.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `googleIdToken` | `https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GoogleIdToken` Google ID token |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | `true` if verified successfully or `false` if failed |

| **Exceptions** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/security/GeneralSecurityException.html` |   |
| `https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html` |   |

### verify(String idTokenString)

    public GoogleIdToken verify(String idTokenString)

Verifies that the given ID token is valid using [#verify(GoogleIdToken)](https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GoogleIdTokenVerifier#com_google_api_client_googleapis_auth_oauth2_GoogleIdTokenVerifier_verify_com_google_api_client_googleapis_auth_oauth2_GoogleIdToken_) and returns the
ID token if succeeded.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `idTokenString` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` Google ID token string |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-api-client/latest/com.google.api.client.googleapis.auth.oauth2.GoogleIdToken` | Google ID token if verified successfully or `null` if failed |

| **Exceptions** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/security/GeneralSecurityException.html` |   |
| `https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html` |   |