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

List groups

Gets a paginated list of all user groups in a Canva team.

You can use the startIndex and count parameters to control the pagination of the response.

You can also provide a filter parameter to narrow down the groups returned to only include those matching the filter.

HTTP method and URL path

GET 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}

Query parameters

#startIndexinteger

Optional

Used to paginate the response: the index of the first result to return.

#countinteger

Optional

Used to paginate the response: the number of results to return. Must be between 1 and 10.

#filterstring

Optional

A filter to narrow down the results returned, using the equals (eq) query parameter. The following filters are supported:

Return the group matching the SCIM displayName value: displayName eq "{display_name}".

For example: GET /_scim/v2/Groups?filter=displayName%20eq%20"White rabbits"

Example request

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

curl --request GET 'https://www.canva.com/_scim/v2/Groups' \
--header 'Authorization: Bearer {token}'

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}")
            .method("GET", HttpRequest.BodyPublishers.noBody())
            .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.Get,
  RequestUri = new Uri("https://www.canva.com/_scim/v2/Groups"),
  Headers =
  {
    { "Authorization", "Bearer {token}" },
  },
};

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

csharp

Success response

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

#schemasstring[]

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

#totalResultsinteger

The total number of results matching the query.

#startIndexinteger

The index of the first result.

#itemsPerPageinteger

The number of results returned in the current page.

#resourcesScimGroupResponse[]

An array of the groups returned in the current page of results.

Properties of resources

#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:api:messages:2.0:ListResponse"
  ],
  "totalResults": 1,
  "startIndex": 1,
  "itemsPerPage": 10,
  "resources": [
    {
      "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

403 Forbidden

#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 Unsupported filter field.

#statusstring

The HTTP status code of the error.

Example error response

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "detail": "Unsupported filter field",
  "status": "403"
}

json