Update Developer

Updates the status of a particular developer. Approved developers have access to login to the portal. Revoked, rejected, or pending are not allowed to login. Even if a developer’s status is no longer approved, they will still be able to using any existing credentials generated while they were approved, until each application registration is revoked or deleted.

patch

Path Parameters

portalIdstring(uuid)required

ID of the portal.

developerIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

Body

application/json

Update a developer.

UpdateDeveloperRequest

* Additional properties are NOT allowed.
statusstring

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

Response

application/json

Details about the developer being updated.

UpdateDeveloperResponse

* 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

application_countnumberrequiredread-only

Example:4

patch/portals/{portalId}/developers/{developerId}

Body

{ "status": "approved" }
 
application/json

Delete Developer

Deletes a developer, which will discontinue their ability to login, view any non-public resources, and delete all applications owned by them. All credentials issued to the developer will no longer provide access to any API Products. A deleted developer’s unique email must be re-registered and approved to gain access again.

delete

Path Parameters

portalIdstring(uuid)required

ID of the portal.

developerIdstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

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

Response

No Content

delete/portals/{portalId}/developers/{developerId}
 

List Developers

Lists the developers that have registered for this portal. Each developer can be registered to one portal and must be approved to login unless using the developer auto-approve setting.

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

sortstring

Sorts a collection of developers. Supported sort attributes are:

  • created_at
  • updated_at
  • email
  • name
  • status
filterobject

Filter developers returned in the response.

Show Child Parameters

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

application/json

A paginated list of developers in a portal.

ListDevelopersResponse

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

Example:{"id":"7cd9feff-b4da-4a9f-ba49-cbe83c75ff22","email":"developer@example.com","full_name":"Jane Dev","status":"approved","application_count":3,"created_at":"2022-11-15T20:37:41.457Z","updated_at":"2022-11-15T20:37:47.456Z"}

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

Portal Teams

APIs related to Konnect Developer Portal Developer Teams.

List Teams

Lists the developer teams in a portal. Each team can contain any developer and developers can be part of multiple teams.

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

filterobject

Filter teams returned in the response.

Show Child Parameters

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

application/json

A paginated list of teams in a portal.

ListPortalTeamsResponse

A paginated list of teams in a portal.

metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

Details about a developer team.

Example:{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","name":"IDM - Developers","description":"The developers for the IDM API.","created_at":"1992-02-07T17:46:57.52Z","updated_at":"2022-08-31T17:00:00.52Z"}

Show Child Parameters
get/portals/{portalId}/teams
 
application/json