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

Create Team

Creates a developer team in a portal. Developers can be added to teams to provide RBAC access to API products. Teams can be assigned roles that grant permissions to perform an action on a resource.

post

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Body

application/json

Create a team in a portal.

PortalCreateTeamRequest

Details about a team to create.

namestringrequired

Match pattern:^[\w \W]+$

Example:IDM - Developers

descriptionstring

<= 250 characters

Example:The Identity Management (IDM) team.

Response

application/json

Details about a team of developers in a portal.

PortalTeamResponse

Details about a developer team.

idstring(uuid)read-only

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

namestring

Match pattern:^[\w \W]+$

<= 250 characters

Example:IDM - Developers

descriptionstring

<= 250 characters

Example:The developers for the IDM API.

created_atstring(date-time)read-only

Example:1992-02-07T17:46:57.52Z

updated_atstring(date-time)read-only

Example:2022-02-07T17:00:00.52Z

post/portals/{portalId}/teams

Body

{ "name": "IDM - Developers", "description": "The Identity Management (IDM) team." }
 
application/json

Get Team

Get an individual team.

get

Path Parameters

teamIdstring(uuid)required

ID of the team.

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

portalIdstring(uuid)required

ID of the portal.

Response

application/json

Details about a team of developers in a portal.

PortalTeamResponse

Details about a developer team.

idstring(uuid)read-only

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

namestring

Match pattern:^[\w \W]+$

<= 250 characters

Example:IDM - Developers

descriptionstring

<= 250 characters

Example:The developers for the IDM API.

created_atstring(date-time)read-only

Example:1992-02-07T17:46:57.52Z

updated_atstring(date-time)read-only

Example:2022-02-07T17:00:00.52Z

get/portals/{portalId}/teams/{teamId}
 
application/json