curl --request GET \
--url https://{controlPlaneURL}/api/svc/v1/teams/user \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "<string>",
"teamName": "<string>",
"description": "<string>",
"tenantName": "<string>",
"createdBySubject": {
"subjectId": "<string>",
"subjectType": "user",
"subjectSlug": "<string>",
"subjectDisplayName": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"manifest": {
"type": "team",
"name": "<string>",
"members": [
"<string>"
],
"managers": [
"<string>"
],
"ownedBy": {
"account": "<string>"
}
},
"accountId": "<string>",
"members": [
"<string>"
]
}
],
"pagination": {
"total": 100,
"offset": 0,
"limit": 10
}
}Retrieve all teams associated with the authenticated user. If the user is a tenant admin, returns all teams for the tenant. Pagination is available based on query parameters
curl --request GET \
--url https://{controlPlaneURL}/api/svc/v1/teams/user \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "<string>",
"teamName": "<string>",
"description": "<string>",
"tenantName": "<string>",
"createdBySubject": {
"subjectId": "<string>",
"subjectType": "user",
"subjectSlug": "<string>",
"subjectDisplayName": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"manifest": {
"type": "team",
"name": "<string>",
"members": [
"<string>"
],
"managers": [
"<string>"
],
"ownedBy": {
"account": "<string>"
}
},
"accountId": "<string>",
"members": [
"<string>"
]
}
],
"pagination": {
"total": 100,
"offset": 0,
"limit": 10
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Number of items per page
1 <= x <= 100010
Number of items to skip
x >= 00
Filter teams by type
team, sso-team Returns an array of teams associated with the user or tenant And also the response includes paginated data
Teams
Show child attributes
Show child attributes
Subject ID
Subject type
user, team, serviceaccount, virtualaccount, external-identity Subject slug
Subject display name
Show child attributes
+value=team
team +sort=1 +message=Use of only alpha numeric character and "-" is allowed as team name and can be up to 36 characters in length +usage=Name of the Team
+sort=4 +label=Team Members +usage=Enter email of each of the user you want to add in the team. +uiType=UserSelect +uiProps={"optionTypes": ["users"]}
+sort=3 +label=Team Managers +usage=Emails of each of the user who can manage the members of the team. Any tenant admin is by default a team manager. +uiType=UserSelect +uiProps={"optionTypes": ["users"]}
+label=Owner +usage=Names of the owners that own the team
Show child attributes
+label=Account Name +sort=1 +usage=The name of the account that owns the team +placeholder=Search Account +uiType=AccountSelect +uiProps={"maxAllowedAccounts": 1}
Was this page helpful?