TrueFoundry SDK
TrueFoundry ML Client
Apply API Guides
Applications
Artifacts
- GETGet Artifact
- DELDelete Artifact
- GETList Artifacts
- PUTApply Artifact Version Tags
- GETGet Artifact Version
- DELDelete Artifact Version
- GETList Artifact Versions
- PUTApply Artifact Version
- POSTDelete Artifact Version
- POSTGet Signed Urls For Artifact Version
- POSTCreate Multi Part Upload
- POSTStage Artifact Version
- POSTList Files For Artifact Version
- POSTMark Stage Failure
Audit Logs
Clusters
Model Deployments
Models
Personal Access Tokens
Prompts
Provider Integrations
Secret Groups
Users
Virtual Accounts
curl --request PUT \
--url https://{controlPlaneURL}/api/svc/v1/teams \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"manifest": {
"type": "team",
"name": "<string>",
"members": [
"<string>"
],
"managers": [
"<string>"
],
"ownedBy": {
"account": "<string>"
}
},
"dryRun": true
}
'{
"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>"
]
}
}Create or Update a Team
Creates a new team or updates an existing team. It ensures that the team name is unique, valid, and that the team has at least one member. The members of the team are added or updated based on the provided emails.
curl --request PUT \
--url https://{controlPlaneURL}/api/svc/v1/teams \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"manifest": {
"type": "team",
"name": "<string>",
"members": [
"<string>"
],
"managers": [
"<string>"
],
"ownedBy": {
"account": "<string>"
}
},
"dryRun": true
}
'{
"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>"
]
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
Team manifest
- TeamManifest
- SSOTeamManifest
Show child attributes
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
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}
Dry run
Response
Returns the created or updated team.
Teams
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Subject ID
Subject type
user, team, serviceaccount, virtualaccount, external-identity Subject slug
Subject display name
- TeamManifest
- SSOTeamManifest
Show child attributes
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
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?