Portal Auth Settings
APIs related to configuration of Konnect Developer Portal auth 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
A Konnect Identity Admin assigns teams to a developer.
Example:false
IdP groups determine the Portal Teams a developer has. Replaced by idp_mapping_enabled.
Example:true
Whether IdP groups determine the Konnect Portal teams a developer has.
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 through an Identity Provider. Developers can be automatically assigned to teams by mapping claims from their 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
IdP groups determine the Portal Teams a developer has. Replaced by idp_mapping_enabled.
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.
Example:true
Deprecated. Use the Identity Provider API instead.
Deprecated. Use the Identity Provider API instead.
Deprecated. Use the Identity Provider API instead.
Deprecated. Use the Identity Provider API instead.
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
A Konnect Identity Admin assigns teams to a developer.
Example:false
IdP groups determine the Portal Teams a developer has. Replaced by idp_mapping_enabled.
Example:true
Whether IdP groups determine the Konnect Portal teams a developer has.
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
Pre-release Endpoint
This endpoint is currently in beta and is subject to change.
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"]}
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Update Team Group Mappings
Pre-release Endpoint
This endpoint is currently in beta and is subject to change.
Allows partial updates to the mappings between Konnect portal teams and Identity Provider (IdP) groups. The request body must be keyed on team ID. For a given team ID, the given group list is a complete replacement. To remove all mappings for a given team, provide an empty group list.
Returns a 400 error if an IdP has not yet been configured, or if a team ID in the request body is not found or is not a UUID.
Path Parameters
ID of the portal.
Body
application/json
Body
PortalTeamGroupMappingsUpdateRequest
A set of mappings to update from a team to their groups.
The IdP groups to map to the given team.
Show Child Parameters
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"]}