Organization Accounts

List organization accounts

GET/organizations/{organization_id}/accounts

ModelsExpand Collapse

OrganizationAccounts object { id, name, type, 4 more }

id: string

Identifier

maxLength32

minLength32

name: string

Account name

type: "standard" or "enterprise"

One of the following:

"standard"

"enterprise"

created_on: optional string

Timestamp for the creation of the account

formatdate-time

legacy_flags: optional object { enterprise_zone_quota }

Legacy account flags.

enterprise_zone_quota: optional object { available, current, maximum }

Enterprise zone quota for standard and enterprise accounts. Accounts without a quota have a maximum of 0.

available: optional number

Number of additional Enterprise zones available. Returns 0 if the quota is not allocated or is exhausted.

current: optional number

Current number of Enterprise zones.

maximum: optional number

Maximum number of Enterprise zones allowed.

managed_by: optional object { parent_org_id, parent_org_name, root_org_id, should_display_parent_orgs }

Parent container details

parent_org_id: optional string

ID of the parent Organization, if one exists

maxLength32

parent_org_name: optional string

Name of the parent Organization, if one exists

root_org_id: optional string

ID of the root Organization, if one exists

maxLength32

should_display_parent_orgs: optional boolean

Indicates whether the parent Organization hierarchy should be displayed

settings: optional object { abuse_contact_email, enforce_twofactor }

Account settings

abuse_contact_email: optional string

Sets an abuse contact email to notify for abuse reports.

enforce_twofactor: optional boolean

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

OrganizationAccountGetResponse = array of TenantAccount { id, created_on, name, 3 more } or object { account_pubname, account_tag, account_type, 2 more }

One of the following:

TenantAccount object { id, created_on, name, 3 more }

id: string

created_on: string

formatdate-time

name: string

settings: object { abuse_contact_email, access_approval_expiry, api_access_enabled, 3 more }

abuse_contact_email: string

access_approval_expiry: string

formatdate-time

api_access_enabled: boolean

Deprecateddefault_nameservers: string

Use DNS Settings instead. Deprecated.

enforce_twofactor: boolean

Deprecateduse_account_custom_ns_by_default: boolean

Use DNS Settings instead. Deprecated.

type: "standard" or "enterprise"

One of the following:

"standard"

"enterprise"

tags: optional map[string]

Account tags, present only when include_tags=true is requested.

OrganizationsAPILegacyAccount object { account_pubname, account_tag, account_type, 2 more }

account_pubname: string

account_tag: string

account_type: "standard" or "enterprise"

One of the following:

"standard"

"enterprise"

created_on: string

formatdate-time

settings: object { access_approval_expiry, api_access_enabled, enforce_two_factor, use_account_custom_ns_by_default }

access_approval_expiry: string

formatdate-time

api_access_enabled: boolean

enforce_two_factor: boolean

use_account_custom_ns_by_default: boolean