User

User Details

client.User.Get(ctx) (*UserGetResponse, error)

GET/user

Edit User

client.User.Edit(ctx, body) (*UserEditResponse, error)

PATCH/user

UserAudit Logs

Get user audit logs

client.User.AuditLogs.List(ctx, query) (*V4PagePaginationArray[AuditLog], error)

GET/user/audit_logs

UserBilling

UserBillingHistory

Billing History Details

Deprecated

client.User.Billing.History.List(ctx, query) (*V4PagePaginationArray[BillingHistory], error)

GET/user/billing/history

ModelsExpand Collapse

type BillingHistory struct{…}

ID string

Billing item identifier tag.

maxLength32

Action string

The billing item action.

maxLength30

Amount float64

The amount associated with this billing item.

Currency string

The monetary unit in which pricing information is displayed.

Description string

The billing item description.

maxLength255

OccurredAt Time

When the billing item was created.

formatdate-time

Type string

The billing item type.

maxLength30

Zone BillingHistoryZone

Name stringoptional

UserBillingProfile

Billing Profile Details

Deprecated

client.User.Billing.Profile.Get(ctx) (*BillingProfileGetResponse, error)

GET/user/billing/profile

UserInvites

List Invitations

client.User.Invites.List(ctx) (*SinglePage[Invite], error)

GET/user/invites

Invitation Details

client.User.Invites.Get(ctx, inviteID) (*Invite, error)

GET/user/invites/{invite_id}

Respond to Invitation

client.User.Invites.Edit(ctx, inviteID, body) (*Invite, error)

PATCH/user/invites/{invite_id}

ModelsExpand Collapse

type Invite struct{…}

InvitedMemberID string

ID of the user to add to the organization.

maxLength32

OrganizationID string

ID of the organization the user will be added to.

maxLength32

ID stringoptional

Invite identifier tag.

maxLength32

ExpiresOn Timeoptional

When the invite is no longer active.

formatdate-time

InvitedBy stringoptional

The email address of the user who created the invite.

maxLength90

InvitedMemberEmail stringoptional

Email address of the user to add to the organization.

maxLength90

InvitedOn Timeoptional

When the invite was sent.

formatdate-time

OrganizationIsEnforcingTwofactor booloptional

OrganizationName stringoptional

Organization name.

maxLength100

Roles []stringoptional

List of role names the membership has for this account.

Status InviteStatusoptional

Current status of the invitation.

One of the following:

const InviteStatusPending InviteStatus = "pending"

const InviteStatusAccepted InviteStatus = "accepted"

const InviteStatusRejected InviteStatus = "rejected"

const InviteStatusExpired InviteStatus = "expired"

UserOrganizations

List Organizations

Deprecated

client.User.Organizations.List(ctx, query) (*V4PagePaginationArray[Organization], error)

GET/user/organizations

Organization Details

Deprecated

client.User.Organizations.Get(ctx, organizationID) (*OrganizationGetResponse, error)

GET/user/organizations/{organization_id}

Leave Organization

Deprecated

client.User.Organizations.Delete(ctx, organizationID) (*OrganizationDeleteResponse, error)

DELETE/user/organizations/{organization_id}

ModelsExpand Collapse

type Organization struct{…}

ID stringoptional

Identifier

maxLength32

minLength32

Name stringoptional

Organization name.

maxLength100

Permissions []Permissionoptional

Access permissions for this User.

Roles []stringoptional

List of roles that a user has within an organization.

Status Statusoptional

Whether the user is a member of the organization or has an invitation pending.

UserSubscriptions

Get User Subscriptions

client.User.Subscriptions.Get(ctx) (*SinglePage[Subscription], error)

GET/user/subscriptions

Update User Subscription

client.User.Subscriptions.Update(ctx, identifier, body) (*unknown, error)

PUT/user/subscriptions/{identifier}

Delete User Subscription

client.User.Subscriptions.Delete(ctx, identifier) (*SubscriptionDeleteResponse, error)

DELETE/user/subscriptions/{identifier}

UserTokens

List Tokens

client.User.Tokens.List(ctx, query) (*V4PagePaginationArray[Token], error)

GET/user/tokens

Token Details

client.User.Tokens.Get(ctx, tokenID) (*Token, error)

GET/user/tokens/{token_id}

Create Token

client.User.Tokens.New(ctx, body) (*TokenNewResponse, error)

POST/user/tokens

Update Token

client.User.Tokens.Update(ctx, tokenID, body) (*Token, error)

PUT/user/tokens/{token_id}

Delete Token

client.User.Tokens.Delete(ctx, tokenID) (*TokenDeleteResponse, error)

DELETE/user/tokens/{token_id}

Verify Token

client.User.Tokens.Verify(ctx) (*TokenVerifyResponse, error)

GET/user/tokens/verify

UserTokensPermission Groups

List Token Permission Groups

client.User.Tokens.PermissionGroups.List(ctx, query) (*SinglePage[TokenPermissionGroupListResponse], error)

GET/user/tokens/permission_groups

UserTokensValue

Roll Token

client.User.Tokens.Value.Update(ctx, tokenID, body) (*TokenValue, error)

PUT/user/tokens/{token_id}/value