2.73.0 (latest) 2.72.0 2.71.0 2.70.0 2.69.0 2.66.0 2.65.0 2.64.1 2.63.1 2.62.2 2.61.0 2.60.3 2.59.0 2.58.2 2.57.0 2.56.0 2.55.0 2.53.1 2.52.0 2.51.0 2.50.0 2.49.1 2.48.0 2.47.0 2.45.0 2.44.1 2.43.0 2.42.0 2.41.0 2.40.0 2.39.0 2.38.1 2.37.0 2.36.1 2.35.0 2.33.0 2.32.0 2.31.0 2.29.0 2.28.0 2.27.0 2.26.0 2.25.0 2.24.1 2.23.0 2.22.1 2.21.1 2.20.1 2.13.0 2.12.0 2.11.0 2.9.4 2.8.27 2.7.1 2.6.1 2.5.11 2.4.0 2.3.5

    public final class Identity implements Serializable

An identity in a [Policy](https://docs.cloud.google.com/java/docs/reference/google-cloud-core/latest/com.google.cloud.Policy). The following types of identities are permitted in IAM policies:

- Google account
- Service account
- Google group
- Google Apps domain

There are also two special identities that represent all users and all Google-authenticated
accounts.
See Also: [Concepts related to identity](https://cloud.google.com/iam/docs/overview#concepts_related_to_identity)

## Inheritance

[Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html) \> Identity

## Implements

[Serializable](https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html)

## Inherited Members

[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-)

## Static Methods

### allAuthenticatedUsers()

    public static Identity allAuthenticatedUsers()

Returns a new identity representing anyone who is authenticated with a Google account or a
service account.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-core/latest/com.google.cloud.Identity` |   |

### allUsers()

    public static Identity allUsers()

Returns a new identity representing anyone who is on the internet; with or without a Google
account.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-core/latest/com.google.cloud.Identity` |   |

### domain(String domain)

    public static Identity domain(String domain)

Returns a new domain identity.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `domain` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` A Google Apps domain name that represents all the users of that domain. For example, *google.com* or *example.com*. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-core/latest/com.google.cloud.Identity` |   |

### group(String email)

    public static Identity group(String email)

Returns a new group identity.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `email` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` An email address that represents a Google group. For example, *admins@example.com*. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-core/latest/com.google.cloud.Identity` |   |

### projectEditor(String projectId)

    public static Identity projectEditor(String projectId)

Returns a new project editor identity.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `projectId` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` A Google Cloud Platform project ID. For example, *my-sample-project*. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-core/latest/com.google.cloud.Identity` |   |

### projectOwner(String projectId)

    public static Identity projectOwner(String projectId)

Returns a new project owner identity.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `projectId` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` A Google Cloud Platform project ID. For example, *my-sample-project*. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-core/latest/com.google.cloud.Identity` |   |

### projectViewer(String projectId)

    public static Identity projectViewer(String projectId)

Returns a new project viewer identity.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `projectId` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` A Google Cloud Platform project ID. For example, *my-sample-project*. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-core/latest/com.google.cloud.Identity` |   |

### serviceAccount(String email)

    public static Identity serviceAccount(String email)

Returns a new service account identity.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `email` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` An email address that represents a service account. For example, *my-other-app@appspot.gserviceaccount.com*. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-core/latest/com.google.cloud.Identity` |   |

### user(String email)

    public static Identity user(String email)

Returns a new user identity.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `email` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` An email address that represents a specific Google account. For example, *alice@gmail.com* or *joe@example.com*. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-core/latest/com.google.cloud.Identity` |   |

### valueOf(String identityStr)

    public static Identity valueOf(String identityStr)

Converts a string to an `Identity`. Used primarily for converting protobuf-generated
policy identities to `Identity` objects.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `identityStr` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-core/latest/com.google.cloud.Identity` |   |

## Methods

### equals(Object obj)

    public boolean equals(Object obj)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `obj` | `https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html` |

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

**Overrides** [Object.equals(Object)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-)

### getType()

    public Identity.Type getType()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-core/latest/com.google.cloud.Identity.Type` |   |

### getValue()

    public String getValue()

Returns the string identifier for this identity. The value corresponds to:

- email address (for identities of type `USER`, `SERVICE_ACCOUNT`, and `
  GROUP`)
- domain (for identities of type `DOMAIN`)
- `null` (for identities of type `ALL_USERS` and `
  ALL_AUTHENTICATED_USERS`)

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

### hashCode()

    public int hashCode()

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

**Overrides** [Object.hashCode()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--)

### strValue()

    public String strValue()

Returns the string value associated with the identity. Used primarily for converting from
`Identity` objects to strings for protobuf-generated policies.

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

### toString()

    public String toString()

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

**Overrides** [Object.toString()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--)