List organization members

client.Organizations.Members.List(ctx, organizationID, query) (*SinglePage[OrganizationMember], error)

GET/organizations/{organization_id}/members

List memberships for an Organization. (Currently in Closed Beta - see https://developers.cloudflare.com/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 MemberListParams

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.

Status param.Field[[]MemberListParamsStatus]optional

Filter the list of memberships by membership status.

const MemberListParamsStatusActive MemberListParamsStatus = "active"

const MemberListParamsStatusCanceled MemberListParamsStatus = "canceled"

User param.Field[MemberListParamsUser]optional

Email stringoptional

Filter the list of memberships for a specific email that ends with a substring.

ReturnsExpand Collapse

type OrganizationMember struct{…}

ID string

Organization Member ID

CreateTime Time

formatdate-time

Meta map[string, unknown]

Status OrganizationMemberStatus

One of the following:

const OrganizationMemberStatusActive OrganizationMemberStatus = "active"

const OrganizationMemberStatusCanceled OrganizationMemberStatus = "canceled"

UpdateTime Time

formatdate-time

User OrganizationMemberUser

ID string

Email string

Name string

TwoFactorAuthenticationEnabled bool

List organization members

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"),
  )
  page, err := client.Organizations.Members.List(
    context.TODO(),
    "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8",
    organizations.MemberListParams{

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

{
  "errors": [],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "id": "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8",
      "create_time": "2019-12-27T18:11:19.117Z",
      "meta": {
        "foo": {}
      },
      "status": "active",
      "update_time": "2019-12-27T18:11:19.117Z",
      "user": {
        "id": "id",
        "email": "email",
        "name": "name",
        "two_factor_authentication_enabled": true
      }
    }
  ],
  "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": "a7b9c3d2e8f4g1h5i6j0k9l2m3n7o4p8",
      "create_time": "2019-12-27T18:11:19.117Z",
      "meta": {
        "foo": {}
      },
      "status": "active",
      "update_time": "2019-12-27T18:11:19.117Z",
      "user": {
        "id": "id",
        "email": "email",
        "name": "name",
        "two_factor_authentication_enabled": true
      }
    }
  ],
  "result_info": {
    "next_page_token": "next_page_token",
    "total_size": 0
  },
  "success": true
}