List User Group Members

client.IAM.UserGroups.Members.List(ctx, userGroupID, params) (*V4PagePaginationArray[UserGroupMemberListResponse], error)

GET/accounts/{account_id}/iam/user_groups/{user_group_id}/members

List all the members attached to a user group.

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

Accepted Permissions (at least one required)

SCIM ProvisioningAccount Settings WriteAccount Settings Read

ParametersExpand Collapse

userGroupID string

User Group identifier tag.

maxLength32

minLength32

params UserGroupMemberListParams

AccountID param.Field[string]

Path param: Account identifier tag.

maxLength32

minLength32

Direction param.Field[UserGroupMemberListParamsDirection]Optional

Query param: The sort order of returned user group members by email.

const UserGroupMemberListParamsDirectionAsc UserGroupMemberListParamsDirection = "asc"

const UserGroupMemberListParamsDirectionDesc UserGroupMemberListParamsDirection = "desc"

FuzzyEmail param.Field[string]Optional

Query param: A string used for filtering members by partial email match.

Page param.Field[float64]Optional

Query param: Page number of paginated results.

minimum1

PerPage param.Field[float64]Optional

Query param: Maximum number of results per page.

maximum500

minimum1

ReturnsExpand Collapse

type UserGroupMemberListResponse struct{…}

Member attached to a User Group.

ID string

Account member identifier.

Email stringOptional

The contact email address of the user.

maxLength90

Status UserGroupMemberListResponseStatusOptional

The member’s status in the account.

One of the following:

const UserGroupMemberListResponseStatusAccepted UserGroupMemberListResponseStatus = "accepted"

const UserGroupMemberListResponseStatusPending UserGroupMemberListResponseStatus = "pending"

List User Group Members

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/cloudflare-go"
  "github.com/stainless-sdks/cloudflare-go/iam"
  "github.com/stainless-sdks/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"),
    option.WithAPIEmail("user@example.com"),
  )
  page, err := client.IAM.UserGroups.Members.List(
    context.TODO(),
    "023e105f4ecef8ad9ca31a8372d0c353",
    iam.UserGroupMemberListParams{
      AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "id": "4f5f0c14a2a41d5063dd301b2f829f04",
      "email": "user@example.com",
      "status": "accepted"
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": [
    {
      "id": "4f5f0c14a2a41d5063dd301b2f829f04",
      "email": "user@example.com",
      "status": "accepted"
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}