## Update User Group

`iam.user_groups.update(struser_group_id, UserGroupUpdateParams**kwargs)  -> UserGroupUpdateResponse`

**put** `/accounts/{account_id}/iam/user_groups/{user_group_id}`

Modify an existing user group.

### Parameters

- `account_id: str`

  Account identifier tag.

- `user_group_id: str`

  User Group identifier tag.

- `name: Optional[str]`

  Name of the User group.

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

  Policies attached to the User group

  - `id: str`

    Policy identifier.

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

    Allow or deny operations against the resources.

    - `"allow"`

    - `"deny"`

  - `permission_groups: Iterable[PolicyPermissionGroup]`

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

    - `id: str`

      Permission Group identifier tag.

  - `resource_groups: Iterable[PolicyResourceGroup]`

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

    - `id: str`

      Resource Group identifier tag.

### Returns

- `class UserGroupUpdateResponse: …`

  A group of policies resources.

  - `id: str`

    User Group identifier tag.

  - `created_on: datetime`

    Timestamp for the creation of the user group

  - `modified_on: datetime`

    Last time the user group was modified.

  - `name: str`

    Name of the user group.

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

    Policies attached to the User group

    - `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.

### 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
)
user_group = client.iam.user_groups.update(
    user_group_id="023e105f4ecef8ad9ca31a8372d0c353",
    account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(user_group.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": "023e105f4ecef8ad9ca31a8372d0c353",
    "created_on": "2024-03-01T12:21:02.0000Z",
    "modified_on": "2024-03-01T12:21:02.0000Z",
    "name": "My New User Group",
    "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"
          }
        ]
      }
    ]
  }
}
```