Assign Role

Assign a role to a developer team. This associates the set of permissions in a role with the team, so that they will be applied to any developer who is a member of the team.

post

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.

teamIdstring(uuid)required

ID of the team.

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

Body

application/json

Assign a role to a team.

PortalAssignRoleRequest

An assigned role associates a service and an action to a team.

role_namestringrequired

Example:API Viewer

entity_idstring(uuid)required

Example:e67490ce-44dc-4cbd-b65e-b52c746fc26a

entity_type_namestringrequired

Example:Services

entity_regionstringrequired

Region of the entity.

Allowed values:useuaumeinsg*

Example:eu

Response

application/json

Details about the role assignment.

PortalAssignedRoleResponse

An assigned role associates a service and an action to a team.

idstring(uuid)required

Example:eaf7adf1-32c8-4bbf-b960-d1f8456afe67

role_namestringrequired

Example:API Viewer

entity_idstring(uuid)required

Example:817d0422-45c9-4d88-8d64-45aef05c1ae7

entity_type_namestringrequired

Example:Services

entity_regionstringrequired

Region of the entity.

Allowed values:useuaumeinsg*

Example:eu

post/portals/{portalId}/teams/{teamId}/assigned-roles

Body

{ "role_name": "API Viewer", "entity_id": "18ee2573-dec0-4b83-be99-fa7700bcdc61", "entity_type_name": "Services", "entity_region": "us" }
 
application/json

Remove Role

Removes an assigned role from a developer team. This deletes the association of the role with team and each of its members.

delete

Path Parameters

roleIdstring(uuid)required

Example:8350205f-a305-4e39-abe9-bc082a80091a

portalIdstring(uuid)required

ID of the portal.

teamIdstring(uuid)required

ID of the team.

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

Response

No Content

delete/portals/{portalId}/teams/{teamId}/assigned-roles/{roleId}
 

List Portal Roles

List roles that can be assigned to teams in a portal. Each role provides a set of permissions to perform an action on a resource.

get

Response

application/json

A set of roles available in portals.

ListRolesResponse

The set of roles available to associate with resources and assign to teams.

servicesobjectrequired
Show Child Parameters
get/portal-roles
 
application/json

Portal Applications

APIs related to Konnect Developer Portal Applications.

List Applications

Lists applications created by developers in this portal. Each application can be registered for various API Products (by version), issuing credentials for API request access. If using DCR, an application will be linked to an Identity Provider’s application by its reference_id.

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 applications. Supported sort attributes are:

  • created_at
  • developer_id
  • name
filterobject

Filter applications returned in the response.

Show Child Parameters

Path Parameters

portalIdstring(uuid)required

ID of the portal.

Response

application/json

A paginated list of applications in a portal.

ListApplicationsResponse

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

Example:{"id":"b15e2460-ba40-431d-9df0-4957fcffacda","labels":{"env":"test"},"name":"App 1","description":"An easy to manage app in a Konnect developer portal","reference_id":"df66b180-97df-4ddb-8b45-8b7d5eac56da","registration_count":4,"portal":{"id":"95606071-49c7-4c2e-ae49-8a86d72a8110"},"dcr_provider":null,"granted_scopes":null,"developer":{"id":"9cd9feff-b4da-4a9f-ba49-cbe83c75ff22","name":"Jane Dev","email":"jane.developer@example.com"},"created_at":"2022-12-22T19:09:30.712Z","updated_at":"2022-12-22T19:09:30.712Z"}

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