Get a Team
Returns information about a team from a given team ID.
Path Parameters
The team ID
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Response
application/json
Response
A response including a single team.
Team
The team object contains information about a group of users.
The team ID.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The name of the team.
Match pattern:^[\w \W]+$
<= 250 characters
Example:IDM - Developers
The team description in Konnect.
<= 250 characters
Example:The developers for the IDM API.
Returns True if a user belongs to a system_team. System teams are teams that can manage Konnect objects, like “Organization Admin”, or “Service”
Default:false
A Unix timestamp representation of team creation.
Example:1992-02-07T17:46:57.52Z
A Unix timestamp representation of the most recent change to the team object in Konnect.
Example:2022-02-07T17:00:00.52Z
Authentication
Path Parameters
Update Team
Updates an individual team.
Path Parameters
The team ID
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Body
application/json
Body
The request schema for the update team request.
The name of the team.
Match pattern:^[\w \W]+$
Example:IDM - Developers
The description of the team.
<= 250 characters
Example:The Identity Management (IDM) API team.
Response
application/json
Response
A response including a single team.
Team
The team object contains information about a group of users.
The team ID.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The name of the team.
Match pattern:^[\w \W]+$
<= 250 characters
Example:IDM - Developers
The team description in Konnect.
<= 250 characters
Example:The developers for the IDM API.
Returns True if a user belongs to a system_team. System teams are teams that can manage Konnect objects, like “Organization Admin”, or “Service”
Default:false
A Unix timestamp representation of team creation.
Example:1992-02-07T17:46:57.52Z
A Unix timestamp representation of the most recent change to the team object in Konnect.
Example:2022-02-07T17:00:00.52Z
Authentication
Path Parameters
Body
Delete Team
Deletes an individual team. Returns 404 if the team is not found.
Path Parameters
The team ID
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Response
Response
No Content
Authentication
Path Parameters
Users
List Users
Returns a paginated list of user objects.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Filter users returned in the response.
Show Child Parameters
Response
application/json
Response
A paginated list response for a collection of users.
returns the pagination information
Show Child Parameters
The user object contains information about an individual user who can use the Konnect application and API.
Example:{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","email":"user@email.com","full_name":"Test User","preferred_name":"test","active":true,"inferred_region":"us","created_at":"2022-02-07T17:46:57.52Z","updated_at":"2022-10-08T17:00:00.52Z"}