Application Registrations

Update Registration

Changed on

Updates the status of a particular application registration to an API. Approved application registrations will allow API traffic to the corresponding API. Revoked, rejected, or pending will not allow API traffic.

patch/v3/portals/{portalId}/applications/{applicationId}/registrations/{registrationId}

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v3/portals/{portalId}/applications/{applicationId}/registrations/{registrationId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Request body

status'approved' | 'pending' | 'revoked' | 'rejected'

The status of an application registration request. Each registration is linked to a single API, and application credentials will not grant access to the API until the registration is approved. Pending, revoked, and rejected registrations will not provide access to the API.

Example request

{
  "status": "rejected"
}

Response

Details about the application registration being updated.

idstring uuid required

Contains a unique identifier used for this resource.

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

status'approved' | 'pending' | 'revoked' | 'rejected' required

The status of an application registration request. Each registration is linked to a single API, and application credentials will not grant access to the API until the registration is approved. Pending, revoked, and rejected registrations will not provide access to the API.

additional_dataFormResponseData

A developer's submitted answers to a form, as a map from each field's name to a record of that answer. Each record captures the field's label, type, and value exactly as they appeared when the developer submitted the form. Encrypted at rest.

Example response

{
  "id": "c300cc33-2d33-4754-b086-a98e0fcd36fb",
  "status": "approved",
  "application": {
    "id": "c15e2460-ba40-431d-9df0-4957fcff7cda",
    "name": "App 1"
  },
  "api": {
    "id": "86f637b7-cd95-478b-9b02-d770618f641c",
    "name": "Great Stuff",
    "version": "v1",
    "entity_type": "api"
  },
  "created_at": "2022-12-22T20:13:07.305Z",
  "updated_at": "2022-12-22T20:13:36.710Z"
}

Changes

  • 7aab863a6daaRevision changes
    • breaking

      added to the / response property oneOf list for the response status

    • warning

      added the new key_invalid enum value to the ////// response property for the response status

    • warning

      added the new unique enum value to the ////// response property for the response status

  • 68d43091b84dRevision changes
    • warning

      added the new 400.00 enum value to the response property for the response status

    • warning

      added the new 403.00 enum value to the response property for the response status

    • warning

      added the new 404.00 enum value to the response property for the response status