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.

get

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

application/json

Details about a portal’s authentication settings.

PortalAuthenticationSettingsResponse

The developer authentication settings for a portal.

basic_auth_enabledbooleanrequired

The portal has basic auth enabled or disabled.

Example:true

oidc_auth_enabledbooleanrequiredDEPRECATED

The portal has OIDC enabled or disabled.

Example:false

saml_auth_enabledbooleanDEPRECATED

A Konnect Identity Admin assigns teams to a developer.

Example:false

oidc_team_mapping_enabledbooleanrequiredDEPRECATED

IdP groups determine the Portal Teams a developer has. Replaced by idp_mapping_enabled.

Example:true

idp_mapping_enabledboolean

Whether IdP groups determine the Konnect Portal teams a developer has.

Example:true

konnect_mapping_enabledbooleanrequired

A Konnect Identity Admin assigns teams to a developer.

Example:false

oidc_configobjectread-onlyDEPRECATED

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
get/portals/{portalId}/authentication-settings
 
application/json

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.

patch

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Body

application/json

Update a portal’s developer authentication settings.

PortalAuthenticationSettingsUpdateRequest

Properties to update a portal’s developer auth settings.

basic_auth_enabledboolean

The organization has basic auth enabled.

Example:true

oidc_auth_enabledbooleanDEPRECATED

Deprecated. Use the Identity Provider API instead.

Example:false

saml_auth_enabledbooleanDEPRECATED

Deprecated. Use the Identity Provider API instead.

Example:false

oidc_team_mapping_enabledbooleanDEPRECATED

IdP groups determine the Portal Teams a developer has. Replaced by idp_mapping_enabled.

Example:true

konnect_mapping_enabledboolean

Whether a Konnect Identity Admin assigns teams to a developer.

Example:false

idp_mapping_enabledboolean

Whether IdP groups determine the Konnect Portal teams a developer has.

Example:true

oidc_issuerstringDEPRECATED

Deprecated. Use the Identity Provider API instead.

oidc_client_idstringDEPRECATED

Deprecated. Use the Identity Provider API instead.

oidc_client_secretstringDEPRECATED

Deprecated. Use the Identity Provider API instead.

oidc_scopesarray[string]DEPRECATED

Deprecated. Use the Identity Provider API instead.

Default:openid

oidc_claim_mappingsobjectDEPRECATED

Deprecated. Use the Identity Provider API instead.

Example:{"name":"name","email":"email","groups":"custom-group-claim"}

Show Child Parameters

Response

application/json

Details about a portal’s authentication settings.

PortalAuthenticationSettingsResponse

The developer authentication settings for a portal.

basic_auth_enabledbooleanrequired

The portal has basic auth enabled or disabled.

Example:true

oidc_auth_enabledbooleanrequiredDEPRECATED

The portal has OIDC enabled or disabled.

Example:false

saml_auth_enabledbooleanDEPRECATED

A Konnect Identity Admin assigns teams to a developer.

Example:false

oidc_team_mapping_enabledbooleanrequiredDEPRECATED

IdP groups determine the Portal Teams a developer has. Replaced by idp_mapping_enabled.

Example:true

idp_mapping_enabledboolean

Whether IdP groups determine the Konnect Portal teams a developer has.

Example:true

konnect_mapping_enabledbooleanrequired

A Konnect Identity Admin assigns teams to a developer.

Example:false

oidc_configobjectread-onlyDEPRECATED

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
patch/portals/{portalId}/authentication-settings

Body

{ "basic_auth_enabled": true, "oidc_auth_enabled": true, "oidc_team_mapping_enabled": true, "konnect_mapping_enabled": false, "oidc_issuer": "https://identity.example.com/v2", "oidc_client_id": "x7id0o42lklas0blidl2", "oidc_scopes": [ "email", "openid", "profile" ], "oidc_claim_mappings": { "name": "name", "email": "email", "groups": "custom-group-claim" } }
 
application/json

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.

get

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

portalIdstring(uuid)required

ID of the portal.

Response

application/json

A paginated collection of mappings grouped by team ID.

PortalTeamGroupMappingResponse

A paginated list of portal team group mappings.

metaobject

returns the pagination information

Show Child Parameters
dataarray[object]

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
get/portals/{portalId}/identity-provider/team-group-mappings
 
application/json

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.

patch

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Body

application/json

PortalTeamGroupMappingsUpdateRequest

A set of mappings to update from a team to their groups.

dataarray[object]

The IdP groups to map to the given team.

Show Child Parameters

Response

application/json

A paginated collection of mappings grouped by team ID.

PortalTeamGroupMappingResponse

A paginated list of portal team group mappings.

metaobject

returns the pagination information

Show Child Parameters
dataarray[object]

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
patch/portals/{portalId}/identity-provider/team-group-mappings

Body

{ "data": [ { "team_id": "af91db4c-6e51-403e-a2bf-33d27ae50c0a", "groups": [ "Service Developer" ] } ] }
 
application/json

List Identity Providers

Retrieves the identity providers available within the portal. This operation provides information about
various identity providers for SAML or OIDC authentication integrations.

get

Query Parameters

filterobject

Filter identity providers returned in the response.

Show Child Parameters

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

application/json

A collection of identity providers. This response contains a collection of identity providers, which may include both OIDC and SAML identity providers.

Identity Provider Collection Response

The identity provider that contains configuration data for authentication integration.

idstring(uuid)read-only

Contains a unique identifier used for this resource.

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

typestring

Specifies the type of identity provider.

Allowed values:oidcsaml

Example:oidc

enabledboolean

Indicates whether the identity provider is enabled.
Only one identity provider can be active at a time, such as SAML or OIDC.

Default:false

Example:true

configOne Of
object
OIDC Identity Provider Configobject

The identity provider that contains configuration data for the OIDC authentication integration.

* Additional properties are NOT allowed.
Show Child Parameters
created_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity creation date.

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

updated_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity update date.

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

get/portals/{portalId}/identity-providers
 
application/json