Canva SCIM API

Overview Authentication Users, Groups, and Teams

SCIM User API reference

Create a user Get a user List users Update all information for a user Update individual attributes for a user Delete a user

SCIM Group API reference

Create a group Get a group List groups Update all information for a group Update individual attributes for a group Delete a group

Create a group with SCIM

Creates a user group in a Canva team.

The displayName of the group can't already be in use by an existing group within the same Canva Team.

HTTP method and URL path

POST https://www.canva.com/_scim/v2/Groups

Header parameters

#Authorizationstring

Required

Provides credentials to authenticate the request, in the form of a Bearer token.

For example: Authorization: Bearer {token}

#Content-Typestring

Required

Indicates the media type of the information sent in the request. This must be set to application/scim+json.

For example: Content-Type: application/scim+json

Body parameters

#schemasstring[]

Required

The value for this can only be urn:ietf:params:scim:schemas:core:2.0:Group.

#displayNamestring

Required

The name of the group, suitable for display to end-users.

Example request

Examples for using the /_scim/v2/Groups endpoint:

curl --request POST 'https://www.canva.com/_scim/v2/Groups' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/scim+json' \
--data '{
  "schemas": "urn:ietf:params:scim:schemas:core:2.0:Group",
  "displayName": "White rabbits"
}'

const fetch = require("node-fetch");

fetch("https://www.canva.com/_scim/v2/Groups", {
  method: "POST",
  headers: {
    "Authorization": "Bearer {token}",
    "Content-Type": "application/scim+json",
  },
  body: JSON.stringify({
    "schemas": "urn:ietf:params:scim:schemas:core:2.0:Group",
    "displayName": "White rabbits"
  }),
})
  .then(async (response) => {
    const data = await response.json();
    console.log(data);
  })
  .catch(err => console.error(err));

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"))
            .header("Authorization", "Bearer {token}")
            .header("Content-Type", "application/scim+json")
            .method("POST", HttpRequest.BodyPublishers.ofString("{\"schemas\": \"urn:ietf:params:scim:schemas:core:2.0:Group\", \"displayName\": \"White rabbits\"}"))
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient().send(
            request,
            HttpResponse.BodyHandlers.ofString()
        );
        System.out.println(response.body());
    }
}

java

using System.Net.Http;

var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Post,
  RequestUri = new Uri("https://www.canva.com/_scim/v2/Groups"),
  Headers =
  {
    { "Authorization", "Bearer {token}" },
  },
  Content = new StringContent(
    "{\"schemas\": \"urn:ietf:params:scim:schemas:core:2.0:Group\", \"displayName\": \"White rabbits\"}",
    Encoding.UTF8,
    "application/scim+json"
  ),
};

using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
};

csharp

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	payload := strings.NewReader(`{
	  "schemas": "urn:ietf:params:scim:schemas:core:2.0:Group",
	  "displayName": "White rabbits"
	}`)

	url := "https://www.canva.com/_scim/v2/Groups"
	req, _ := http.NewRequest("POST", url, payload)
	req.Header.Add("Authorization", "Bearer {token}")
	req.Header.Add("Content-Type", "application/scim+json")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}

$curl = curl_init();
curl_setopt_array($curl, array(
  CURLOPT_URL => "https://www.canva.com/_scim/v2/Groups",
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer {token}',
    'Content-Type: application/scim+json',
  ),
  CURLOPT_POSTFIELDS => json_encode([
    "schemas" => "urn:ietf:params:scim:schemas:core:2.0:Group",
    "displayName" => "White rabbits"
  ])
));

$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')
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request['Authorization'] = 'Bearer {token}'
request['Content-Type'] = 'application/scim+json'
request.body = <<REQUEST_BODY
{
  "schemas": "urn:ietf:params:scim:schemas:core:2.0:Group",
  "displayName": "White rabbits"
}
REQUEST_BODY

response = http.request(request)
puts response.read_body

ruby

Success response

If successful, the endpoint returns a 201 response with a JSON body with the following parameters:

#schemasstring[]

The value for this can only be urn:ietf:params:scim:schemas:core:2.0:Group.

#idstring

The Canva-generated SCIM ID for the group.

#metaobject

Meta properties for the group.

Properties of meta

#resourceTypestring

The SCIM resource type of the object. The value for this can only be Group.

#createdstring

The timestamp when the object was created.

#displayNamestring

The name of the group, suitable for display to end-users.

#membersobject[]

Example response

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Group"
  ],
  "id": "UAFgrpb1abC",
  "meta": {
    "resourceType": "Group",
    "created": "2023-09-18T06:08:35Z"
  },
  "displayName": "White rabbits",
  "members": []
}

json

Error responses

409 Conflict

#schemasstring[]

The value for this can only be urn:ietf:params:scim:api:messages:2.0:Error.

#detailstring

The value for this can only be Group with name {group_name} already exists..

#statusstring

The HTTP status code of the error.

Example error response

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "detail": "Group with name White rabbits already exists.",
  "status": "409"
}

json