Update Customization

Update the portal customization options, merging properties.

patch

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Body

application/json

PortalCustomization

The custom settings of this portal

* Additional properties are NOT allowed.
themeobject
* Additional properties are NOT allowed.
Show Child Parameters
layoutstring
cssstring | null
jsobject
* Additional properties are NOT allowed.
Show Child Parameters
menuobject
* Additional properties are NOT allowed.
Show Child Parameters
spec_rendererobject
* Additional properties are NOT allowed.
Show Child Parameters
robotsstring | null

Response

application/json

The current customization options for a portal.

PortalCustomization

The custom settings of this portal

* Additional properties are NOT allowed.
themeobject
* Additional properties are NOT allowed.
Show Child Parameters
layoutstring
cssstring | null
jsobject
* Additional properties are NOT allowed.
Show Child Parameters
menuobject
* Additional properties are NOT allowed.
Show Child Parameters
spec_rendererobject
* Additional properties are NOT allowed.
Show Child Parameters
robotsstring | null
patch/portals/{portalId}/customization

Body

{}
 
application/json

Portal Auth Settings

APIs related to configuration of Konnect Developer Portal auth settings.

List Team Group Mappings

Returns a paginated list of team group mappings for the specified identity provider.

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[after]string

Request the next page of data, starting with the item after this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

page[before]string

Request the next page of data, starting with the item before this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

filterobject

Filter mappings by team ID or group name.

Show Child Parameters

Path Parameters

portalIdstring(uuid)required

ID of the portal.

idstring(uuid)required

ID of the identity provider.

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Response

application/json

A paginated collection of team group mappings.

PortalIdpTeamGroupMappingCollectionResponse

metaobjectrequired

Pagination metadata.

Show Child Parameters
dataarray[object]required
Show Child Parameters
get/portals/{portalId}/identity-providers/{id}/team-group-mappings
 
application/json

Create Team Group Mapping

Creates a new team group mapping for the specified identity provider.

post

Path Parameters

portalIdstring(uuid)required

ID of the portal.

idstring(uuid)required

ID of the identity provider.

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Body

application/json

Create a team group mapping for an identity provider.

CreatePortalIdpTeamGroupMappingRequest

team_idstring(uuid)required

The Konnect team ID.

Example:6801e673-cc10-498a-94cd-4271de07a0d3

groupstringrequired

The IdP group name.

Example:API Engineers

Response

application/json

A team group mapping for an identity provider.

PortalIdpTeamGroupMapping

idstring(uuid)requiredread-only

The mapping ID.

Example:a1b2c3d4-e5f6-4a8b-9c0d-1e2f3a4b5c6d

team_idstring(uuid)required

The Konnect team ID.

Example:6801e673-cc10-498a-94cd-4271de07a0d3

groupstringrequired

The IdP group name.

Example:API Engineers

created_atstring(date-time)requiredread-only

Creation timestamp.

Example:2024-01-15T10:30:00Z

updated_atstring(date-time)requiredread-only

Last update timestamp.

Example:2024-01-15T10:30:00Z

post/portals/{portalId}/identity-providers/{id}/team-group-mappings

Body

{ "team_id": "6801e673-cc10-498a-94cd-4271de07a0d3", "group": "API Engineers" }
 
application/json

Get Team Group Mapping

Returns the team group mapping for the specified ID.

get

Path Parameters

portalIdstring(uuid)required

ID of the portal.

idstring(uuid)required

ID of the identity provider.

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

mappingIdstring(uuid)required

ID of the team group mapping.

Response

application/json

A team group mapping for an identity provider.

PortalIdpTeamGroupMapping

idstring(uuid)requiredread-only

The mapping ID.

Example:a1b2c3d4-e5f6-4a8b-9c0d-1e2f3a4b5c6d

team_idstring(uuid)required

The Konnect team ID.

Example:6801e673-cc10-498a-94cd-4271de07a0d3

groupstringrequired

The IdP group name.

Example:API Engineers

created_atstring(date-time)requiredread-only

Creation timestamp.

Example:2024-01-15T10:30:00Z

updated_atstring(date-time)requiredread-only

Last update timestamp.

Example:2024-01-15T10:30:00Z

get/portals/{portalId}/identity-providers/{id}/team-group-mappings/{mappingId}
 
application/json