API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

User

Get User Details

client.user.get(RequestOptionsoptions?): User { id, email, first_name, last_name }

GET/v1/user

ModelsExpand Collapse

User { id, email, first_name, last_name }

User details.

id: string

Unique identifier for the User.

email: string

Email address of the user.

first_name: string | null

First name of the user.

last_name: string | null

Last name of the user.

UserSecurity

Get User Security Settings

client.user.security.get(RequestOptionsoptions?): UserSecurity { source_ip_rule, created_at, updated_at }

GET/v1/user/security

Update User Security Settings

client.user.security.update(SecurityUpdateParams { source_ip_rule } body, RequestOptionsoptions?): UserSecurity { source_ip_rule, created_at, updated_at }

PATCH/v1/user/security

ModelsExpand Collapse

UserSecurity { source_ip_rule, created_at, updated_at }

User security settings response.

source_ip_rule: SourceIPRuleResponse { allowed, blocked }

IP filter rules.

allowed: Array<string>

List of IPv4 CIDR addresses to allow.

blocked: Array<string>

List of IPv4 CIDR addresses to deny.

created_at?: string

When the user security settings were created.

formatdate-time

updated_at?: string

When the user security settings were updated.

formatdate-time