Remove User Group Member

iam.user_groups.members.delete(, ) -> MemberDeleteResponse

DELETE/accounts/{account_id}/iam/user_groups/{user_group_id}/members/{member_id}

Remove a member from 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 Write

ParametersExpand Collapse

account_id: str

Account identifier tag.

maxLength32

minLength32

user_group_id: str

User Group identifier tag.

maxLength32

minLength32

member_id: str

The identifier of an existing account Member.

maxLength32

minLength32

ReturnsExpand Collapse

class MemberDeleteResponse: …

Member attached to a User Group.

id: str

Account member identifier.

email: Optional[str]

The contact email address of the user.

maxLength90

status: Optional[Literal["accepted", "pending"]]

The member’s status in the account.

One of the following:

"accepted"

"pending"

Remove User Group Member

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_email=os.environ.get("CLOUDFLARE_EMAIL"),  # This is the default and can be omitted
    api_key=os.environ.get("CLOUDFLARE_API_KEY"),  # This is the default and can be omitted
)
member = client.iam.user_groups.members.delete(
    member_id="023e105f4ecef8ad9ca31a8372d0c353",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
    user_group_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(member.id)

{
  "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"
  }
}

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"
  }
}