Whether the email is the primary address. Only one email address for a user can be the primary one.
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.
HTTP method and URL path
https://www.canva.com /_scim /v2 /Users
Header parameters
Query parameters
Used to paginate the response: the index of the first result to return.
Used to paginate the response: the number of results to return. Must be between 1
and 10
.
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"
Example request
Examples for using the /_scim/v2/Users
endpoint:
curl --request GET 'https://www.canva.com/_scim/v2/Users' \--header 'Authorization: Bearer {token}'
Success response
If successful, the endpoint returns a 200
response with a JSON body with the following parameters:
The value for this can only be urn:ietf:params:scim:api:messages:2.0:ListResponse
.
The total number of results matching the query.
The index of the first result.
The number of results returned in the current page.
An array of the users returned in the current page of results.
Properties of resources
The URIs of the SCIM schemas. The value for this can only be urn:ietf:params:scim:schemas:core:2.0:User
.
The Canva-generated SCIM ID for the user.
A unique identifier for the user.
The name of the user, suitable for display to end-users.
Whether the user account is active. Setting this to false
deprovisions the user in Canva.
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
.
A string that is an identifier for the resource as defined by the provisioning client.
The user's default location, for example en_AU
.
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: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,"type": "work"}],"active": true,"locale": "en_US","role": "Member"}]}
Error responses
400 Bad request
The value for this can only be urn:ietf:params:scim:api:messages:2.0:Error
.
The value for this can only be No SSO configurations found, please check the settings page
.
The HTTP status code of the error.
Example error response
{"schemas": ["urn:ietf:params:scim:api:messages:2.0:Error"],"detail": "No SSO configurations found, please check the settings page","status": "400"}
403 Forbidden
The value for this can only be urn:ietf:params:scim:api:messages:2.0:Error
.
The value for this can only be Unsupported filter field
.
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"}