# UserGroup

> Type in domain **Users**

- HTML: [UserGroup.html](UserGroup.html)
- Raw SDL: [UserGroup.sdl](UserGroup.sdl)
- Covered by: [llms.txt](../llms.txt)

Implements: `Node`

## Fields

- `id`: `ID!` — `UserGroup` Id.
- `name`: `String` — `UserGroup` name.
- `users` (`limit`: `Int`, `page`: `Int`): `UserItems` — `UserGroup`'s `UserItems`.

## Reach via

Example queries that can return this type from the root `Query`.

### `account › userGroups`

```graphql
query AccountUserGroups {
  account {
    userGroups(limit: 25, page: 1) {
      items {
        __typename
        id
        name
        users {
          total
          page
          limit
          hasNextPage
          items {
            __typename
            name
            id
          }
        }
      }
    }
  }
}
```

Raw: [`AccountUserGroups.sdl`](../examples/AccountUserGroups.sdl)

### `brand › customMetadataProperties › permissions › custom › subject`

```graphql
query BrandCustomMetadataPropertiesPermissionsCustomSubject {
  brand(id: "…") {
    customMetadataProperties {
      permissions {
        custom {
          subject {
            ... on UserGroup {
              __typename
              id
              name
              users {
                total
                page
                limit
                hasNextPage
                items {
                  __typename
                  name
                  id
                }
              }
            }
          }
        }
      }
    }
  }
}
```

Raw: [`BrandCustomMetadataPropertiesPermissionsCustomSubject.sdl`](../examples/BrandCustomMetadataPropertiesPermissionsCustomSubject.sdl)

### `library › customMetadataProperties › permissions › custom › subject`

```graphql
query LibraryCustomMetadataPropertiesPermissionsCustomSubject {
  library(id: "…") {
    customMetadataProperties {
      permissions {
        custom {
          subject {
            ... on UserGroup {
              __typename
              id
              name
              users {
                total
                page
                limit
                hasNextPage
                items {
                  __typename
                  name
                  id
                }
              }
            }
          }
        }
      }
    }
  }
}
```

Raw: [`LibraryCustomMetadataPropertiesPermissionsCustomSubject.sdl`](../examples/LibraryCustomMetadataPropertiesPermissionsCustomSubject.sdl)

### `brands › customMetadataProperties › permissions › custom › subject`

```graphql
query BrandsCustomMetadataPropertiesPermissionsCustomSubject {
  brands {
    customMetadataProperties {
      permissions {
        custom {
          subject {
            ... on UserGroup {
              __typename
              id
              name
              users {
                total
                page
                limit
                hasNextPage
                items {
                  __typename
                  name
                  id
                }
              }
            }
          }
        }
      }
    }
  }
}
```

Raw: [`BrandsCustomMetadataPropertiesPermissionsCustomSubject.sdl`](../examples/BrandsCustomMetadataPropertiesPermissionsCustomSubject.sdl)

### `assets › customMetadata › property › permissions › custom › subject`

```graphql
query AssetsCustomMetadataPropertyPermissionsCustomSubject {
  assets(ids: "…") {
    customMetadata {
      property {
        permissions {
          custom {
            subject {
              ... on UserGroup {
                __typename
                id
                name
                users {
                  total
                  page
                  limit
                  hasNextPage
                  items {
                    __typename
                    name
                    id
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
```

Raw: [`AssetsCustomMetadataPropertyPermissionsCustomSubject.sdl`](../examples/AssetsCustomMetadataPropertyPermissionsCustomSubject.sdl)

### `asset › customMetadata › property › permissions › custom › subject`

```graphql
query AssetCustomMetadataPropertyPermissionsCustomSubject {
  asset(id: "…") {
    customMetadata {
      property {
        permissions {
          custom {
            subject {
              ... on UserGroup {
                __typename
                id
                name
                users {
                  total
                  page
                  limit
                  hasNextPage
                  items {
                    __typename
                    name
                    id
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}
```

Raw: [`AssetCustomMetadataPropertyPermissionsCustomSubject.sdl`](../examples/AssetCustomMetadataPropertyPermissionsCustomSubject.sdl)