Create Developer Account

Creates a new developer account in the specified portal.

post

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Body

application/json

Create a developer for a portal.

CreateDeveloperRequest

Request body for creating a developer in a portal.

* Additional properties are NOT allowed.
emailstring(email)required

<= 255 characters

full_namestringrequired

<= 255 characters

statusstring

When omitted, the portal’s auto_approve_developers setting determines the initial status. Set this property to override the portal default with any valid developer status.

Allowed values:approvedpendingrevokedrejected

Example:approved

send_invitation_emailboolean

When true, sends an invitation email to the developer. Default is false; no emails are sent unless explicitly requested.

Default:false

Response

application/json

Details about the created developer in a portal.

PortalDeveloper

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

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

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

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

emailstring(email)required

<= 255 characters

full_namestringrequired

<= 255 characters

statusstringrequired

The status of a developer in a portal. Approved developers can log in, create applications, and view and register for products they have access to. Pending, revoked, and rejected developers cannot login or view any non-public portal information, or create or modify applications or registrations.

Allowed values:approvedpendingrevokedrejected

Example:approved

post/portals/{portalId}/developers

Body

{ "email": "developer@example.com", "full_name": "Developer Name" }
 
application/json

Portal Integrations

APIs to configure Konnect Developer Portal integrations.

Get Portal Integration Configurations

Returns the portal integration configurations.

get

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

application/json

The current integration configurations for a portal.

Portal Integrations

Configuration data for Dev Portal integrations

Default:{}

* Additional properties are NOT allowed.
google_tag_managerobject | null

Google Tag Manager integration configuration

* Additional properties are NOT allowed.
Show Child Parameters
google_analytics_4object | null

Google Analytics integration configuration

* Additional properties are NOT allowed.
Show Child Parameters
get/portals/{portalId}/integrations
 
application/json

Replace Integration Configurations

Replace the portal integration configurations.

put

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Body

application/json

Portal Integrations

Configuration data for Dev Portal integrations

Default:{}

* Additional properties are NOT allowed.
google_tag_managerobject | null

Google Tag Manager integration configuration

* Additional properties are NOT allowed.
Show Child Parameters
google_analytics_4object | null

Google Analytics integration configuration

* Additional properties are NOT allowed.
Show Child Parameters

Response

application/json

The current integration configurations for a portal.

Portal Integrations

Configuration data for Dev Portal integrations

Default:{}

* Additional properties are NOT allowed.
google_tag_managerobject | null

Google Tag Manager integration configuration

* Additional properties are NOT allowed.
Show Child Parameters
google_analytics_4object | null

Google Analytics integration configuration

* Additional properties are NOT allowed.
Show Child Parameters
put/portals/{portalId}/integrations

Body

{}
 
application/json

Update Integration Configurations

Update the portal integration configurations, merging properties.

patch

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Body

application/json

Update Portal Integrations

Partially update configuration data for Dev Portal integrations

Default:{}

* Additional properties are NOT allowed.
google_tag_managerobject | null

Partially update Google Tag Manager integration configuration

* Additional properties are NOT allowed.
Show Child Parameters
google_analytics_4object | null

Partially update Google Analytics 4 integration configuration

* Additional properties are NOT allowed.
Show Child Parameters

Response

application/json

The current integration configurations for a portal.

Portal Integrations

Configuration data for Dev Portal integrations

Default:{}

* Additional properties are NOT allowed.
google_tag_managerobject | null

Google Tag Manager integration configuration

* Additional properties are NOT allowed.
Show Child Parameters
google_analytics_4object | null

Google Analytics integration configuration

* Additional properties are NOT allowed.
Show Child Parameters
patch/portals/{portalId}/integrations

Body

{}
 
application/json