Whether the email is the primary address. Only one email address for a user can be the primary one.
Get a user
Gets information for a user.
HTTP method and URL path
https://www.canva.com /_scim /v2 /Users/{canva_scim_id}
Header parameters
Path parameters
The Canva-generated SCIM ID for the user.
Example request
Examples for using the /_scim/v2/Users/{canva_scim_id}
endpoint:
curl --request GET 'https://www.canva.com/_scim/v2/Users/{canva_scim_id}' \--header 'Authorization: Bearer {token}'
Success response
If successful, the endpoint returns a 200
response with a JSON body with the following parameters:
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: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
404 Not found
The value for this can only be urn:ietf:params:scim:api:messages:2.0:Error
.
The value for this can only be No user found for id {canva_scim_id}
.
The HTTP status code of the error.
Example error response
{"schemas": ["urn:ietf:params:scim:api:messages:2.0:Error"],"detail": "No user found for id {canva_scim_id}","status": "404"}