Skip to content
Cloudflare API
Start here
API Reference
IAM
User Groups

Members

List User Group Members
client.iam.userGroups.members.list(stringuserGroupId, MemberListParams { account_id, direction, fuzzyEmail, 2 more } params, RequestOptionsoptions?): V4PagePaginationArray<MemberListResponse { id, email, status } >
GET/accounts/{account_id}/iam/user_groups/{user_group_id}/members
Get User Group Member
client.iam.userGroups.members.get(stringuserGroupId, stringmemberId, MemberGetParams { account_id } params, RequestOptionsoptions?): MemberGetResponse { id, created_at, email, 2 more }
GET/accounts/{account_id}/iam/user_groups/{user_group_id}/members/{member_id}
Add User Group Members
client.iam.userGroups.members.create(stringuserGroupId, MemberCreateParams { account_id, members } params, RequestOptionsoptions?): SinglePage<MemberCreateResponse { id, email, status } >
POST/accounts/{account_id}/iam/user_groups/{user_group_id}/members
Update User Group Members
client.iam.userGroups.members.update(stringuserGroupId, MemberUpdateParams { account_id, members } params, RequestOptionsoptions?): SinglePage<MemberUpdateResponse { id, email, status } >
PUT/accounts/{account_id}/iam/user_groups/{user_group_id}/members
Remove User Group Member
client.iam.userGroups.members.delete(stringuserGroupId, stringmemberId, MemberDeleteParams { account_id } params, RequestOptionsoptions?): MemberDeleteResponse { id, email, status }
DELETE/accounts/{account_id}/iam/user_groups/{user_group_id}/members/{member_id}
ModelsExpand Collapse
MemberListResponse { id, email, status }

Member attached to a User Group.

id: string

Account member identifier.

email?: string

The contact email address of the user.

maxLength90
status?: "accepted" | "pending"

The member’s status in the account.

One of the following:
"accepted"
"pending"
MemberGetResponse { id, created_at, email, 2 more }

Detailed member information for a User Group member.

id: string

Account member identifier.

created_at?: string

When the member was added to the user group.

formatdate-time
email?: string

The contact email address of the user.

maxLength90
status?: "accepted" | "pending"

The member’s status in the account.

One of the following:
"accepted"
"pending"
user?: User { id, email, first_name, last_name }

Details of the user associated with this membership.

id?: string

User identifier tag.

email?: string

The contact email address of the user.

maxLength90
first_name?: string

User’s first name.

last_name?: string

User’s last name.

MemberCreateResponse { id, email, status }

Member attached to a User Group.

id: string

Account member identifier.

email?: string

The contact email address of the user.

maxLength90
status?: "accepted" | "pending"

The member’s status in the account.

One of the following:
"accepted"
"pending"
MemberUpdateResponse { id, email, status }

Member attached to a User Group.

id: string

Account member identifier.

email?: string

The contact email address of the user.

maxLength90
status?: "accepted" | "pending"

The member’s status in the account.

One of the following:
"accepted"
"pending"
MemberDeleteResponse { id, email, status }

Member attached to a User Group.

id: string

Account member identifier.

email?: string

The contact email address of the user.

maxLength90
status?: "accepted" | "pending"

The member’s status in the account.

One of the following:
"accepted"
"pending"