Skip to content
Console
Menu

Generated Assets

Workflows

Getting Started

Authentication

KV Store

Get an identity

Gets an identity of an end user.

Gets an identity of an end user.

  • Path GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/end_users/end-user/identities/identity
  • Scope auth:read
  • Effect read — nothing is written.
  • Collection identities

#Request

FieldTypeWhat it is
namestringThe name of the identity to get. Required.

#Response

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/end_users/{end_user}/identities/{identity}.
uidstringThe identity's id; never reused. Output only.
metaResourceMetaResource metadata.
typeIdentityTypeWhat kind of sign-in this is. Output only. One of password, email, oidc, device, passkey.
providerstringThe provider of a federated identity (google, apple,...); empty otherwise. Output only.
fingerprintstringA one-way digest of the provider and the provider's subject (or of the device credential's verifier). It identifies the identity in an audit trail and reveals neither. Output only.
link_timetimestampWhen the identity was linked. Output only.
last_use_timetimestampThe last sign-in with this identity, when known. Output only.

#ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only.
create_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

#Errors

Every error arrives in the body Errors describes.

#Examples

curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/end_users/end-user/identities/identity" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"