Objects

CallerIdentity

Fields

• principalstringrequired

  How the caller signed in: with an organization API key, with a user session, or with an OAuth app token (oauth_token, since 1.62.0). This is an extensible enumeration: clients must skip unknown values.

  Allowed values: api_keysessionoauth_token

• orgCallerOrgrequired
• appCallerApp

  The OAuth app of the token; absent when the caller signs in with an API key or a session. Added in 1.62.0.

• keyCallerKey | nullrequired

  The API key of the request; null for a session.

• userCallerUser | nullrequired

  The session user; null for an API key.

• roleRolerequired
• scopesarray of string | nullrequired

  The key's effective scopes (set explicitly or derived from the key's role); null for a session, which has no scopes.

• data_profileCallerDataProfile | nullrequired

  The data profile the request runs with; null if there is none.

• expires_atstring (date-time) | nullrequired

  When the key or the session expires (RFC 3339, UTC); null if it does not expire.

• rate_limitCallerRateLimitrequired

Used by

• GET/v1/meGet the caller of the API