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>"
]
},
"dryRun": true
}'
{
"data": {
"id": "<string>",
"teamName": "<string>",
"description": "<string>",
"tenantName": "<string>",
"createdBySubject": {
"subjectId": "<string>",
"subjectType": "user",
"subjectSlug": "<string>",
"subjectDisplayName": "<string>"
},
"members": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"manifest": {
"type": "team",
"name": "<string>",
"members": [
"<string>"
]
}
}
}
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>"
]
},
"dryRun": true
}'
{
"data": {
"id": "<string>",
"teamName": "<string>",
"description": "<string>",
"tenantName": "<string>",
"createdBySubject": {
"subjectId": "<string>",
"subjectType": "user",
"subjectSlug": "<string>",
"subjectDisplayName": "<string>"
},
"members": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"manifest": {
"type": "team",
"name": "<string>",
"members": [
"<string>"
]
}
}
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Returns the created or updated team.
The response is of type object
.
Was this page helpful?