---
title: "UpdatePrincipalBody"
url: "https://nov18-dev.movespot.fyi/apis/konnect-kong-identity-admin-api-dev-0/versions/cf61fd14-4802-4fa9-ad7b-534e50226211/schemas/UpdatePrincipalBody"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-kong-identity-admin-api-dev-0/versions/cf61fd14-4802-4fa9-ad7b-534e50226211.md

# UpdatePrincipalBody

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Kong Identity admin api
  version: 0.0.2
servers:
  - url: https://us.api.konghq.com/v2
    description: United-States Production region
  - url: https://eu.api.konghq.com/v2
    description: Europe Production region
  - url: https://au.api.konghq.com/v2
    description: Australia Production region
  - url: https://me.api.konghq.com/v2
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v2
    description: India Production region
  - url: https://sg.api.konghq.com/v2
    description: Singapore Production region
components:
  schemas:
    KongPrincipalDisplayName:
      description: |
        Human-readable name of the principal.
      type: string
      maxLength: 255
    KongPrincipalDescription:
      description: >
        Optional description providing additional context about the principal's
        purpose or role.
      type: string
      maxLength: 255
    KongIdentityMetadata:
      description: >
        A map of metadata key-value pairs associated with this entity. This
        metadata is passed to the data plane 

        to enrich the execution context. During authentication, metadata is
        inherited and overridden in a hierarchical 

        manner: Directory metadata is inherited by Principals, which is then
        inherited and overridden by Credentials.
      type: object
      additionalProperties:
        oneOf:
          - type: string
            format: date-time
          - type: boolean
          - type: string
          - type: integer
          - type: array
            items:
              type: string
            minItems: 0
            maxItems: 255
            uniqueItems: true
          - type: array
            items:
              type: integer
            minItems: 0
            maxItems: 255
            uniqueItems: true
      maxProperties: 50
      minProperties: 0
      nullable: true
    Labels:
      description: >
        Labels store metadata of an entity that can be used for filtering an
        entity list or for searching across entity types. 


        Keys must be of length 1-63 characters, and cannot start with "kong",
        "konnect", "mesh", "kic", or "_".
      type: object
      example:
        env: test
      additionalProperties:
        type: string
        pattern: ^[a-z0-9A-Z]{1}([a-z0-9A-Z-._]*[a-z0-9A-Z]+)?$
        minLength: 1
        maxLength: 63
      maxProperties: 50
      title: Labels
    UpdatePrincipalBody:
      type: object
      properties:
        display_name:
          $ref: "#/components/schemas/KongPrincipalDisplayName"
        description:
          $ref: "#/components/schemas/KongPrincipalDescription"
        metadata:
          $ref: "#/components/schemas/KongIdentityMetadata"
        labels:
          $ref: "#/components/schemas/Labels"
```
