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

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.

can_own_applicationsboolean

Whether the team is allowed to own applications

Default:false

Example:true

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

can_own_applicationsboolean

Whether the team is allowed to own applications.

Example:false

post/portals/{portalId}/teams

Body

{ "name": "IDM - Developers", "description": "The Identity Management (IDM) team.", "can_own_applications": false }
 
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

can_own_applicationsboolean

Whether the team is allowed to own applications.

Example:false

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

Update Team

Updates an individual developer team for a portal.

patch

Path Parameters

teamIdstring(uuid)required

ID of the team.

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

portalIdstring(uuid)required

ID of the portal.

Body

application/json

Update a team in a portal.

PortalUpdateTeamRequest

Properties to update on a team.

namestring

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

Example:IDM - Developers

descriptionstring

<= 250 characters

Example:The Identity Management (IDM) API team.

can_own_applicationsboolean

Whether the team is allowed to own applications.

Example:true

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

can_own_applicationsboolean

Whether the team is allowed to own applications.

Example:false

patch/portals/{portalId}/teams/{teamId}

Body

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

Delete Team

Deletes a developer team from a portal. Deleting a team also deletes its assigned roles. Members of the team are not deleted, but they will lose any access provided through the team.

delete

Path Parameters

teamIdstring(uuid)required

ID of the team.

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

portalIdstring(uuid)required

ID of the portal.

Response

No Content

delete/portals/{portalId}/teams/{teamId}