List organization accounts

client.Organizations.OrganizationAccounts.Get(ctx, organizationID, query) (*[]TenantAccount, error)

GET/organizations/{organization_id}/accounts

Retrieve the accounts immediately attached to a specific organization. Accounts attached to sub-organizations are not included. (Currently in Public Beta - see https://api-docs.dnstools.im/fundamentals/organizations/)

Security

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

ParametersExpand Collapse

organizationID string

query OrganizationAccountGetParams

AccountPubname param.Field[OrganizationAccountGetParamsAccountPubname]Optional

Contains stringOptional

(case-insensitive) Filter the list of accounts to where the account_pubname contains a particular string.

EndsWith stringOptional

(case-insensitive) Filter the list of accounts to where the account_pubname ends with a particular string.

StartsWith stringOptional

(case-insensitive) Filter the list of accounts to where the account_pubname starts with a particular string.

Direction param.Field[OrganizationAccountGetParamsDirection]Optional

Sort direction for the order_by field. Valid values: asc, desc. Defaults to asc when order_by is specified.

const OrganizationAccountGetParamsDirectionAsc OrganizationAccountGetParamsDirection = "asc"

const OrganizationAccountGetParamsDirectionDesc OrganizationAccountGetParamsDirection = "desc"

IncludeTags param.Field[bool]Optional

Include Account tags from the resource tag mirror. Omit this parameter to preserve the existing Account response shape.

IncludeTotal param.Field[bool]Optional

Whether to calculate and return the exact result_info.total_size for cursor pagination. Defaults to true. When false, total_size is omitted. page_size and include_total may change between pages; next_page_token remains the authoritative continuation signal. Legacy page/per_page requests always calculate total_count.

Name param.Field[OrganizationAccountGetParamsName]Optional

Contains stringOptional

(case-insensitive) Filter the list of accounts to where the name contains a particular string.

EndsWith stringOptional

(case-insensitive) Filter the list of accounts to where the name ends with a particular string.

StartsWith stringOptional

(case-insensitive) Filter the list of accounts to where the name starts with a particular string.

OrderBy param.Field[OrganizationAccountGetParamsOrderBy]Optional

Field to order results by. Currently supported values: account_name. When not specified, results are ordered by internal account ID.

const OrganizationAccountGetParamsOrderByAccountName OrganizationAccountGetParamsOrderBy = "account_name"

PageSize param.Field[int64]Optional

The amount of items to return. Defaults to 10.

maximum1000

minimum0

PageToken param.Field[string]Optional

An opaque token returned from the last list response that when provided will retrieve the next page.

Parameters used to filter the retrieved list must remain in subsequent requests with a page token.

ReturnsExpand Collapse

type OrganizationAccountGetResponseEnvelopeResult []TenantAccount

ID string

CreatedOn Time

formatdate-time

Name string

Settings TenantAccountSettings

AbuseContactEmail string

AccessApprovalExpiry Time

formatdate-time

APIAccessEnabled bool

DeprecatedDefaultNameservers string

Use DNS Settings instead. Deprecated.

EnforceTwofactor bool

DeprecatedUseAccountCustomNSByDefault bool

Use DNS Settings instead. Deprecated.

Type TenantAccountType

One of the following:

const TenantAccountTypeStandard TenantAccountType = "standard"

const TenantAccountTypeEnterprise TenantAccountType = "enterprise"

Tags map[string, string]Optional

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

List organization accounts

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/option"
  "github.com/cloudflare/cloudflare-go/organizations"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
    option.WithAPIEmail("user@example.com"),
  )
  tenantAccounts, err := client.Organizations.OrganizationAccounts.Get(
    context.TODO(),
    "a7b9c3d2e8f4a1b5c6d0e9f2a3b7c4d8",
    organizations.OrganizationAccountGetParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", tenantAccounts)
}

{
  "errors": [],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "id": "id",
      "created_on": "2019-12-27T18:11:19.117Z",
      "name": "name",
      "settings": {
        "abuse_contact_email": "abuse_contact_email",
        "access_approval_expiry": "2019-12-27T18:11:19.117Z",
        "api_access_enabled": true,
        "default_nameservers": "default_nameservers",
        "enforce_twofactor": true,
        "use_account_custom_ns_by_default": true
      },
      "type": "standard",
      "tags": {
        "foo": "string"
      }
    }
  ],
  "result_info": {
    "next_page_token": "next_page_token",
    "total_size": 0
  },
  "success": true
}

Returns Examples

{
  "errors": [],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "id": "id",
      "created_on": "2019-12-27T18:11:19.117Z",
      "name": "name",
      "settings": {
        "abuse_contact_email": "abuse_contact_email",
        "access_approval_expiry": "2019-12-27T18:11:19.117Z",
        "api_access_enabled": true,
        "default_nameservers": "default_nameservers",
        "enforce_twofactor": true,
        "use_account_custom_ns_by_default": true
      },
      "type": "standard",
      "tags": {
        "foo": "string"
      }
    }
  ],
  "result_info": {
    "next_page_token": "next_page_token",
    "total_size": 0
  },
  "success": true
}