Update all information for a group

Replaces an existing group's information.

You must provide all the information for the group, as if you're creating the group for the first time. Any existing information for the group that isn't provided, including group members, is removed.

The members attribute of a group is an array of users, with each user represented as a value attribute that corresponds to the user's Canva SCIM ID.

If you only want to update a some of the group's attributes, you can use the PATCH operation.

PUT https://www.canva.com/_scim/v2/Groups/{canva_scim_id}
#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

#canva_scim_idstring
Required

The Canva-generated SCIM ID for the group.

#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.

#membersobject[]
Required

The members of the group.

Properties of members
#valuestring
Required

The Canva-generated SCIM ID for the user.

Examples for using the /_scim/v2/Groups/{canva_scim_id} endpoint:

curl --request PUT 'https://www.canva.com/_scim/v2/Groups/{canva_scim_id}' \
--header 'Authorization: Bearer {token}' \
--header 'Content-Type: application/scim+json' \
--data '{
"schemas": "urn:ietf:params:scim:schemas:core:2.0:Group",
"displayName": "White rabbits",
"members": [
{
"value": "UAFdxab1abC"
}
]
}'
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: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[]
{
"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
#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 {canva_scim_id} not found.

#statusstring

The HTTP status code of the error.

{
"schemas": [
"urn:ietf:params:scim:api:messages:2.0:Error"
],
"detail": "group {canva_scim_id} not found",
"status": "404"
}
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 Group with name {group_name} already exists..

#statusstring

The HTTP status code of the error.

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