Class Identity (2.28.0)

public final class Identity implements Serializable

An identity in a 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

Inheritance

Object > Identity

Implements

Serializable

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.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
`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
`Identity`

domain(String domain)

public static Identity domain(String domain)

Returns a new domain identity.

Parameter
Name	Description
`domain`	`String` A Google Apps domain name that represents all the users of that domain. For example, google.com or example.com.

Returns
Type	Description
`Identity`

group(String email)

public static Identity group(String email)

Returns a new group identity.

Parameter
Name	Description
`email`	`String` An email address that represents a Google group. For example, admins@example.com.

Returns
Type	Description
`Identity`

projectEditor(String projectId)

public static Identity projectEditor(String projectId)

Returns a new project editor identity.

Parameter
Name	Description
`projectId`	`String` A Google Cloud Platform project ID. For example, my-sample-project.

Returns
Type	Description
`Identity`

projectOwner(String projectId)

public static Identity projectOwner(String projectId)

Returns a new project owner identity.

Parameter
Name	Description
`projectId`	`String` A Google Cloud Platform project ID. For example, my-sample-project.

Returns
Type	Description
`Identity`

projectViewer(String projectId)

public static Identity projectViewer(String projectId)

Returns a new project viewer identity.

Parameter
Name	Description
`projectId`	`String` A Google Cloud Platform project ID. For example, my-sample-project.

Returns
Type	Description
`Identity`

serviceAccount(String email)

public static Identity serviceAccount(String email)

Returns a new service account identity.

Parameter
Name	Description
`email`	`String` An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.

Returns
Type	Description
`Identity`

user(String email)

public static Identity user(String email)

Returns a new user identity.

Parameter
Name	Description
`email`	`String` An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.

Returns
Type	Description
`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`	`String`

Returns
Type	Description
`Identity`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

Object.equals(Object)

getType()

public Identity.Type getType()

Returns
Type	Description
`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
`String`

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

Object.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
`String`

toString()

public String toString()

Returns
Type	Description
`String`

Overrides

Object.toString()