List Developer Teams

Lists the teams to which a developer belongs. Each team a developer is a member of grants them various roles that provide permissions to perform actions on certain resources.

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

developerIdstring(uuid)required

ID of the developer.

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

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","can_own_applications":false}

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

Portal Team Roles

APIs related to Konnect Developer Portal developer team roles.

List Team Roles

Lists the roles belonging to a developer team. Each role provides permissions to perform actions on a specified resource or collection.

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

Path Parameters

portalIdstring(uuid)required

ID of the portal.

teamIdstring(uuid)required

ID of the team.

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

Response

application/json

A paginated collection of assigned roles.

AssignedPortalRoleCollectionResponse

A paginated list of roles assigned to a team.

metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

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

Example:{"id":"1a3c2169-27f8-4594-926b-41df3432d5dc","role_name":"API Viewer","entity_id":"18ee2573-dec0-4b83-be99-fa7700bcdc61","entity_type_name":"Services","entity_region":"us"}

Show Child Parameters
get/portals/{portalId}/teams/{teamId}/assigned-roles
 
application/json

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}