App Auth Strategies

List application auth strategies

Returns a list of application auth strategies with their id and active status.

get
builder.apibuilder.svc.cluster.local:3000/v1/internal/application-auth-strategies

Query Parameters

filterobjectrequired

Filter parameters for filtering by ID

Show Child Parameters

Response

application/json

A response containing a list of application auth strategies with their status.

Active Response

The list of items with their active status

dataarray[object]required

The item with id and active status

Show Child Parameters
get/internal/application-auth-strategies
 
application/json

Upsert an application auth strategy

Accepts a raw database representation of the Auth Strategy in the request body.
Accepts a raw database representation of the DCR provider (if provided) in the response body.

put
builder.apibuilder.svc.cluster.local:3000/v1/internal/application-auth-strategies/{authStrategyId}

Path Parameters

authStrategyIdstring(uuid)required

ID of the auth strategy to use for the application

Example:ebbac5b0-ac89-45c3-9d2e-c4542c657e79

Body

application/json

AppAuthStrategy

AppAuthStrategyobject

A set of plugin configurations that represent how the gateway will perform authentication and authorization for a Product Version. Called “Auth Strategy” for short in the context of portals/applications. The plugins are synced to any Gateway Service that is currently linked or becomes linked to the Product Version.

One Of
idstring(uuid)required
org_idstring(uuid)required
namestringrequired

The name of the auth strategy. This is used to identify the auth strategy in the Konnect UI.

>= 1 characters<= 256 characters

display_namestringrequired

The display name of the Auth strategy. This is used to identify the Auth strategy in the Portal UI.

<= 256 characters

strategy_typestringrequired

Allowed values:key_auth

configsobjectrequired

JSON-B object containing the configuration for the Key Auth strategy

* Additional properties are NOT allowed.
Show Child Parameters
labelsobject | nullrequired

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Labels are intended to store INTERNAL metadata.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

dcr_providerobject
Show Child Parameters
created_atstring(date-time)required
updated_atstring(date-time)required

Response

application/json

A response containing a single DCR provider object.

AppAuthStrategy

AppAuthStrategyobject

A set of plugin configurations that represent how the gateway will perform authentication and authorization for a Product Version. Called “Auth Strategy” for short in the context of portals/applications. The plugins are synced to any Gateway Service that is currently linked or becomes linked to the Product Version.

One Of
idstring(uuid)required
org_idstring(uuid)required
namestringrequired

The name of the auth strategy. This is used to identify the auth strategy in the Konnect UI.

>= 1 characters<= 256 characters

display_namestringrequired

The display name of the Auth strategy. This is used to identify the Auth strategy in the Portal UI.

<= 256 characters

strategy_typestringrequired

Allowed values:key_auth

configsobjectrequired

JSON-B object containing the configuration for the Key Auth strategy

* Additional properties are NOT allowed.
Show Child Parameters
labelsobject | nullrequired

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Labels are intended to store INTERNAL metadata.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

dcr_providerobject
Show Child Parameters
created_atstring(date-time)required
updated_atstring(date-time)required
put/internal/application-auth-strategies/{authStrategyId}

Body

{ "id": "93f8380e-7798-4566-99e3-2edf2b57d289", "name": "strategy", "display_name": "strategy display name", "strategy_type": "key_auth", "org_id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7", "labels": {}, "configs": { "key-auth": { "key_names": [ "secret" ] } }, "created_at": "2023-01-01T00:00:00.000Z", "updated_at": "2023-01-01T00:00:00.000Z", "dcr_provider": { "id": "93f8380e-7798-4566-99e3-2edf2b57d289", "name": "DCR Auth0 1 - Segment A", "provider_type": "auth0", "issuer": "https://my-issuer.auth0.com/api/v2/", "dcr_config": { "initial_client_id": "abc123", "initial_client_audience": "https://my-custom-domain.com/api/v2/", "use_developer_managed_scopes": false }, "org_id": "7f9fd312-a987-4628-b4c5-bb4f4fddd5f7", "labels": {}, "created_at": "2023-01-01T00:00:00.000Z", "updated_at": "2023-01-01T00:00:00.000Z" } }
 
application/json

Deletes an application auth strategy.

Deletes the Auth Strategy.

delete
builder.apibuilder.svc.cluster.local:3000/v1/internal/application-auth-strategies/{authStrategyId}

Path Parameters

authStrategyIdstring(uuid)required

ID of the auth strategy to use for the application

Example:ebbac5b0-ac89-45c3-9d2e-c4542c657e79

Response

No Content.

delete/internal/application-auth-strategies/{authStrategyId}
 

apis