---
title: "Create Application"
url: "https://nov18-dev.movespot.fyi/apis/portal-management-v3-dev-3/versions/e0dbc95a-4b74-44e7-ac0a-71aa3ce313a6/operations/create-application"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/portal-management-v3-dev-3/versions/e0dbc95a-4b74-44e7-ac0a-71aa3ce313a6.md

# Create Application

`POST` `/portals/{portalId}/applications`

Operation ID: `create-application`

Creates a new application for this portal. The application must be assigned to a developer or a team. An application can be registered for various APIs, issuing credentials for API access. If using DCR, an application will be linked to an Identity Provider's application by its `client_id`.

## Path parameters

- `portalId` (string, uuid, required) - ID of the portal.

## Request body (required)

Content types: `application/json`

## Responses

- `201` - Details about an application in a portal.
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Portal Management V3
  version: 3.4.1
servers:
  - url: https://us.api.konghq.com/v3
    description: United-States Production region
  - url: https://eu.api.konghq.com/v3
    description: Europe Production region
  - url: https://au.api.konghq.com/v3
    description: Australia Production region
  - url: https://me.api.konghq.com/v3
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v3
    description: India Production region
  - url: https://sg.api.konghq.com/v3
    description: Singapore Production region
paths:
  /portals/{portalId}/applications:
    post:
      operationId: create-application
      summary: Create Application
      description: Creates a new application for this portal. The application must be
        assigned to a developer or a team. An application can be registered for
        various APIs, issuing credentials for API access. If using DCR, an
        application will be linked to an Identity Provider's application by its
        `client_id`.
      parameters:
        - $ref: "#/components/parameters/PortalId"
      requestBody:
        $ref: "#/components/requestBodies/CreateApplication"
      responses:
        "201":
          $ref: "#/components/responses/GetApplication"
        "400":
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: "#/components/schemas/BadRequestError"
              examples:
                CreateApplicationBadRequestExample1:
                  $ref: "#/components/examples/CreateApplicationBadRequestExample1"
                CreateApplicationBadRequestExample2:
                  $ref: "#/components/examples/CreateApplicationBadRequestExample2"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
      tags:
        - Applications
security:
  - personalAccessToken: []
  - systemAccountAccessToken: []
components:
  parameters:
    PortalId:
      schema:
        type: string
        format: uuid
      name: portalId
      in: path
      required: true
      description: ID of the portal.
  requestBodies:
    CreateApplication:
      description: Create an application for a portal.
      required: true
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/CreateApplicationRequest"
          examples:
            Create Application Example:
              $ref: "#/components/examples/CreateApplicationExample"
            Create OIDC Application Example:
              $ref: "#/components/examples/CreateOIDCApplicationExample"
  responses:
    GetApplication:
      description: Details about an application in a portal.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/GetApplicationResponse"
          examples:
            Key Auth Application:
              $ref: "#/components/examples/GetApplicationExampleBasic"
            Client Credentials Application with DCR:
              $ref: "#/components/examples/GetApplicationExampleDcr"
            Client Credentials Application without DCR:
              $ref: "#/components/examples/GetApplicationExampleOIDC"
    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:
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    CreateApplicationRequest:
      type: object
      properties:
        name:
          description: The name of the application.
          type: string
          maxLength: 255
        description:
          description: A description of the application.
          type: string
          maxLength: 255
        labels:
          $ref: "#/components/schemas/LabelsUpdate"
        dcr_client_id:
          description: >
            If using a DCR auth strategy, set this property to link the portal
            application to an existing

            client from the DCR provider, instead of having Konnect create a new
            client.

            This allows importing existing clients from an Identity Provider
            into Konnect, allowing

            them to be controlled through the DCR flows in the portal, and use
            existing client secrets

            for API access.

            The value must be a valid client ID in the DCR provider associated
            with the auth strategy.

            If it is not valid, application will be created but will not
            function properly.
          type: string
          maxLength: 255
        client_id:
          $ref: "#/components/schemas/ApplicationClientId"
        auth_strategy_id:
          description: The ID of the authentication strategy the application will use when
            making requests to registered APIs.
          type: string
          format: uuid
        owner:
          $ref: "#/components/schemas/ApplicationOwner"
      example:
        name: Portal Application
        description: A portal application provisioned for a developer by a Portal Admin.
        labels:
          env: production
        auth_strategy_id: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        owner:
          id: 7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
          type: developer
      additionalProperties: false
      required:
        - name
        - owner
      title: CreateApplicationRequest
    GetApplicationResponse:
      $ref: "#/components/schemas/Application"
    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
    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
    LabelsUpdate:
      description: >
        Labels store metadata of an entity that can be used for filtering an
        entity list or for searching across entity types. 


        Labels are intended to store **INTERNAL** metadata.


        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
        nullable: true
      maxProperties: 50
      nullable: true
      writeOnly: true
    ApplicationClientId:
      description: |
        An identifier to correlate the application with an external system.
        Cannot be set when using Dynamic Client Registration.
      type: string
      maxLength: 255
    ApplicationOwner:
      type: object
      properties:
        type:
          $ref: "#/components/schemas/ApplicationOwnerType"
        id:
          $ref: "#/components/schemas/ApplicationOwnerId"
      additionalProperties: false
      required:
        - type
        - id
    Application:
      example:
        id: b15e2460-ba40-431d-9df0-4957fcffacda
        labels:
          env: test
        name: App 1
        description: An easy to manage app in a Konnect developer portal
        registration_count: 4
        portal:
          id: 95606071-49c7-4c2e-ae49-8a86d72a8110
        auth_strategy:
          id: 45606071-49c7-4c2e-ae49-8a86d72a8110
          name: API Key
          credential_type: key_auth
          key_names:
            - apikey
        created_at: 2022-12-22T19:09:30.712Z
        updated_at: 2022-12-22T19:09:30.712Z
        owner:
          id: 8cd9feff-b4da-4a9f-ba49-cbe83c75ff22
          type: developer
      oneOf:
        - $ref: "#/components/schemas/ClientCredentialsApplication"
        - $ref: "#/components/schemas/KeyAuthApplication"
      title: Application
    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
    ApplicationOwnerType:
      description: The type of the owner of the application. Can be `developer`
        (individual developer) or `team`.
      type: string
      enum:
        - developer
        - team
    ApplicationOwnerId:
      description: The ID of the owner of the application. When type is `developer`,
        this is the developer ID. When type is `team`, this is the team ID.
      type: string
      format: uuid
    ClientCredentialsApplication:
      type: object
      properties:
        id:
          $ref: "#/components/schemas/UUID"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
        name:
          description: The name of the application.
          type: string
        description:
          description: A description of the application.
          type: string
          nullable: true
        labels:
          $ref: "#/components/schemas/LabelsUpdate"
        client_id:
          description: The ID used to linked the portal application to an Identity
            Provider application.
          type: string
          readOnly: true
        registration_count:
          description: The number of API registrations that are associated with the
            application. Registrations of any status are included in the count.
          type: number
          readOnly: true
        dcr_provider:
          description: Information about the DCR provider this application uses, if using
            DCR.
          type: object
          additionalProperties: false
          nullable: true
          properties:
            id:
              $ref: "#/components/schemas/UUID"
          required:
            - id
        portal:
          description: Information about the portal the application is in.
          type: object
          additionalProperties: false
          properties:
            id:
              $ref: "#/components/schemas/UUID"
          required:
            - id
        auth_strategy:
          $ref: "#/components/schemas/AuthStrategyClientCredentials"
        granted_scopes:
          description: List of granted scopes for the application. Null if application
            type does not support returning granted scopes.
          type: array
          items:
            type: string
          nullable: true
        owner:
          $ref: "#/components/schemas/ApplicationOwner"
      additionalProperties: false
      required:
        - id
        - created_at
        - updated_at
        - name
        - description
        - registration_count
        - client_id
        - auth_strategy
        - dcr_provider
        - portal
        - labels
        - granted_scopes
      title: Client Credentials Application
    KeyAuthApplication:
      type: object
      properties:
        id:
          $ref: "#/components/schemas/UUID"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
        name:
          description: The name of the application.
          type: string
        description:
          description: A description of the application.
          type: string
          nullable: true
        auth_strategy:
          $ref: "#/components/schemas/AuthStrategyKeyAuth"
        portal:
          description: Information about the portal the application is in.
          type: object
          additionalProperties: false
          properties:
            id:
              $ref: "#/components/schemas/UUID"
          required:
            - id
        labels:
          $ref: "#/components/schemas/LabelsUpdate"
        registration_count:
          description: The number of API registrations that are associated with the
            application. Registrations of any status are included in the count.
          type: number
          readOnly: true
        owner:
          $ref: "#/components/schemas/ApplicationOwner"
      example:
        id: b15e2460-ba40-431d-9df0-4957fcffacda
        labels:
          env: test
        name: App 1
        description: An easy to manage app in a Konnect developer portal
        registration_count: 4
        portal:
          id: 95606071-49c7-4c2e-ae49-8a86d72a8110
        auth_strategy:
          id: 45606071-49c7-4c2e-ae49-8a86d72a8110
          name: API Key
          credential_type: key_auth
          key_names:
            - apikey
        created_at: 2022-12-22T19:09:30.712Z
        updated_at: 2022-12-22T19:09:30.712Z
        owner:
          id: 8cd9feff-b4da-4a9f-ba49-cbe83c75ff22
          type: developer
      additionalProperties: false
      required:
        - id
        - created_at
        - updated_at
        - name
        - description
        - auth_strategy
        - portal
        - registration_count
        - labels
      title: Key Auth Application
    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
    UUID:
      description: Contains a unique identifier used for this resource.
      type: string
      format: uuid
      example: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
      readOnly: true
    CreatedAt:
      description: An ISO-8601 timestamp representation of entity creation date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    UpdatedAt:
      description: An ISO-8601 timestamp representation of entity update date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    AuthStrategyClientCredentials:
      description: Client Credential Auth strategy that the application uses.
      type: object
      properties:
        id:
          description: The Application Auth Strategy ID.
          type: string
          format: uuid
          example: b9e81174-b5bb-4638-a3c3-8afe61a0abf8
          readOnly: true
        name:
          type: string
          example: name
          default: name
        credential_type:
          type: string
          enum:
            - client_credentials
            - self_managed_client_credentials
        auth_methods:
          $ref: "#/components/schemas/AuthMethods"
        available_scopes:
          $ref: "#/components/schemas/AvailableScopes"
      additionalProperties: false
      required:
        - id
        - name
        - credential_type
        - auth_methods
    AuthStrategyKeyAuth:
      description: KeyAuth Auth strategy that the application uses.
      type: object
      properties:
        id:
          description: The Application Auth Strategy ID.
          type: string
          format: uuid
          example: b9e81174-b5bb-4638-a3c3-8afe61a0abf8
          readOnly: true
        name:
          type: string
          example: name
          default: name
        credential_type:
          type: string
          enum:
            - key_auth
        key_names:
          type: array
          items:
            type: string
        ttl:
          description: Default maximum Time-To-Live for keys created under this strategy.
          type: object
          properties:
            value:
              type: integer
              minimum: 1
            unit:
              type: string
              enum:
                - days
                - weeks
                - years
          required:
            - value
            - unit
      additionalProperties: false
      required:
        - id
        - name
        - credential_type
        - key_names
    AuthMethods:
      type: array
      items:
        description: Auth Methods enabled for this strategy
        type: string
      example:
        - bearer
    AvailableScopes:
      description: Possible developer selectable scopes for an application. Only
        present when using DCR Provider that supports it.
      type: array
      items:
        type: string
      example:
        - scope1
        - scope2
  examples:
    CreateApplicationBadRequestExample1:
      value:
        status: 400
        title: Invalid Request
        instance: kong:trace:1433447772874964729
        detail: Invalid Parameters
        invalid_parameters:
          - field: auth_strategy_id
            rule: is_uuid
            reason: '"auth_strategy_id" must be a valid UUID'
            source: body
    CreateApplicationBadRequestExample2:
      value:
        status: 400
        title: Invalid Request
        instance: kong:trace:1433447772874964729
        detail: Invalid Parameters
        invalid_parameters:
          - field: my_property
            rule: unknown_property
            reason: '"my_property" is not allowed'
            source: body
    CreateApplicationExample:
      value:
        name: Portal Application
        description: A portal application provisioned for a developer by a Portal Admin.
        labels:
          env: test
        auth_strategy_id: 85606071-49c7-4c2e-ae49-8a86d72a8110
        owner:
          id: 8cd9feff-b4da-4a9f-ba49-cbe83c75ff22
          type: developer
    CreateOIDCApplicationExample:
      value:
        name: My OIDC Application
        description: This application has been pre-configured in an identity provider
          and is linked by its client_id.
        labels:
          env: test
        auth_strategy_id: 75606071-49c7-4c2e-ae49-8a86d72a8110
        client_id: z5Ul9d8f0h3kL0j2p4q0
        owner:
          id: 8cd9feff-b4da-4a9f-ba49-cbe83c75ff22
          type: developer
    GetApplicationExampleBasic:
      value:
        id: b15e2460-ba40-431d-9df0-4957fcffacda
        labels:
          env: test
        name: App 1
        description: An easy to manage app in a Konnect developer portal
        registration_count: 4
        portal:
          id: 95606071-49c7-4c2e-ae49-8a86d72a8110
        auth_strategy:
          id: 45606071-49c7-4c2e-ae49-8a86d72a8110
          name: API Key
          credential_type: key_auth
          key_names:
            - apikey
        created_at: 2022-12-22T19:09:30.712Z
        updated_at: 2022-12-22T19:09:30.712Z
        owner:
          id: 8cd9feff-b4da-4a9f-ba49-cbe83c75ff22
          type: developer
    GetApplicationExampleDcr:
      value:
        id: b15e2460-ba40-431d-9df0-4957fcffacda
        labels:
          env: test
        name: App 1
        description: A Konnect application that is linked to an Identity Provider
          application, where the relationship is managed by Konnect using
          Dynamic Client Registration (DCR)
        client_id: yr1k0d9kj3l0cl01hp4o0
        registration_count: 1
        portal:
          id: 95606071-49c7-4c2e-ae49-8a86d72a8110
        auth_strategy:
          id: 45606071-49c7-4c2e-ae49-8a86d72a8110
          name: Client Credentials
          credential_type: client_credentials
          auth_methods:
            - client_credentials
        dcr_provider:
          id: 7ea06071-49c7-4c2e-ae49-8a86d72a8110
        granted_scopes:
          - openid
        created_at: 2022-12-22T19:07:30.712Z
        updated_at: 2022-12-22T19:07:30.712Z
        owner:
          id: 8cd9feff-b4da-4a9f-ba49-cbe83c75ff22
          type: developer
    GetApplicationExampleOIDC:
      value:
        id: b15e2460-ba40-431d-9df0-4957fcffacda
        labels:
          env: test
        name: App 1
        description: A Konnect application that is linked to an Identity Provider
          application by client_id, but the relationship is not managed by
          Konnect through DCR
        client_id: yr1k0d9kj3l0cl01hp4o0
        registration_count: 1
        portal:
          id: 95606071-49c7-4c2e-ae49-8a86d72a8110
        auth_strategy:
          id: 45606071-49c7-4c2e-ae49-8a86d72a8110
          name: Client Credentials
          credential_type: self_managed_client_credentials
          auth_methods:
            - client_credentials
        dcr_provider: null
        granted_scopes: null
        created_at: 2022-12-22T19:07:30.712Z
        updated_at: 2022-12-22T19:07:30.712Z
        owner:
          id: 8cd9feff-b4da-4a9f-ba49-cbe83c75ff22
          type: developer
    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
  securitySchemes:
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) in the
        Konnect dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
    systemAccountAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The system account access token is meant for automations and
        integrations that are not directly associated with a human identity.

        You can generate a system account Access Token by creating a system
        account and then obtaining a system account access token for that
        account.

        The access token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer spat_i2Ej...'`
```
