Canva SCIM API
SCIM User API reference
Delete a group
Deletes a user group. Users in the group are not removed.
HTTP method and URL path
DELETE
https://www.canva.com /_scim /v2 /Groups/{canva_scim_id}
Header parameters
Path parameters
canva_scim_id
string
REQUIRED
The Canva-generated SCIM ID for the group.
Example request
Examples for using the /_scim/v2/Groups/{canva_scim_id}
endpoint:
curl --request DELETE 'https://www.canva.com/_scim/v2/Groups/{canva_scim_id}' \--header 'Authorization: Bearer {token}'
SH
const fetch = require("node-fetch");fetch("https://www.canva.com/_scim/v2/Groups/{canva_scim_id}", {method: "DELETE",headers: {"Authorization": "Bearer {token}",},}).then(async (response) => {const data = await response.json();console.log(data);}).catch(err => console.error(err));
JS
import java.io.IOException;import java.net.URI;import java.net.http.*;public class ApiExample {public static void main(String[] args) throws IOException, InterruptedException {HttpRequest request = HttpRequest.newBuilder().uri(URI.create("https://www.canva.com/_scim/v2/Groups/{canva_scim_id}")).header("Authorization", "Bearer {token}").method("DELETE", HttpRequest.BodyPublishers.noBody()).build();HttpResponse<String> response = HttpClient.newHttpClient().send(request,HttpResponse.BodyHandlers.ofString());System.out.println(response.body());}}
JAVA
import requestsheaders = {"Authorization": "Bearer {token}"}response = requests.delete("https://www.canva.com/_scim/v2/Groups/{canva_scim_id}",headers=headers)print(response.json())
PY
using System.Net.Http;var client = new HttpClient();var request = new HttpRequestMessage{Method = HttpMethod.Delete,RequestUri = new Uri("https://www.canva.com/_scim/v2/Groups/{canva_scim_id}"),Headers ={{ "Authorization", "Bearer {token}" },},};using (var response = await client.SendAsync(request)){response.EnsureSuccessStatusCode();var body = await response.Content.ReadAsStringAsync();Console.WriteLine(body);};
CSHARP
package mainimport ("fmt""io""net/http")func main() {url := "https://www.canva.com/_scim/v2/Groups/{canva_scim_id}"req, _ := http.NewRequest("DELETE", url, nil)req.Header.Add("Authorization", "Bearer {token}")res, _ := http.DefaultClient.Do(req)defer res.Body.Close()body, _ := io.ReadAll(res.Body)fmt.Println(string(body))}
GO
$curl = curl_init();curl_setopt_array($curl, array(CURLOPT_URL => "https://www.canva.com/_scim/v2/Groups/{canva_scim_id}",CURLOPT_CUSTOMREQUEST => "DELETE",CURLOPT_RETURNTRANSFER => true,CURLOPT_HTTPHEADER => array('Authorization: Bearer {token}',),));$response = curl_exec($curl);$err = curl_error($curl);curl_close($curl);if (empty($err)) {echo $response;} else {echo "Error: " . $err;}
PHP
require 'net/http'require 'uri'url = URI('https://www.canva.com/_scim/v2/Groups/{canva_scim_id}')http = Net::HTTP.new(url.host, url.port)http.use_ssl = truerequest = Net::HTTP::Delete.new(url)request['Authorization'] = 'Bearer {token}'response = http.request(request)puts response.read_body
RUBY
Success response
If successful, the endpoint returns the status code 204 No content
without a response body.
Error responses
404 Not found
schemas
string[]
The value for this can only be urn:ietf:params:scim:api:messages:2.0:Error
.
detail
string
The value for this can only be group {canva_scim_id} not found
.
status
string
The HTTP status code of the error.
Example error response
{"schemas": ["urn:ietf:params:scim:api:messages:2.0:Error"],"detail": "group {canva_scim_id} not found","status": "404"}
JSON