Docs
/
/

auth Management API reference

Complete reference documentation for the auth resource.

#

Endpoints

Verify scope

#

Return information about the current calling scope. Will either be a service token or from an OAuth context.

Endpoint

GET/v1/whoami

Returns

WhoamiResponse

Information about the current calling scope.

account_features
object

Account plan features and limits.

batch_items_render_limit_allowed
boolean

Whether batch rendering limits can be configured.

custom_branding_allowed
boolean

Whether custom branding can be applied to notifications.

data_retention_days
integer

Number of days data is retained, null for unlimited retention.

data_warehouse_extension_allowed
boolean

Whether data warehouse integration extensions are available.

datadog_extension_allowed
boolean

Whether Datadog integration extension is available.

dsync_allowed
boolean

Whether directory sync functionality is available.

guides_monthly_notified_recipients_limit
integer

Monthly limit for guide notification recipients, null for unlimited.

guides_per_tenant_scope_allowed
boolean

Whether per-tenant scope for guide messages is allowed.

heap_extension_allowed
boolean

Whether Heap integration extension is available.

knock_branding_required
boolean

Whether Knock branding is required to be displayed.

litmus_email_preview_allowed
boolean

Whether Litmus email preview integration is available.

message_sent_limit
integer

Monthly limit for messages sent, null for unlimited.

new_relic_extension_allowed
boolean

Whether New Relic integration extension is available.

segment_extension_allowed
boolean

Whether Segment integration extension is available.

self_serve_allowed
boolean

Whether self-service account management features are available.

sso_allowed
boolean

Whether single sign-on (SSO) is enabled for the account.

tenant_preferences_allowed
boolean

Whether tenant-level preferences are supported.

translations_allowed
boolean

Whether multi-language translations are supported.

account_name
string

The display name of the account.

account_slug
string

The unique slug identifier for the account.

service_token_name
string

The name of the service token if authenticated via service token, null for OAuth contexts.

type
enum(string)

The type of authentication context - either a service token or OAuth user context.

service_tokenoauth_context
user_id
string

The ID of the authenticated user if in OAuth context, null for service token contexts.

New chat