---
title: "ConsumerRealmCreateRequest"
url: "https://nov18-dev.movespot.fyi/apis/konnect-centrally-managed-consumers-admin-api-0/versions/84f5e371-6d0e-45b1-b943-fe4dc428c317/schemas/ConsumerRealmCreateRequest"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-centrally-managed-consumers-admin-api-0/versions/84f5e371-6d0e-45b1-b943-fe4dc428c317.md

# ConsumerRealmCreateRequest

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Centrally Managed Consumers admin api
  version: 0.0.1
servers:
  - url: https://us.api.konghq.com/v1
    description: United-States Production region
  - url: https://eu.api.konghq.com/v1
    description: Europe Production region
  - url: https://au.api.konghq.com/v1
    description: Australia Production region
  - url: https://me.api.konghq.com/v1
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v1
    description: India Production region
  - url: https://sg.api.konghq.com/v1
    description: Singapore Production region
components:
  schemas:
    AllowedControlPlanes:
      description: >
        List of control plane ids that are allowed to use the realm. This is
        used when `allow_all_control_planes` value

        is set to false.
      type: array
      items:
        type: string
        uniqueItems: true
      format: set
    AllowAllControlPlanes:
      description: >
        Allow all control planes to use the realm. When this value is set it
        takes precedence on `allowed_control_planes`.
      type: boolean
      nullable: false
    RealmTTL:
      description: >
        The time in minutes that the Consumer will be cached in memory on a
        running Gateway if it is

        successfully loaded from Konnect.
      type: integer
      default: 10
      minimum: 5
    NegativeTTL:
      description: >
        If a running Gateway triggers a lookup for a Consumer that cannot be
        authenticated this realm, a `negative_ttl`

        is set. The Gateway will not try to lookup the Consumer in Konnect for
        `negative_ttl` minutes.


        A Consumer will be cached for `negative_ttl` if they do not exist in the
        Realm, or if the provided credentials

        are invalid.
      type: integer
      default: 10
      minimum: 5
    RealmConsumerGroups:
      description: >
        A list of consumer groups to automatically add to any consumers created
        within this Realm.

        If `consumer_groups` are provided on the Consumer object _and_ on the
        Realm, the Consumer will be placed in all defined consumer groups.
      type: array
      items:
        type: string
        uniqueItems: true
      format: set
      title: RealmConsumerGroups
    ConsumerRealmCreateRequest:
      type: object
      properties:
        name:
          type: string
        allowed_control_planes:
          $ref: "#/components/schemas/AllowedControlPlanes"
        allow_all_control_planes:
          $ref: "#/components/schemas/AllowAllControlPlanes"
        ttl:
          $ref: "#/components/schemas/RealmTTL"
        negative_ttl:
          $ref: "#/components/schemas/NegativeTTL"
        consumer_groups:
          $ref: "#/components/schemas/RealmConsumerGroups"
      additionalProperties: false
      required:
        - name
```
