---
title: "Create Credential"
url: "https://nov18-dev.movespot.fyi/apis/portal-developer-applications-2/versions/3bce3c1f-0ff6-442b-b037-768253e6d227/operations/create-credential"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/portal-developer-applications-2/versions/3bce3c1f-0ff6-442b-b037-768253e6d227.md

# Create Credential

`POST` `/api/v3/applications/{applicationId}/credentials`

Operation ID: `create-credential`

Allows a developer to create a credential for an application they own. Creates credential based on application's auth strategy: - For Client-Credential applications: Creates new client secret - For Key-Auth applications: Creates new API key credential Some Client Credentials applications may not support setting a display_name. Secret value (`client_secret` for Client Credentials, `credential` for Key Auth API keys) is only returned on creation (one-time), not in subsequent list operations.

## Path parameters

- `applicationId` (string, uuid, required) - Id of the targeted application

## Request body

Content types: `application/json`

## Responses

- `201` - Credential Creation success
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Error returned when the number of credentials exceed the quota.
- `404` - Not Found

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Portal Developer Applications
  version: 3.3.3
paths:
  /api/v3/applications/{applicationId}/credentials:
    post:
      operationId: create-credential
      summary: Create Credential
      description: >
        Allows a developer to create a credential for an application they own.

        Creates credential based on application's auth strategy:

        - For Client-Credential applications: Creates new client secret

        - For Key-Auth applications: Creates new API key credential

        Some Client Credentials applications may not support setting a
        display_name.

        Secret value (`client_secret` for Client Credentials, `credential` for
        Key Auth API keys) is only returned on creation (one-time), not in
        subsequent list operations.
      parameters:
        - $ref: "#/components/parameters/ApplicationId"
      requestBody:
        $ref: "#/components/requestBodies/CreateCredential"
      responses:
        "201":
          $ref: "#/components/responses/CredentialCreation"
        "400":
          $ref: "#/components/responses/BadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/PostCredentials403Response"
        "404":
          $ref: "#/components/responses/NotFound"
      security:
        - portalAccessToken: []
      tags:
        - Credentials
security:
  - portalAccessToken: []
components:
  parameters:
    ApplicationId:
      name: applicationId
      in: path
      required: true
      description: Id of the targeted application
      schema:
        type: string
        format: uuid
  requestBodies:
    CreateCredential:
      description: Create a credential
      required: false
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/CreateCredentialRequest"
  responses:
    CredentialCreation:
      description: Credential Creation success
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/CredentialCreationResponse"
          examples:
            ApiKeyCredentialCreationResponse:
              $ref: "#/components/examples/ApiKeyCredentialCreationResponseExample"
            ClientSecretCredentialCreationResponse:
              $ref: "#/components/examples/AzureClientSecretCredentialCreationResponseExample"
    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"
    PostCredentials403Response:
      description: Error returned when the number of credentials exceed the quota.
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            PostCredentials403Example:
              $ref: "#/components/examples/PostCredentials403Example"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  schemas:
    CreateCredentialRequest:
      type: object
      properties:
        display_name:
          type: string
          maxLength: 255
      additionalProperties: false
    CredentialCreationResponse:
      type: object
      discriminator:
        propertyName: type
      oneOf:
        - $ref: "#/components/schemas/ApiKeyCredentialCreationResponse"
        - $ref: "#/components/schemas/ClientSecretCredentialCreationResponse"
    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
    NotFoundError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 404
            title:
              example: Not Found
            type:
              example: https://httpstatuses.com/404
            instance:
              example: kong:trace:1234567890
            detail:
              example: Not found
    ApiKeyCredentialCreationResponse:
      description: Response when creating an API key credential.
      type: object
      properties:
        type:
          type: string
          enum:
            - api_key
          readOnly: true
        id:
          $ref: "#/components/schemas/UUID"
        display_name:
          type: string
        credential:
          description: The API key value (only returned on creation)
          type: string
        status:
          type: string
          enum:
            - active
            - expired
            - revoked
          readOnly: true
        expires_at:
          type: string
          format: date-time
          nullable: true
          readOnly: true
        created_at:
          $ref: "#/components/schemas/CreatedAt"
      additionalProperties: false
      required:
        - type
        - id
        - display_name
        - credential
        - created_at
    ClientSecretCredentialCreationResponse:
      description: Response when creating a client secret credential.
      type: object
      properties:
        type:
          type: string
          enum:
            - client_secret
          readOnly: true
        id:
          description: Credential identifier
          type: string
        display_name:
          type: string
          nullable: true
        client_id:
          type: string
          readOnly: true
        client_secret:
          description: Client secret value (only returned on creation)
          type: string
        created_at:
          type: string
          format: date-time
          nullable: true
          readOnly: true
        expires_at:
          description: Expiration timestamp, if applicable
          type: string
          format: date-time
          nullable: true
          readOnly: true
      additionalProperties: false
      required:
        - type
        - id
        - client_id
        - client_secret
        - created_at
    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
    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
    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
    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:
    ApiKeyCredentialCreationResponseExample:
      value:
        type: api_key
        id: 5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
        display_name: My API Key
        credential: sk_live_abc123def456
        status: active
        expires_at: null
        created_at: 2025-01-01T00:00:00.000Z
    AzureClientSecretCredentialCreationResponseExample:
      value:
        type: client_secret
        id: 6e5f4d3c-2b1a-0987-6543-210fedcba987
        display_name: null
        client_id: 12345678-abcd-efgh-ijkl-mnopqrstuvwx
        client_secret: azR~8Q~abcdefghijklmnopqrstuvwxyz123456
        created_at: 2024-01-15T10:30:00.000Z
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    PostCredentials403Example:
      value:
        status: 403
        title: Forbidden
        detail: "Maximum number of Credentials exceeded. Max Allowed: 20"
        instance: kong:trace:2724154947768991355
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
  securitySchemes:
    portalAccessToken:
      type: apiKey
      in: cookie
      name: portalaccesstoken
      description: >
        The Developer portal cookie is meant to be used by the Developer API to
        authenticate with.
```
