List Available Auth Strategies

Retrieve the auth strategies on this portal.
An auth strategy represents the way your application provides credentials to authenticate with an API.

get
/api/v3/application-auth-strategies

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

filter[name][eq]string

Filter by direct equality comparison of the name property with a supplied value.

Example:good service

filter[name]string

Filter by direct equality comparison (short-hand) of the name property with a supplied value.

Example:good service

filter[name][contains]string

Filter by contains comparison of the name property with a supplied substring

Example:good service

filter[credential_type][eq]string

Filter by direct equality comparison of the credential_type with a supplied value.

Allowed values:client_credentialsself_managed_client_credentialskey_auth

Example:key_auth

Response

application/json

List auth strategies response

ListAuthStrategiesResponse

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataOne Of
array[object]required
PortalAuthStrategyKeyAuthobject

KeyAuth Auth strategy that the application uses.

Show Child Parameters
application/json

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.

post
/api/v3/applications/{applicationId}/regenerate-secret

Path Parameters

applicationIdstring(uuid)required

Id of the targeted application

Response

application/json

Regenerate secret response

Regenerate secret response

Regenerate secret response

* Additional properties are NOT allowed.
client_idstringrequired
client_secretstringrequired
application/json

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.
get
/api/v3/applications/{applicationId}/credentials

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

Path Parameters

applicationIdstring(uuid)required

Id of the targeted application

Response

application/json

List credentials response

ListCredentialsResponse

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataOne Of
array[object]required
ApiKeyCredentialListItemobject

API key credential returned when listing credentials.

* Additional properties are NOT allowed.
Show Child Parameters
application/json

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.
post
/api/v3/applications/{applicationId}/credentials

Path Parameters

applicationIdstring(uuid)required

Id of the targeted application

Body

application/json

Create a credential

CreateCredentialRequest

* Additional properties are NOT allowed.
display_namestring

<= 255 characters

Response

application/json

Credential Creation success

CredentialCreationResponse

CredentialCreationResponseobject
One Of
typestringrequiredread-only

Allowed values:api_key

idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

display_namestringrequired
credentialstringrequired

The API key value (only returned on creation)

statusstringread-only

Allowed values:activeexpiredrevoked

expires_atstring | null(date-time)read-only
created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

application/json