Create or update a team
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>"
],
"displayName": "<string>",
"description": "<string>",
"managers": [
"<string>"
],
"tags": {},
"identity_provider_mapping": [
{
"identity_provider": "<string>",
"value": "<string>"
}
]
},
"dryRun": false
}
'import requests
url = "https://{controlPlaneURL}/api/svc/v1/teams"
payload = {
"manifest": {
"type": "team",
"name": "<string>",
"members": ["<string>"],
"displayName": "<string>",
"description": "<string>",
"managers": ["<string>"],
"tags": {},
"identity_provider_mapping": [
{
"identity_provider": "<string>",
"value": "<string>"
}
]
},
"dryRun": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
manifest: {
type: 'team',
name: '<string>',
members: ['<string>'],
displayName: '<string>',
description: '<string>',
managers: ['<string>'],
tags: {},
identity_provider_mapping: [{identity_provider: '<string>', value: '<string>'}]
},
dryRun: false
})
};
fetch('https://{controlPlaneURL}/api/svc/v1/teams', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{controlPlaneURL}/api/svc/v1/teams",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'manifest' => [
'type' => 'team',
'name' => '<string>',
'members' => [
'<string>'
],
'displayName' => '<string>',
'description' => '<string>',
'managers' => [
'<string>'
],
'tags' => [
],
'identity_provider_mapping' => [
[
'identity_provider' => '<string>',
'value' => '<string>'
]
]
],
'dryRun' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{controlPlaneURL}/api/svc/v1/teams"
payload := strings.NewReader("{\n \"manifest\": {\n \"type\": \"team\",\n \"name\": \"<string>\",\n \"members\": [\n \"<string>\"\n ],\n \"displayName\": \"<string>\",\n \"description\": \"<string>\",\n \"managers\": [\n \"<string>\"\n ],\n \"tags\": {},\n \"identity_provider_mapping\": [\n {\n \"identity_provider\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"dryRun\": false\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://{controlPlaneURL}/api/svc/v1/teams")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"manifest\": {\n \"type\": \"team\",\n \"name\": \"<string>\",\n \"members\": [\n \"<string>\"\n ],\n \"displayName\": \"<string>\",\n \"description\": \"<string>\",\n \"managers\": [\n \"<string>\"\n ],\n \"tags\": {},\n \"identity_provider_mapping\": [\n {\n \"identity_provider\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"dryRun\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{controlPlaneURL}/api/svc/v1/teams")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"manifest\": {\n \"type\": \"team\",\n \"name\": \"<string>\",\n \"members\": [\n \"<string>\"\n ],\n \"displayName\": \"<string>\",\n \"description\": \"<string>\",\n \"managers\": [\n \"<string>\"\n ],\n \"tags\": {},\n \"identity_provider_mapping\": [\n {\n \"identity_provider\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"dryRun\": false\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "jqfwg345gi25n5ju2yz5iz6m",
"description": "<string>",
"tenantName": "<string>",
"accountId": "<string>",
"createdBySubject": {
"subjectId": "<string>",
"subjectSlug": "<string>",
"subjectDisplayName": "<string>",
"subjectPatName": "<string>",
"subjectControllerName": "<string>",
"subjectExternalIdentitySlug": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"manifest": {
"type": "team",
"name": "<string>",
"members": [
"<string>"
],
"displayName": "<string>",
"description": "<string>",
"managers": [
"<string>"
],
"ownedBy": {
"account": "<string>"
},
"tags": {},
"identity_provider_mapping": [
{
"identity_provider": "<string>",
"value": "<string>"
}
]
},
"isEditable": true,
"members": [
"<string>"
],
"metadata": {
"createdByScim": true,
"scimExternalId": "<string>"
},
"roles": [
"<string>"
]
}
}{
"statusCode": 123,
"message": "<string>",
"code": 123,
"details": [
{}
]
}{
"statusCode": 123,
"message": "<string>",
"code": 123,
"details": [
{}
]
}Teams
Create or update a team
Create a new team or update an existing one using the provided TeamManifest. Matching is by name — if the name matches an existing team it is updated, otherwise a new one is created.
PUT
/
api
/
svc
/
v1
/
teams
Create or update a team
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>"
],
"displayName": "<string>",
"description": "<string>",
"managers": [
"<string>"
],
"tags": {},
"identity_provider_mapping": [
{
"identity_provider": "<string>",
"value": "<string>"
}
]
},
"dryRun": false
}
'import requests
url = "https://{controlPlaneURL}/api/svc/v1/teams"
payload = {
"manifest": {
"type": "team",
"name": "<string>",
"members": ["<string>"],
"displayName": "<string>",
"description": "<string>",
"managers": ["<string>"],
"tags": {},
"identity_provider_mapping": [
{
"identity_provider": "<string>",
"value": "<string>"
}
]
},
"dryRun": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
manifest: {
type: 'team',
name: '<string>',
members: ['<string>'],
displayName: '<string>',
description: '<string>',
managers: ['<string>'],
tags: {},
identity_provider_mapping: [{identity_provider: '<string>', value: '<string>'}]
},
dryRun: false
})
};
fetch('https://{controlPlaneURL}/api/svc/v1/teams', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{controlPlaneURL}/api/svc/v1/teams",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'manifest' => [
'type' => 'team',
'name' => '<string>',
'members' => [
'<string>'
],
'displayName' => '<string>',
'description' => '<string>',
'managers' => [
'<string>'
],
'tags' => [
],
'identity_provider_mapping' => [
[
'identity_provider' => '<string>',
'value' => '<string>'
]
]
],
'dryRun' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{controlPlaneURL}/api/svc/v1/teams"
payload := strings.NewReader("{\n \"manifest\": {\n \"type\": \"team\",\n \"name\": \"<string>\",\n \"members\": [\n \"<string>\"\n ],\n \"displayName\": \"<string>\",\n \"description\": \"<string>\",\n \"managers\": [\n \"<string>\"\n ],\n \"tags\": {},\n \"identity_provider_mapping\": [\n {\n \"identity_provider\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"dryRun\": false\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://{controlPlaneURL}/api/svc/v1/teams")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"manifest\": {\n \"type\": \"team\",\n \"name\": \"<string>\",\n \"members\": [\n \"<string>\"\n ],\n \"displayName\": \"<string>\",\n \"description\": \"<string>\",\n \"managers\": [\n \"<string>\"\n ],\n \"tags\": {},\n \"identity_provider_mapping\": [\n {\n \"identity_provider\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"dryRun\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{controlPlaneURL}/api/svc/v1/teams")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"manifest\": {\n \"type\": \"team\",\n \"name\": \"<string>\",\n \"members\": [\n \"<string>\"\n ],\n \"displayName\": \"<string>\",\n \"description\": \"<string>\",\n \"managers\": [\n \"<string>\"\n ],\n \"tags\": {},\n \"identity_provider_mapping\": [\n {\n \"identity_provider\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"dryRun\": false\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "jqfwg345gi25n5ju2yz5iz6m",
"description": "<string>",
"tenantName": "<string>",
"accountId": "<string>",
"createdBySubject": {
"subjectId": "<string>",
"subjectSlug": "<string>",
"subjectDisplayName": "<string>",
"subjectPatName": "<string>",
"subjectControllerName": "<string>",
"subjectExternalIdentitySlug": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"manifest": {
"type": "team",
"name": "<string>",
"members": [
"<string>"
],
"displayName": "<string>",
"description": "<string>",
"managers": [
"<string>"
],
"ownedBy": {
"account": "<string>"
},
"tags": {},
"identity_provider_mapping": [
{
"identity_provider": "<string>",
"value": "<string>"
}
]
},
"isEditable": true,
"members": [
"<string>"
],
"metadata": {
"createdByScim": true,
"scimExternalId": "<string>"
},
"roles": [
"<string>"
]
}
}{
"statusCode": 123,
"message": "<string>",
"code": 123,
"details": [
{}
]
}{
"statusCode": 123,
"message": "<string>",
"code": 123,
"details": [
{}
]
}Authorizations
jwtjwt
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Response
The created or updated team.
The requested team.
Show child attributes
Show child attributes
Was this page helpful?
⌘I