List Portal Products
Lists the API products that are published to this developer portal. An API product packages together multiple versions of each API, displaying each version with its set of operations and documentation. Developers can browse API Products to learn about and register for them. API Products access can be limited to certain developers using RBAC and developer teams.
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
Sorts a collection of Portal Products. Supported sort attributes are:
- created_at
- name
- description
Filters a collection of Portal Products.
Show Child Parameters
Path Parameters
ID of the portal.
Response
application/json
Response
A paginated list of API products published to a portal.
ListPortalProductsResponse
A paginated list of API products published to a portal.
returns the pagination information
Show Child Parameters
Example:{"id":"7cdcba18-5bdf-4936-81de-d76da02cb99b","name":"Excellent API","description":"Excellent for serving","created_at":"2022-05-24T18:40:35.500Z","updated_at":"2022-05-24T18:40:35.500Z","portal_ids":["83f1733c-862c-43e5-a005-acfb0addfcfb"],"labels":{"department":"marketing"},"version_count":4}
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Portal Auth Settings
APIs related to Konnect Developer Portal Authentication Settings.
Get Auth Settings
Returns the developer authentication configuration for a portal, which determines how developers can log in and how they are assigned to teams.
Path Parameters
ID of the portal.
Response
application/json
Response
Details about a portal’s authentication settings.
PortalAuthenticationSettingsResponse
The developer authentication settings for a portal.
The portal has basic auth enabled or disabled.
Example:true
The portal has OIDC enabled or disabled.
Example:false
The portal has SAML enabled or disabled.
Example:false
IdP groups determine the Portal Teams a developer has.
Example:true
IdP groups determine the Portal Teams a developer has. This will soon replace oidc_team_mapping_enabled.
Example:true
A Konnect Identity Admin assigns teams to a developer.
Example:false
Configuration properties for an OpenID Connect Identity Provider.
Example:{"issuer":"https://identity.example.com/v2","client_id":"x7id0o42lklas0blidl2","scopes":["email","openid","profile"],"claim_mappings":{"name":"name","email":"email","groups":"custom-group-claim"}}
Show Child Parameters
Authentication
Path Parameters
Update Auth Settings
Updates the developer authentication configuration for a portal. Developers can be allowed to login using basic auth (email & password) or use Single-Sign-On (SSO) through an OIDC Identity Provider (IdP). Developers can be automatically assigned to teams by mapping claims from thier IdP account.
Path Parameters
ID of the portal.
Body
application/json
Body
Update a portal’s developer authentication settings.
PortalAuthenticationSettingsUpdateRequest
Properties to update a portal’s developer auth settings.
The organization has basic auth enabled.
Example:true
The organization has OIDC disabled.
Example:false
The portal has SAML enabled or disabled.
Example:false
Whether IdP groups determine the Konnect Portal teams a developer has.
Example:true
Whether a Konnect Identity Admin assigns teams to a developer.
Example:false
Whether IdP groups determine the Konnect Portal teams a developer has. This will soon replace oidc_team_mapping_enabled.
Example:true
Default:openid
Mappings from a portal developer atribute to an Identity Provider claim.
Example:{"name":"name","email":"email","groups":"custom-group-claim"}
Show Child Parameters
Response
application/json
Response
Details about a portal’s authentication settings.
PortalAuthenticationSettingsResponse
The developer authentication settings for a portal.
The portal has basic auth enabled or disabled.
Example:true
The portal has OIDC enabled or disabled.
Example:false
The portal has SAML enabled or disabled.
Example:false
IdP groups determine the Portal Teams a developer has.
Example:true
IdP groups determine the Portal Teams a developer has. This will soon replace oidc_team_mapping_enabled.
Example:true
A Konnect Identity Admin assigns teams to a developer.
Example:false
Configuration properties for an OpenID Connect Identity Provider.
Example:{"issuer":"https://identity.example.com/v2","client_id":"x7id0o42lklas0blidl2","scopes":["email","openid","profile"],"claim_mappings":{"name":"name","email":"email","groups":"custom-group-claim"}}
Show Child Parameters
Authentication
Path Parameters
Body
List Team Group Mappings
Lists mappings between Konnect portal teams and Identity Provider (IdP) groups. Returns a 400 error if an IdP has not yet been configured.
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 portal.
Response
application/json
Response
A paginated collection of mappings grouped by team ID.
PortalTeamGroupMappingResponse
A paginated list of portal team group mappings.
returns the pagination information
Show Child Parameters
A map of portal teams to Identity Provider groups.
Example:{"team_id":"6801e673-cc10-498a-94cd-4271de07a0d3","groups":["Tech Leads","API Engineers"]}