# Memberships

## List Memberships

`memberships.list(MembershipListParams**kwargs)  -> SyncV4PagePaginationArray[Membership]`

**get** `/memberships`

List memberships of accounts the user can access.

### Parameters

- `account: Optional[Account]`

  - `name: Optional[str]`

    Account name

- `direction: Optional[Literal["asc", "desc"]]`

  Direction to order memberships.

  - `"asc"`

  - `"desc"`

- `name: Optional[str]`

  Account name

- `order: Optional[Literal["id", "account.name", "status"]]`

  Field to order memberships by.

  - `"id"`

  - `"account.name"`

  - `"status"`

- `page: Optional[float]`

  Page number of paginated results.

- `per_page: Optional[float]`

  Number of memberships per page.

- `status: Optional[Literal["accepted", "pending", "rejected"]]`

  Status of this membership.

  - `"accepted"`

  - `"pending"`

  - `"rejected"`

### Returns

- `class Membership: …`

  - `id: Optional[str]`

    Membership identifier tag.

  - `account: Optional[Account]`

    - `id: str`

      Identifier

    - `name: str`

      Account name

    - `type: Literal["standard", "enterprise"]`

      - `"standard"`

      - `"enterprise"`

    - `created_on: Optional[datetime]`

      Timestamp for the creation of the account

    - `managed_by: Optional[ManagedBy]`

      Parent container details

      - `parent_org_id: Optional[str]`

        ID of the parent Organization, if one exists

      - `parent_org_name: Optional[str]`

        Name of the parent Organization, if one exists

    - `settings: Optional[Settings]`

      Account settings

      - `abuse_contact_email: Optional[str]`

        Sets an abuse contact email to notify for abuse reports.

      - `enforce_twofactor: Optional[bool]`

        Indicates whether membership in this account requires that
        Two-Factor Authentication is enabled

  - `api_access_enabled: Optional[bool]`

    Enterprise only. Indicates whether or not API access is enabled specifically for this user on a given account.

  - `permissions: Optional[Permissions]`

    All access permissions for the user at the account.

    - `analytics: Optional[PermissionGrant]`

      - `read: Optional[bool]`

      - `write: Optional[bool]`

    - `billing: Optional[PermissionGrant]`

    - `cache_purge: Optional[PermissionGrant]`

    - `dns: Optional[PermissionGrant]`

    - `dns_records: Optional[PermissionGrant]`

    - `lb: Optional[PermissionGrant]`

    - `logs: Optional[PermissionGrant]`

    - `organization: Optional[PermissionGrant]`

    - `ssl: Optional[PermissionGrant]`

    - `waf: Optional[PermissionGrant]`

    - `zone_settings: Optional[PermissionGrant]`

    - `zones: Optional[PermissionGrant]`

  - `roles: Optional[List[str]]`

    List of role names the membership has for this account.

  - `status: Optional[Literal["accepted", "pending", "rejected"]]`

    Status of this membership.

    - `"accepted"`

    - `"pending"`

    - `"rejected"`

### Example

```python
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
)
page = client.memberships.list()
page = page.result[0]
print(page.id)
```

#### Response

```json
{
  "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": "4536bcfad5faccb111b47003c79917fa",
      "account": {
        "id": "023e105f4ecef8ad9ca31a8372d0c353",
        "name": "Demo Account",
        "type": "standard",
        "created_on": "2014-03-01T12:21:02.0000Z",
        "managed_by": {
          "parent_org_id": "4536bcfad5faccb111b47003c79917fa",
          "parent_org_name": "Demo Parent Organization"
        },
        "settings": {
          "abuse_contact_email": "abuse_contact_email",
          "enforce_twofactor": true
        }
      },
      "api_access_enabled": true,
      "permissions": {
        "analytics": {
          "read": true,
          "write": false
        },
        "billing": {
          "read": true,
          "write": false
        },
        "cache_purge": {
          "read": true,
          "write": false
        },
        "dns": {
          "read": true,
          "write": false
        },
        "dns_records": {
          "read": true,
          "write": false
        },
        "lb": {
          "read": true,
          "write": false
        },
        "logs": {
          "read": true,
          "write": false
        },
        "organization": {
          "read": true,
          "write": false
        },
        "ssl": {
          "read": true,
          "write": false
        },
        "waf": {
          "read": true,
          "write": false
        },
        "zone_settings": {
          "read": true,
          "write": false
        },
        "zones": {
          "read": true,
          "write": true
        }
      },
      "roles": [
        "Account Administrator"
      ],
      "status": "accepted"
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}
```

## Membership Details

`memberships.get(strmembership_id)  -> MembershipGetResponse`

**get** `/memberships/{membership_id}`

Get a specific membership.

### Parameters

- `membership_id: str`

  Membership identifier tag.

### Returns

- `class MembershipGetResponse: …`

  - `id: Optional[str]`

    Membership identifier tag.

  - `account: Optional[Account]`

    - `id: str`

      Identifier

    - `name: str`

      Account name

    - `type: Literal["standard", "enterprise"]`

      - `"standard"`

      - `"enterprise"`

    - `created_on: Optional[datetime]`

      Timestamp for the creation of the account

    - `managed_by: Optional[ManagedBy]`

      Parent container details

      - `parent_org_id: Optional[str]`

        ID of the parent Organization, if one exists

      - `parent_org_name: Optional[str]`

        Name of the parent Organization, if one exists

    - `settings: Optional[Settings]`

      Account settings

      - `abuse_contact_email: Optional[str]`

        Sets an abuse contact email to notify for abuse reports.

      - `enforce_twofactor: Optional[bool]`

        Indicates whether membership in this account requires that
        Two-Factor Authentication is enabled

  - `api_access_enabled: Optional[bool]`

    Enterprise only. Indicates whether or not API access is enabled specifically for this user on a given account.

  - `permissions: Optional[Permissions]`

    All access permissions for the user at the account.

    - `analytics: Optional[PermissionGrant]`

      - `read: Optional[bool]`

      - `write: Optional[bool]`

    - `billing: Optional[PermissionGrant]`

    - `cache_purge: Optional[PermissionGrant]`

    - `dns: Optional[PermissionGrant]`

    - `dns_records: Optional[PermissionGrant]`

    - `lb: Optional[PermissionGrant]`

    - `logs: Optional[PermissionGrant]`

    - `organization: Optional[PermissionGrant]`

    - `ssl: Optional[PermissionGrant]`

    - `waf: Optional[PermissionGrant]`

    - `zone_settings: Optional[PermissionGrant]`

    - `zones: Optional[PermissionGrant]`

  - `policies: Optional[List[Policy]]`

    Access policy for the membership

    - `id: Optional[str]`

      Policy identifier.

    - `access: Optional[Literal["allow", "deny"]]`

      Allow or deny operations against the resources.

      - `"allow"`

      - `"deny"`

    - `permission_groups: Optional[List[PolicyPermissionGroup]]`

      A set of permission groups that are specified to the policy.

      - `id: str`

        Identifier of the permission group.

      - `meta: Optional[PolicyPermissionGroupMeta]`

        Attributes associated to the permission group.

        - `key: Optional[str]`

        - `value: Optional[str]`

      - `name: Optional[str]`

        Name of the permission group.

    - `resource_groups: Optional[List[PolicyResourceGroup]]`

      A list of resource groups that the policy applies to.

      - `id: str`

        Identifier of the resource group.

      - `scope: List[PolicyResourceGroupScope]`

        The scope associated to the resource group

        - `key: str`

          This is a combination of pre-defined resource name and identifier (like Account ID etc.)

        - `objects: List[PolicyResourceGroupScopeObject]`

          A list of scope objects for additional context.

          - `key: str`

            This is a combination of pre-defined resource name and identifier (like Zone ID etc.)

      - `meta: Optional[PolicyResourceGroupMeta]`

        Attributes associated to the resource group.

        - `key: Optional[str]`

        - `value: Optional[str]`

      - `name: Optional[str]`

        Name of the resource group.

  - `roles: Optional[List[str]]`

    List of role names the membership has for this account.

  - `status: Optional[Literal["accepted", "pending", "rejected"]]`

    Status of this membership.

    - `"accepted"`

    - `"pending"`

    - `"rejected"`

### Example

```python
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
)
membership = client.memberships.get(
    "4536bcfad5faccb111b47003c79917fa",
)
print(membership.id)
```

#### Response

```json
{
  "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": "4536bcfad5faccb111b47003c79917fa",
    "account": {
      "id": "023e105f4ecef8ad9ca31a8372d0c353",
      "name": "Demo Account",
      "type": "standard",
      "created_on": "2014-03-01T12:21:02.0000Z",
      "managed_by": {
        "parent_org_id": "4536bcfad5faccb111b47003c79917fa",
        "parent_org_name": "Demo Parent Organization"
      },
      "settings": {
        "abuse_contact_email": "abuse_contact_email",
        "enforce_twofactor": true
      }
    },
    "api_access_enabled": true,
    "permissions": {
      "analytics": {
        "read": true,
        "write": false
      },
      "billing": {
        "read": true,
        "write": false
      },
      "cache_purge": {
        "read": true,
        "write": false
      },
      "dns": {
        "read": true,
        "write": false
      },
      "dns_records": {
        "read": true,
        "write": false
      },
      "lb": {
        "read": true,
        "write": false
      },
      "logs": {
        "read": true,
        "write": false
      },
      "organization": {
        "read": true,
        "write": false
      },
      "ssl": {
        "read": true,
        "write": false
      },
      "waf": {
        "read": true,
        "write": false
      },
      "zone_settings": {
        "read": true,
        "write": false
      },
      "zones": {
        "read": true,
        "write": true
      }
    },
    "policies": [
      {
        "id": "f267e341f3dd4697bd3b9f71dd96247f",
        "access": "allow",
        "permission_groups": [
          {
            "id": "c8fed203ed3043cba015a93ad1616f1f",
            "meta": {
              "key": "key",
              "value": "value"
            },
            "name": "Zone Read"
          },
          {
            "id": "82e64a83756745bbbb1c9c2701bf816b",
            "meta": {
              "key": "key",
              "value": "value"
            },
            "name": "Magic Network Monitoring"
          }
        ],
        "resource_groups": [
          {
            "id": "6d7f2f5f5b1d4a0e9081fdc98d432fd1",
            "scope": [
              {
                "key": "com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4",
                "objects": [
                  {
                    "key": "com.cloudflare.api.account.zone.23f8d65290b24279ba6f44721b3eaad5"
                  }
                ]
              }
            ],
            "meta": {
              "key": "key",
              "value": "value"
            },
            "name": "com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4"
          }
        ]
      }
    ],
    "roles": [
      "Account Administrator"
    ],
    "status": "accepted"
  }
}
```

## Update Membership

`memberships.update(strmembership_id, MembershipUpdateParams**kwargs)  -> MembershipUpdateResponse`

**put** `/memberships/{membership_id}`

Accept or reject this account invitation.

### Parameters

- `membership_id: str`

  Membership identifier tag.

- `status: Literal["accepted", "rejected"]`

  Whether to accept or reject this account invitation.

  - `"accepted"`

  - `"rejected"`

### Returns

- `class MembershipUpdateResponse: …`

  - `id: Optional[str]`

    Membership identifier tag.

  - `account: Optional[Account]`

    - `id: str`

      Identifier

    - `name: str`

      Account name

    - `type: Literal["standard", "enterprise"]`

      - `"standard"`

      - `"enterprise"`

    - `created_on: Optional[datetime]`

      Timestamp for the creation of the account

    - `managed_by: Optional[ManagedBy]`

      Parent container details

      - `parent_org_id: Optional[str]`

        ID of the parent Organization, if one exists

      - `parent_org_name: Optional[str]`

        Name of the parent Organization, if one exists

    - `settings: Optional[Settings]`

      Account settings

      - `abuse_contact_email: Optional[str]`

        Sets an abuse contact email to notify for abuse reports.

      - `enforce_twofactor: Optional[bool]`

        Indicates whether membership in this account requires that
        Two-Factor Authentication is enabled

  - `api_access_enabled: Optional[bool]`

    Enterprise only. Indicates whether or not API access is enabled specifically for this user on a given account.

  - `permissions: Optional[Permissions]`

    All access permissions for the user at the account.

    - `analytics: Optional[PermissionGrant]`

      - `read: Optional[bool]`

      - `write: Optional[bool]`

    - `billing: Optional[PermissionGrant]`

    - `cache_purge: Optional[PermissionGrant]`

    - `dns: Optional[PermissionGrant]`

    - `dns_records: Optional[PermissionGrant]`

    - `lb: Optional[PermissionGrant]`

    - `logs: Optional[PermissionGrant]`

    - `organization: Optional[PermissionGrant]`

    - `ssl: Optional[PermissionGrant]`

    - `waf: Optional[PermissionGrant]`

    - `zone_settings: Optional[PermissionGrant]`

    - `zones: Optional[PermissionGrant]`

  - `policies: Optional[List[Policy]]`

    Access policy for the membership

    - `id: Optional[str]`

      Policy identifier.

    - `access: Optional[Literal["allow", "deny"]]`

      Allow or deny operations against the resources.

      - `"allow"`

      - `"deny"`

    - `permission_groups: Optional[List[PolicyPermissionGroup]]`

      A set of permission groups that are specified to the policy.

      - `id: str`

        Identifier of the permission group.

      - `meta: Optional[PolicyPermissionGroupMeta]`

        Attributes associated to the permission group.

        - `key: Optional[str]`

        - `value: Optional[str]`

      - `name: Optional[str]`

        Name of the permission group.

    - `resource_groups: Optional[List[PolicyResourceGroup]]`

      A list of resource groups that the policy applies to.

      - `id: str`

        Identifier of the resource group.

      - `scope: List[PolicyResourceGroupScope]`

        The scope associated to the resource group

        - `key: str`

          This is a combination of pre-defined resource name and identifier (like Account ID etc.)

        - `objects: List[PolicyResourceGroupScopeObject]`

          A list of scope objects for additional context.

          - `key: str`

            This is a combination of pre-defined resource name and identifier (like Zone ID etc.)

      - `meta: Optional[PolicyResourceGroupMeta]`

        Attributes associated to the resource group.

        - `key: Optional[str]`

        - `value: Optional[str]`

      - `name: Optional[str]`

        Name of the resource group.

  - `roles: Optional[List[str]]`

    List of role names the membership has for this account.

  - `status: Optional[Literal["accepted", "pending", "rejected"]]`

    Status of this membership.

    - `"accepted"`

    - `"pending"`

    - `"rejected"`

### Example

```python
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
)
membership = client.memberships.update(
    membership_id="4536bcfad5faccb111b47003c79917fa",
    status="accepted",
)
print(membership.id)
```

#### Response

```json
{
  "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": "4536bcfad5faccb111b47003c79917fa",
    "account": {
      "id": "023e105f4ecef8ad9ca31a8372d0c353",
      "name": "Demo Account",
      "type": "standard",
      "created_on": "2014-03-01T12:21:02.0000Z",
      "managed_by": {
        "parent_org_id": "4536bcfad5faccb111b47003c79917fa",
        "parent_org_name": "Demo Parent Organization"
      },
      "settings": {
        "abuse_contact_email": "abuse_contact_email",
        "enforce_twofactor": true
      }
    },
    "api_access_enabled": true,
    "permissions": {
      "analytics": {
        "read": true,
        "write": false
      },
      "billing": {
        "read": true,
        "write": false
      },
      "cache_purge": {
        "read": true,
        "write": false
      },
      "dns": {
        "read": true,
        "write": false
      },
      "dns_records": {
        "read": true,
        "write": false
      },
      "lb": {
        "read": true,
        "write": false
      },
      "logs": {
        "read": true,
        "write": false
      },
      "organization": {
        "read": true,
        "write": false
      },
      "ssl": {
        "read": true,
        "write": false
      },
      "waf": {
        "read": true,
        "write": false
      },
      "zone_settings": {
        "read": true,
        "write": false
      },
      "zones": {
        "read": true,
        "write": true
      }
    },
    "policies": [
      {
        "id": "f267e341f3dd4697bd3b9f71dd96247f",
        "access": "allow",
        "permission_groups": [
          {
            "id": "c8fed203ed3043cba015a93ad1616f1f",
            "meta": {
              "key": "key",
              "value": "value"
            },
            "name": "Zone Read"
          },
          {
            "id": "82e64a83756745bbbb1c9c2701bf816b",
            "meta": {
              "key": "key",
              "value": "value"
            },
            "name": "Magic Network Monitoring"
          }
        ],
        "resource_groups": [
          {
            "id": "6d7f2f5f5b1d4a0e9081fdc98d432fd1",
            "scope": [
              {
                "key": "com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4",
                "objects": [
                  {
                    "key": "com.cloudflare.api.account.zone.23f8d65290b24279ba6f44721b3eaad5"
                  }
                ]
              }
            ],
            "meta": {
              "key": "key",
              "value": "value"
            },
            "name": "com.cloudflare.api.account.eb78d65290b24279ba6f44721b3ea3c4"
          }
        ]
      }
    ],
    "roles": [
      "Account Administrator"
    ],
    "status": "accepted"
  }
}
```

## Delete Membership

`memberships.delete(strmembership_id)  -> MembershipDeleteResponse`

**delete** `/memberships/{membership_id}`

Remove the associated member from an account.

### Parameters

- `membership_id: str`

  Membership identifier tag.

### Returns

- `class MembershipDeleteResponse: …`

  - `id: Optional[str]`

    Membership identifier tag.

### Example

```python
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
)
membership = client.memberships.delete(
    "4536bcfad5faccb111b47003c79917fa",
)
print(membership.id)
```

#### Response

```json
{
  "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": "4536bcfad5faccb111b47003c79917fa"
  }
}
```

## Domain Types

### Membership

- `class Membership: …`

  - `id: Optional[str]`

    Membership identifier tag.

  - `account: Optional[Account]`

    - `id: str`

      Identifier

    - `name: str`

      Account name

    - `type: Literal["standard", "enterprise"]`

      - `"standard"`

      - `"enterprise"`

    - `created_on: Optional[datetime]`

      Timestamp for the creation of the account

    - `managed_by: Optional[ManagedBy]`

      Parent container details

      - `parent_org_id: Optional[str]`

        ID of the parent Organization, if one exists

      - `parent_org_name: Optional[str]`

        Name of the parent Organization, if one exists

    - `settings: Optional[Settings]`

      Account settings

      - `abuse_contact_email: Optional[str]`

        Sets an abuse contact email to notify for abuse reports.

      - `enforce_twofactor: Optional[bool]`

        Indicates whether membership in this account requires that
        Two-Factor Authentication is enabled

  - `api_access_enabled: Optional[bool]`

    Enterprise only. Indicates whether or not API access is enabled specifically for this user on a given account.

  - `permissions: Optional[Permissions]`

    All access permissions for the user at the account.

    - `analytics: Optional[PermissionGrant]`

      - `read: Optional[bool]`

      - `write: Optional[bool]`

    - `billing: Optional[PermissionGrant]`

    - `cache_purge: Optional[PermissionGrant]`

    - `dns: Optional[PermissionGrant]`

    - `dns_records: Optional[PermissionGrant]`

    - `lb: Optional[PermissionGrant]`

    - `logs: Optional[PermissionGrant]`

    - `organization: Optional[PermissionGrant]`

    - `ssl: Optional[PermissionGrant]`

    - `waf: Optional[PermissionGrant]`

    - `zone_settings: Optional[PermissionGrant]`

    - `zones: Optional[PermissionGrant]`

  - `roles: Optional[List[str]]`

    List of role names the membership has for this account.

  - `status: Optional[Literal["accepted", "pending", "rejected"]]`

    Status of this membership.

    - `"accepted"`

    - `"pending"`

    - `"rejected"`

### Membership Get Response

- `class MembershipGetResponse: …`

  - `id: Optional[str]`

    Membership identifier tag.

  - `account: Optional[Account]`

    - `id: str`

      Identifier

    - `name: str`

      Account name

    - `type: Literal["standard", "enterprise"]`

      - `"standard"`

      - `"enterprise"`

    - `created_on: Optional[datetime]`

      Timestamp for the creation of the account

    - `managed_by: Optional[ManagedBy]`

      Parent container details

      - `parent_org_id: Optional[str]`

        ID of the parent Organization, if one exists

      - `parent_org_name: Optional[str]`

        Name of the parent Organization, if one exists

    - `settings: Optional[Settings]`

      Account settings

      - `abuse_contact_email: Optional[str]`

        Sets an abuse contact email to notify for abuse reports.

      - `enforce_twofactor: Optional[bool]`

        Indicates whether membership in this account requires that
        Two-Factor Authentication is enabled

  - `api_access_enabled: Optional[bool]`

    Enterprise only. Indicates whether or not API access is enabled specifically for this user on a given account.

  - `permissions: Optional[Permissions]`

    All access permissions for the user at the account.

    - `analytics: Optional[PermissionGrant]`

      - `read: Optional[bool]`

      - `write: Optional[bool]`

    - `billing: Optional[PermissionGrant]`

    - `cache_purge: Optional[PermissionGrant]`

    - `dns: Optional[PermissionGrant]`

    - `dns_records: Optional[PermissionGrant]`

    - `lb: Optional[PermissionGrant]`

    - `logs: Optional[PermissionGrant]`

    - `organization: Optional[PermissionGrant]`

    - `ssl: Optional[PermissionGrant]`

    - `waf: Optional[PermissionGrant]`

    - `zone_settings: Optional[PermissionGrant]`

    - `zones: Optional[PermissionGrant]`

  - `policies: Optional[List[Policy]]`

    Access policy for the membership

    - `id: Optional[str]`

      Policy identifier.

    - `access: Optional[Literal["allow", "deny"]]`

      Allow or deny operations against the resources.

      - `"allow"`

      - `"deny"`

    - `permission_groups: Optional[List[PolicyPermissionGroup]]`

      A set of permission groups that are specified to the policy.

      - `id: str`

        Identifier of the permission group.

      - `meta: Optional[PolicyPermissionGroupMeta]`

        Attributes associated to the permission group.

        - `key: Optional[str]`

        - `value: Optional[str]`

      - `name: Optional[str]`

        Name of the permission group.

    - `resource_groups: Optional[List[PolicyResourceGroup]]`

      A list of resource groups that the policy applies to.

      - `id: str`

        Identifier of the resource group.

      - `scope: List[PolicyResourceGroupScope]`

        The scope associated to the resource group

        - `key: str`

          This is a combination of pre-defined resource name and identifier (like Account ID etc.)

        - `objects: List[PolicyResourceGroupScopeObject]`

          A list of scope objects for additional context.

          - `key: str`

            This is a combination of pre-defined resource name and identifier (like Zone ID etc.)

      - `meta: Optional[PolicyResourceGroupMeta]`

        Attributes associated to the resource group.

        - `key: Optional[str]`

        - `value: Optional[str]`

      - `name: Optional[str]`

        Name of the resource group.

  - `roles: Optional[List[str]]`

    List of role names the membership has for this account.

  - `status: Optional[Literal["accepted", "pending", "rejected"]]`

    Status of this membership.

    - `"accepted"`

    - `"pending"`

    - `"rejected"`

### Membership Update Response

- `class MembershipUpdateResponse: …`

  - `id: Optional[str]`

    Membership identifier tag.

  - `account: Optional[Account]`

    - `id: str`

      Identifier

    - `name: str`

      Account name

    - `type: Literal["standard", "enterprise"]`

      - `"standard"`

      - `"enterprise"`

    - `created_on: Optional[datetime]`

      Timestamp for the creation of the account

    - `managed_by: Optional[ManagedBy]`

      Parent container details

      - `parent_org_id: Optional[str]`

        ID of the parent Organization, if one exists

      - `parent_org_name: Optional[str]`

        Name of the parent Organization, if one exists

    - `settings: Optional[Settings]`

      Account settings

      - `abuse_contact_email: Optional[str]`

        Sets an abuse contact email to notify for abuse reports.

      - `enforce_twofactor: Optional[bool]`

        Indicates whether membership in this account requires that
        Two-Factor Authentication is enabled

  - `api_access_enabled: Optional[bool]`

    Enterprise only. Indicates whether or not API access is enabled specifically for this user on a given account.

  - `permissions: Optional[Permissions]`

    All access permissions for the user at the account.

    - `analytics: Optional[PermissionGrant]`

      - `read: Optional[bool]`

      - `write: Optional[bool]`

    - `billing: Optional[PermissionGrant]`

    - `cache_purge: Optional[PermissionGrant]`

    - `dns: Optional[PermissionGrant]`

    - `dns_records: Optional[PermissionGrant]`

    - `lb: Optional[PermissionGrant]`

    - `logs: Optional[PermissionGrant]`

    - `organization: Optional[PermissionGrant]`

    - `ssl: Optional[PermissionGrant]`

    - `waf: Optional[PermissionGrant]`

    - `zone_settings: Optional[PermissionGrant]`

    - `zones: Optional[PermissionGrant]`

  - `policies: Optional[List[Policy]]`

    Access policy for the membership

    - `id: Optional[str]`

      Policy identifier.

    - `access: Optional[Literal["allow", "deny"]]`

      Allow or deny operations against the resources.

      - `"allow"`

      - `"deny"`

    - `permission_groups: Optional[List[PolicyPermissionGroup]]`

      A set of permission groups that are specified to the policy.

      - `id: str`

        Identifier of the permission group.

      - `meta: Optional[PolicyPermissionGroupMeta]`

        Attributes associated to the permission group.

        - `key: Optional[str]`

        - `value: Optional[str]`

      - `name: Optional[str]`

        Name of the permission group.

    - `resource_groups: Optional[List[PolicyResourceGroup]]`

      A list of resource groups that the policy applies to.

      - `id: str`

        Identifier of the resource group.

      - `scope: List[PolicyResourceGroupScope]`

        The scope associated to the resource group

        - `key: str`

          This is a combination of pre-defined resource name and identifier (like Account ID etc.)

        - `objects: List[PolicyResourceGroupScopeObject]`

          A list of scope objects for additional context.

          - `key: str`

            This is a combination of pre-defined resource name and identifier (like Zone ID etc.)

      - `meta: Optional[PolicyResourceGroupMeta]`

        Attributes associated to the resource group.

        - `key: Optional[str]`

        - `value: Optional[str]`

      - `name: Optional[str]`

        Name of the resource group.

  - `roles: Optional[List[str]]`

    List of role names the membership has for this account.

  - `status: Optional[Literal["accepted", "pending", "rejected"]]`

    Status of this membership.

    - `"accepted"`

    - `"pending"`

    - `"rejected"`

### Membership Delete Response

- `class MembershipDeleteResponse: …`

  - `id: Optional[str]`

    Membership identifier tag.