API docs by Redocly

Portal Authentication (3.0.0)

Download OpenAPI specification:Download

URL: https://cloud.konghq.com

The API for Konnect Portal authentication.

Developer

API for managing a Konnect Portal Developer.

Login

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

This endpoint allows a developer to authenticate to their portal using a username and password.

Request Body schema: application/json

The request schema for the authenticate endpoint.

username
required
string <email>
password
required
string <password>

Responses

Request samples

Content type
application/json
{
  • "username": "developer@example.com",
  • "password": "<!N0taP@$$w0rd!>"
}

Response samples

Content type
application/problem+json
Example
{
  • "status": 400,
  • "title": "Bad Request",
  • "instance": "konnect:trace:8988732526256293040",
  • "detail": "The provided token is invalid",
  • "invalid_parameters": [
    ]
}

SSO Login

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

This endpoint allows a developer to authenticate to their portal using an external IdP.

Responses

Response samples

Content type
application/problem+json
Example
{
  • "status": 400,
  • "title": "Bad Request",
  • "instance": "konnect:trace:8988732526256293040",
  • "detail": "The provided token is invalid",
  • "invalid_parameters": [
    ]
}

Refresh Access Token

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

This endpoint allows a developer to refresh their existing access token.

Responses

Response samples

Content type
application/problem+json
{
  • "status": 401,
  • "title": "Unauthorized",
  • "instance": "kong:trace:8347343766220159418",
  • "detail": "Unauthorized"
}

Logout

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

This endpoint allows a developer to logout of the portal. This operation revokes all active tokens and clears the portal cookies.

Responses

Reset Password

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

This endpoint allows a developer to reset their password, using a reset token.

Request Body schema: application/json

The request schema for the reset password endpoint.

password
required
string <password>
token
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "password": "<!D3finitelyN0taP@$$w0rd!>",
  • "token": "c8efd006-d8e1-4743-b91b-f163b9eae06a"
}

Response samples

Content type
application/problem+json
Example
{
  • "status": 400,
  • "title": "Bad Request",
  • "instance": "konnect:trace:8988732526256293040",
  • "detail": "The provided token is invalid",
  • "invalid_parameters": [
    ]
}

Verify Email

Pre-release Endpoint This endpoint is currently in beta and is subject to change.

This endpoint allows a new developer to verify their email.

Request Body schema: application/json

The request schema for the verify email endpoint.

token
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "token": "c8efd006-d8e1-4743-b91b-f163b9eae06a"
}

Response samples

Content type
application/json
{
  • "email": "developer@example.com",
  • "token": "c8efd006-d8e1-4743-b91b-f163b9eae06a"
}