Portal Developers

Update Developer

Changed on

Updates the status of a particular developer. Approved developers have access to login to the portal. Revoked, rejected, or pending are not allowed to login. Even if a developer's status is no longer approved, they will still be able to using any existing credentials generated while they were approved, until each application registration is revoked or deleted.

patch/v3/portals/{portalId}/developers/{developerId}

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v3/portals/{portalId}/developers/{developerId}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Request body

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

The status of a developer in a portal. Approved developers can log in, create applications, and view and register for products they have access to. Pending, revoked, and rejected developers cannot login or view any non-public portal information, or create or modify applications or registrations.

Example request

{
  "status": "approved"
}

Response

Details about the developer 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.

emailstring email required
full_namestring required
status'approved' | 'pending' | 'revoked' | 'rejected' required

The status of a developer in a portal. Approved developers can log in, create applications, and view and register for products they have access to. Pending, revoked, and rejected developers cannot login or view any non-public portal information, or create or modify applications or registrations.

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": "7cd9feff-b4da-4a9f-ba49-cbe83c75ff22",
  "email": "developer@example.com",
  "full_name": "Jane Dev",
  "status": "approved",
  "created_at": "2022-11-15T20:37:41.457Z",
  "updated_at": "2022-11-15T20:37:47.456Z"
}

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