Add System Account to a Team
Adds a system account to a team. Returns a 409 if the system account is already a member of the team.
Path Parameters
ID of the team.
Body
application/json
Body
The request schema for adding a system account to a team.
ID of the system account.
Response
Response
Created
Authentication
Path Parameters
Body
Remove System Account From Team
Removes a system account from a team. Returns 404 if the team or system account were not found.
Path Parameters
ID of the team.
ID of the system account.
Response
Response
No Content
Authentication
Path Parameters
List Teams for a System Account
Returns a paginated list of a teams that the system account belongs to.
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 teams returned in the response.
Show Child Parameters
Path Parameters
ID of the system account.
Response
application/json
Response
A paginated list response for a collection of users.
Team Collection Response
returns the pagination information
Show Child Parameters
The team object contains information about a group of users.
Example:{"id":"7f9fd312-a987-4628-b4c5-bb4f4fddd5f7","name":"IDM - Developers","description":"The developers for the IDM API.","system_team":false,"labels":{"env":"test"},"created_at":"1992-02-07T17:46:57.52Z","updated_at":"2022-08-31T17:00:00.52Z"}
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Me
Get My User Account
Returns the user account for the user identified in the token of the request.
Response
application/json
Response
A get action response of a single user.
User
The user object contains information about an individual user who can use the Konnect application and API.
The User ID.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The email registered to the user.
<= 250 characters
Example:user@email.com
The User’s full name.
Match pattern:^[\w \W]+$
<= 250 characters
Example:Jane Doe
The User’s preferred name.
<= 250 characters
Example:Jane
Returns True if a user has verified their email address.
Default:true
The Konnect region closest to the user’s IP address. This property might only be set for users on signup through Konnect’s build-in native authentication.
Example:us
The time stamp for the date the account was registered.
Example:2022-02-07T17:46:57.52Z
A Unix timestamp representation of the most recent change to the User account.
Example:2022-10-08T17:00:00.52Z