Stay organized with collections
Save and categorize content based on your preferences.
A unique identifier for an entity in the Cloud Identity Groups API.
An entity can represent either a group with an optional namespace or a user without a namespace. The combination of id and namespace must be unique; however, the same id can be used with different namespaces.
JSON representation
{"id": string,"namespace": string}
Fields
id
string
The ID of the entity.
For Google-managed entities, the id should be the email address of an existing group or user. Email addresses need to adhere to name guidelines for users and groups.
For external-identity-mapped entities, the id must be a string conforming to the Identity Source's requirements.
Must be unique within a namespace.
namespace
string
The namespace in which the entity exists.
If not specified, the EntityKey represents a Google-managed entity such as a Google user or a Google Group.
If specified, the EntityKey represents an external-identity-mapped group. The namespace must correspond to an identity source created in Admin Console and must be in the form of identitysources/{identity_source}.
[[["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 2025-05-21 UTC."],[[["\u003cp\u003eAn \u003ccode\u003eEntityKey\u003c/code\u003e uniquely identifies either a group (with an optional \u003ccode\u003enamespace\u003c/code\u003e) or a user (without a \u003ccode\u003enamespace\u003c/code\u003e) in the Cloud Identity Groups API.\u003c/p\u003e\n"],["\u003cp\u003eThe combination of \u003ccode\u003eid\u003c/code\u003e and \u003ccode\u003enamespace\u003c/code\u003e must be unique, but the same \u003ccode\u003eid\u003c/code\u003e can be used across different \u003ccode\u003enamespace\u003c/code\u003es.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eid\u003c/code\u003e field represents the entity's unique ID, which should be an email address for Google-managed entities or a string for external-identity-mapped entities, adhering to their respective requirements.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003enamespace\u003c/code\u003e field, when specified, indicates that the \u003ccode\u003eEntityKey\u003c/code\u003e represents an external-identity-mapped group and must correspond to an existing identity source in the format \u003ccode\u003eidentitysources/{identity_source}\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# EntityKey\n\nA unique identifier for an entity in the Cloud Identity Groups API.\n\nAn entity can represent either a group with an optional `namespace` or a user without a `namespace`. The combination of `id` and `namespace` must be unique; however, the same `id` can be used with different `namespace`s."]]
