Class Identity (2.43.0)
Stay organized with collections
Save and categorize content based on your preferences.
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
Static Methods
allAuthenticatedUsers()
public static Identity allAuthenticatedUsers()
Returns a new identity representing anyone who is authenticated with a Google account or a
service account.
allUsers()
public static Identity allUsers()
Returns a new identity representing anyone who is on the internet; with or without a Google
account.
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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
|
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter |
Name |
Description |
obj |
Object
|
Overrides
getType()
public Identity.Type getType()
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()
Returns |
Type |
Description |
int |
|
Overrides
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()
Returns |
Type |
Description |
String |
|
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-03 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
{"lastModified": "Last updated 2024-10-03 UTC."}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-10-03 UTC."]]