List users

Gets a paginated list of all users in a Canva team, including inactive users.

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 users returned to only include those matching the filter.

GET https://www.canva.com/_scim/v2/Users
#Authorizationstring
Required

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

For example: Authorization: Bearer {token}

#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 user matching the SCIM userName value: userName eq "{saml_name_id}".

    For example: GET /_scim/v2/Users?filter=userName%20eq%20"aliddell"

  • Return the user matching the SCIM externalId value: externalId eq "{idp_provided_external_id}".

    For example: GET /_scim/v2/Users?filter=externalId%20eq%20"abcdefgh12345678"

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

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

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.

#resourcesScimUserResponse[]

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

Properties of resources
#schemasstring[]

The URIs of the SCIM schemas. The value for this can only be urn:ietf:params:scim:schemas:core:2.0:User.

#idstring

The Canva-generated SCIM ID for the user.

#metaobject

Meta properties for the user.

Properties of meta
#resourceTypestring

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

#createdstring

The timestamp when the object was created.

#userNamestring

A unique identifier for the user.

#displayNamestring

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

#emailsobject[]

The email address for the user.

Properties of emails
#primaryboolean

Whether the email is the primary address. Only one email address for a user can be the primary one.

#valuestring

The email address.

#typestring

The type of email address for the user. The Canva SCIM API only supports work as the type of the email address.

#activeboolean

Whether the user account is active. Setting this to false deprovisions the user in Canva.

#rolestring

The role of the user. This can be one of the following:

  • Member
  • Teacher
  • Staff
  • Admin
  • Template-designer
  • Aide
  • Administrator
  • School administrator
  • School
  • Tenant
  • Faculty

If an invalid value is provided, the role defaults to Member.

#externalIdstring
Optional

A string that is an identifier for the resource as defined by the provisioning client.

#namename
Optional

The components of the user's name.

Properties of name
#givenNamestring
Optional

The first or 'given' name for the user.

#familyNamestring
Optional

The last or 'family' name for the user.

#localestring
Optional

The user's default location, for example en_AU.

{
"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:User"
],
"id": "UAFdxab1abC",
"externalId": "abcd1234",
"meta": {
"resourceType": "User",
"created": "2023-09-18T06:08:35Z"
},
"userName": "aliddell",
"displayName": "Alice Liddell",
"name": {
"givenName": "Alice",
"familyName": "Liddell"
},
"emails": [
{
"primary": true,
"value": "[email protected]",
"type": "work"
}
],
"active": true,
"locale": "en_US",
"role": "Member"
}
]
}
json
#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 No SSO configurations found, please check the settings page.

#statusstring

The HTTP status code of the error.

{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:Error"
],
"detail": "No SSO configurations found, please check the settings page",
"status": "400"
}
json
#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.

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