---
title: "Update admin entitlements for an organization"
url: "https://nov18-dev.movespot.fyi/apis/internal-konnect-entitlements-internal-1/versions/3b225e8d-0b5b-468b-989a-d5e0a0fafb38/operations/internal-update-entitlements-v1"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/internal-konnect-entitlements-internal-1/versions/3b225e8d-0b5b-468b-989a-d5e0a0fafb38.md

# Update admin entitlements for an organization

`PATCH` `/internal/entitlements`

Operation ID: `internal-update-entitlements-v1`

Update admin entitlements for an organization

## Request body (required)

Content types: `application/json`

## Responses

- `200` - A list of admin entitlements for the organization
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Internal Konnect Entitlements
  version: 1.0.1
servers:
  - url: http://entitlements-api.entitlements.svc.cluster.local:8080/v1
    description: Entitlements API server
paths:
  /internal/entitlements:
    patch:
      operationId: internal-update-entitlements-v1
      summary: Update admin entitlements for an organization
      description: Update admin entitlements for an organization
      requestBody:
        $ref: "#/components/requestBodies/UpdateAdminEntitlementsRequest"
      responses:
        "200":
          $ref: "#/components/responses/AdminEntitlementsResponse"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
      tags:
        - Entitlements
components:
  requestBodies:
    UpdateAdminEntitlementsRequest:
      description: Request body for updating admin entitlements
      required: true
      content:
        application/json:
          schema:
            type: object
            properties:
              admin_features:
                $ref: "#/components/schemas/AdminFeaturesRequest"
            required:
              - admin_features
          examples:
            DefaultAdminEntitlementsRequest:
              $ref: "#/components/examples/DefaultAdminEntitlementsRequest"
  responses:
    AdminEntitlementsResponse:
      description: A list of admin entitlements for the organization
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/AdminOrganizationEntitlements"
          examples:
            DefaultEntitlements:
              $ref: "#/components/examples/DefaultAdminEntitlements"
    BadRequest:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/BadRequestError"
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/ForbiddenExample"
  schemas:
    AdminFeaturesRequest:
      description: Feature request body for updating admin features
      type: object
      properties:
        ai:
          $ref: "#/components/schemas/AdminFeatureSettingsRequest"
    AdminOrganizationEntitlements:
      type: object
      properties:
        admin_features:
          $ref: "#/components/schemas/AdminFeaturesResponse"
      required:
        - admin_features
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    AdminFeatureSettingsRequest:
      type: object
      properties:
        editable:
          $ref: "#/components/schemas/FeatureToggleRequest"
        enabled:
          $ref: "#/components/schemas/FeatureToggleRequest"
      required:
        - editable
    AdminFeaturesResponse:
      description: Map of admin feature names to their settings
      type: object
      properties:
        ai:
          $ref: "#/components/schemas/AdminFeatureSettingsResponse"
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
    InvalidParameters:
      description: invalid parameters
      type: array
      items:
        oneOf:
          - $ref: "#/components/schemas/InvalidParameterStandard"
          - $ref: "#/components/schemas/InvalidParameterMinimumLength"
          - $ref: "#/components/schemas/InvalidParameterMaximumLength"
          - $ref: "#/components/schemas/InvalidParameterChoiceItem"
          - $ref: "#/components/schemas/InvalidParameterDependentItem"
      minItems: 1
      nullable: false
      uniqueItems: true
    FeatureToggleRequest:
      type: object
      properties:
        value:
          type: boolean
      required:
        - value
    AdminFeatureSettingsResponse:
      type: object
      properties:
        editable:
          $ref: "#/components/schemas/FeatureToggleResponse"
        enabled:
          $ref: "#/components/schemas/FeatureToggleResponse"
      required:
        - editable
    InvalidParameterStandard:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          $ref: "#/components/schemas/InvalidRules"
        source:
          type: string
          example: body
        reason:
          type: string
          example: is a required field
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
    InvalidParameterMinimumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - min_length
            - min_digits
            - min_lowercase
            - min_uppercase
            - min_symbols
            - min_items
            - min
          nullable: false
          readOnly: true
        minimum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must have at least 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - minimum
    InvalidParameterMaximumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - max_length
            - max_items
            - max
          nullable: false
          readOnly: true
        maximum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must not have more than 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - maximum
    InvalidParameterChoiceItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - enum
          nullable: false
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        choices:
          type: array
          items: {}
          minItems: 1
          nullable: false
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - choices
    InvalidParameterDependentItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - dependent_fields
          nullable: true
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        dependents:
          type: array
          items: {}
          nullable: true
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - rule
        - reason
        - dependents
    FeatureToggleResponse:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        value:
          type: boolean
      required:
        - name
        - description
        - value
    InvalidRules:
      description: invalid parameters rules
      type: string
      enum:
        - required
        - is_array
        - is_base64
        - is_boolean
        - is_date_time
        - is_integer
        - is_null
        - is_number
        - is_object
        - is_string
        - is_uuid
        - is_fqdn
        - is_arn
        - unknown_property
        - missing_reference
        - is_label
        - matches_regex
        - invalid
        - is_supported_network_availability_zone_list
        - is_supported_network_cidr_block
        - is_supported_provider_region
        - type
      nullable: true
      readOnly: true
  examples:
    DefaultAdminEntitlementsRequest:
      summary: Default admin entitlements request body
      value:
        admin_features:
          ai:
            editable:
              value: false
            enabled:
              value: false
    DefaultAdminEntitlements:
      summary: Default admin entitlements for an organization
      value:
        admin_features:
          ai:
            editable:
              name: editable
              description: makes the field available to the end user
              value: false
            enabled:
              name: enabled
              description: enables or disables the AI feature
              value: false
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    ForbiddenExample:
      value:
        status: 403
        title: Forbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
```
