Credentials
The API for Konnect Portal developer credentials within a private portal (i.e. requires registration/authentication).
Regenerate Client Secret
Regenerates the client secret for an application.
Path Parameters
Id of the targeted application
Response
application/json
Response
Regenerate secret response
Regenerate secret response
Regenerate secret response
List Credentials
Lists the credentials for an application.
Response varies by auth strategy type:
- For Client-Credential applications: Returns the ID of each credential
- For Key-Auth applications: Returns the ID and name of each credential
Basic information about the credential is returned, but not the credential secret itself.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Path Parameters
Id of the targeted application
Response
application/json
Response
List credentials response
ListCredentialsResponse
returns the pagination information
Show Child Parameters
One OfAPI key credential returned when listing credentials.
Show Child Parameters
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_secretfor Client Credentials,credentialfor Key Auth API keys) is only returned on creation (one-time), not in subsequent list operations.
Path Parameters
Id of the targeted application
Body
application/json
Body
Create a credential
CreateCredentialRequest
<= 255 characters
Response
application/json
Response
Credential Creation success
CredentialCreationResponse
One OfAllowed values:api_key
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The API key value (only returned on creation)
Allowed values:activeexpiredrevoked
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
Update Credential
Updates a credential for an application owned by the current logged in developer.
Updates credential metadata (display_name).
Some Client Credentials applications may not support setting a display_name.
Returns 400 error if operation not supported for Client Credentials.
Path Parameters
Id of the targeted application
Id of the targeted credential.
Use the list-credentials endpoint to obtain the id field for each credential.
Body
application/json
Body
Update a credential
UpdateCredentialRequest
<= 255 characters
Response
Response
Credential successfully updated.