Accounts

List Accounts

client.Accounts.List(ctx, query) (*V4PagePaginationArray[Account], error)

GET/accounts

Account Details

client.Accounts.Get(ctx, query) (*Account, error)

GET/accounts/{account_id}

Create an account

client.Accounts.New(ctx, body) (*Account, error)

POST/accounts

Update Account

client.Accounts.Update(ctx, params) (*Account, error)

PUT/accounts/{account_id}

Delete a specific account

client.Accounts.Delete(ctx, body) (*AccountDeleteResponse, error)

DELETE/accounts/{account_id}

ModelsExpand Collapse

type Account struct{…}

ID string

Identifier

maxLength32

minLength32

Name string

Account name

maxLength100

Type AccountType

One of the following:

const AccountTypeStandard AccountType = "standard"

const AccountTypeEnterprise AccountType = "enterprise"

CreatedOn Timeoptional

Timestamp for the creation of the account

formatdate-time

ManagedBy AccountManagedByoptional

Parent container details

ParentOrgID stringoptional

ID of the parent Organization, if one exists

maxLength32

ParentOrgName stringoptional

Name of the parent Organization, if one exists

Settings AccountSettingsoptional

Account settings

AbuseContactEmail stringoptional

Sets an abuse contact email to notify for abuse reports.

EnforceTwofactor booloptional

Indicates whether membership in this account requires that Two-Factor Authentication is enabled

AccountsAccount Organizations

Move account

client.Accounts.AccountOrganizations.New(ctx, params) (*AccountOrganizationNewResponse, error)

POST/accounts/{account_id}/move

AccountsAccount Profile

Get account profile

client.Accounts.AccountProfile.Get(ctx, query) (*AccountProfile, error)

GET/accounts/{account_id}/profile

Modify account profile

client.Accounts.AccountProfile.Update(ctx, params) error

PUT/accounts/{account_id}/profile

ModelsExpand Collapse

type AccountProfile struct{…}

BusinessAddress string

BusinessEmail string

BusinessName string

BusinessPhone string

ExternalMetadata string

AccountsMembers

List Members

client.Accounts.Members.List(ctx, params) (*V4PagePaginationArray[Member], error)

GET/accounts/{account_id}/members

Member Details

client.Accounts.Members.Get(ctx, memberID, query) (*Member, error)

GET/accounts/{account_id}/members/{member_id}

Add Member

client.Accounts.Members.New(ctx, params) (*Member, error)

POST/accounts/{account_id}/members

Update Member

client.Accounts.Members.Update(ctx, memberID, params) (*Member, error)

PUT/accounts/{account_id}/members/{member_id}

Remove Member

client.Accounts.Members.Delete(ctx, memberID, body) (*MemberDeleteResponse, error)

DELETE/accounts/{account_id}/members/{member_id}

ModelsExpand Collapse

type Status string

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

One of the following:

const StatusMember Status = "member"

const StatusInvited Status = "invited"

AccountsRoles

List Roles

client.Accounts.Roles.List(ctx, params) (*V4PagePaginationArray[Role], error)

GET/accounts/{account_id}/roles

Role Details

client.Accounts.Roles.Get(ctx, roleID, query) (*Role, error)

GET/accounts/{account_id}/roles/{role_id}

AccountsSubscriptions

List Subscriptions

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

GET/accounts/{account_id}/subscriptions

Create Subscription

client.Accounts.Subscriptions.New(ctx, params) (*Subscription, error)

POST/accounts/{account_id}/subscriptions

Update Subscription

client.Accounts.Subscriptions.Update(ctx, subscriptionIdentifier, params) (*Subscription, error)

PUT/accounts/{account_id}/subscriptions/{subscription_identifier}

Delete Subscription

client.Accounts.Subscriptions.Delete(ctx, subscriptionIdentifier, body) (*SubscriptionDeleteResponse, error)

DELETE/accounts/{account_id}/subscriptions/{subscription_identifier}

AccountsTokens

List Tokens

client.Accounts.Tokens.List(ctx, params) (*V4PagePaginationArray[Token], error)

GET/accounts/{account_id}/tokens

Token Details

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

GET/accounts/{account_id}/tokens/{token_id}

Create Token

client.Accounts.Tokens.New(ctx, params) (*TokenNewResponse, error)

POST/accounts/{account_id}/tokens

Update Token

client.Accounts.Tokens.Update(ctx, tokenID, params) (*Token, error)

PUT/accounts/{account_id}/tokens/{token_id}

Delete Token

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

DELETE/accounts/{account_id}/tokens/{token_id}

Verify Token

client.Accounts.Tokens.Verify(ctx, query) (*TokenVerifyResponse, error)

GET/accounts/{account_id}/tokens/verify

AccountsTokensPermission Groups

List Permission Groups

client.Accounts.Tokens.PermissionGroups.List(ctx, params) (*SinglePage[TokenPermissionGroupListResponse], error)

GET/accounts/{account_id}/tokens/permission_groups

List Permission Groups

client.Accounts.Tokens.PermissionGroups.Get(ctx, params) (*[]TokenPermissionGroupGetResponse, error)

GET/accounts/{account_id}/tokens/permission_groups

AccountsTokensValue

Roll Token

client.Accounts.Tokens.Value.Update(ctx, tokenID, params) (*TokenValue, error)

PUT/accounts/{account_id}/tokens/{token_id}/value

AccountsLogs

AccountsLogsAudit

Get account audit logs (Version 2)

client.Accounts.Logs.Audit.List(ctx, params) (*CursorPaginationAfter[LogAuditListResponse], error)

GET/accounts/{account_id}/logs/audit