Skip to main content

WhoAmIResponse

Datalayer Core


Datalayer Core / WhoAmIResponse

Interface: WhoAmIResponse

Defined in: tech/datalayer/core/src/api/types/iam.ts:127

Response from the /whoami endpoint WhoAmIResponse

Properties​

message​

message: string

Defined in: tech/datalayer/core/src/api/types/iam.ts:131

Response message from the server


profile​

profile: object

Defined in: tech/datalayer/core/src/api/types/iam.ts:133

User profile information

Index Signature​

[key: string]: any

Allow additional fields that may come from the server

avatar_url_s?​

optional avatar_url_s: string

Avatar URL

creation_ts_dt​

creation_ts_dt: string

ISO 8601 timestamp of when the user was created

credits_customer_uid?​

optional credits_customer_uid: null | string

Credits customer UID for billing

customer_uid?​

optional customer_uid: null | string

Customer UID

email_s​

email_s: string

Email address

email_token_s?​

optional email_token_s: null | string

Email verification token

email_update_s?​

optional email_update_s: null | string

Pending email update

events?​

optional events: any[]

User events (nested structure - not typed in detail)

first_name_t​

first_name_t: string

First name

handle_s​

handle_s: string

User handle

iam_providers?​

optional iam_providers: any[]

IAM providers (nested structure - not typed in detail)

id​

id: string

Unique identifier for the user

join_request_ts_dt​

join_request_ts_dt: null | string

ISO 8601 timestamp of when the user requested to join

join_ts_dt​

join_ts_dt: string

ISO 8601 timestamp of when the user joined

last_name_t​

last_name_t: string

Last name

last_update_ts_dt​

last_update_ts_dt: string

ISO 8601 timestamp of last update

linked_contact_uid?​

optional linked_contact_uid: null | string

Linked contact UID

mfa_secret_s?​

optional mfa_secret_s: null | string

MFA secret

mfa_url_s?​

optional mfa_url_s: null | string

MFA URL

new_password_confirmation_ts_dt?​

optional new_password_confirmation_ts_dt: null | string

New password confirmation timestamp

new_password_request_ts_dt?​

optional new_password_request_ts_dt: null | string

New password request timestamp

onboarding_s?​

optional onboarding_s: string

Onboarding state as JSON string

origin_s​

origin_s: string

Origin of the user account

roles_ss?​

optional roles_ss: string[]

User roles array

settings?​

optional settings: any

User settings (nested structure - not typed in detail)

type_s​

type_s: string

Type of the record

uid​

uid: string

User ID

unsubscribed_from_outbounds_b?​

optional unsubscribed_from_outbounds_b: boolean

Email unsubscription status


success​

success: boolean

Defined in: tech/datalayer/core/src/api/types/iam.ts:129

Whether the request was successful