Scopes

The scope parameter specifies the types of access that your integration needs for a user's account. The list of possible scopes used in the Connect APIs are shown below:

<table> <thead> <tr> <th>Scope</th> <th>Description</th> </tr> </thead>

<tbody> <tr> <td>asset:read</td> <td>View the metadata for the user's assets, such as uploaded images.</td> </tr>

&lt;tr&gt;
  &lt;td&gt;`asset:write`&lt;/td&gt;
  &lt;td&gt;Upload, update, or delete assets on the user's behalf.&lt;/td&gt;
&lt;/tr&gt;

&lt;tr&gt;
  &lt;td&gt;`brandtemplate:content:read`&lt;/td&gt;
  &lt;td&gt;Read the content of the brand templates associated with the user's brand.&lt;/td&gt;
&lt;/tr&gt;

&lt;tr&gt;
  &lt;td&gt;`brandtemplate:meta:read`&lt;/td&gt;
  &lt;td&gt;View the metadata of the brand templates associated with the user's brand.&lt;/td&gt;
&lt;/tr&gt;

&lt;tr&gt;
  &lt;td&gt;`collaboration:event`&lt;/td&gt;
  &lt;td&gt;Receive webhook notifications about events relevant to the user.&lt;/td&gt;
&lt;/tr&gt;

&lt;tr&gt;
  &lt;td&gt;`comment:read`&lt;/td&gt;
  &lt;td&gt;View the comments on the user's designs, and the associated metadata.&lt;/td&gt;
&lt;/tr&gt;

&lt;tr&gt;
  &lt;td&gt;`comment:write`&lt;/td&gt;
  &lt;td&gt;Create comments and replies on the user's designs.&lt;/td&gt;
&lt;/tr&gt;

&lt;tr&gt;
  &lt;td&gt;`design:content:read`&lt;/td&gt;
  &lt;td&gt;View the contents of the user's designs.&lt;/td&gt;
&lt;/tr&gt;

&lt;tr&gt;
  &lt;td&gt;`design:content:write`&lt;/td&gt;
  &lt;td&gt;Create designs on the user's behalf.&lt;/td&gt;
&lt;/tr&gt;

&lt;tr&gt;
  &lt;td&gt;`design:meta:read`&lt;/td&gt;
  &lt;td&gt;View the metadata of the user's designs.&lt;/td&gt;
&lt;/tr&gt;

&lt;tr&gt;
  &lt;td&gt;`email`&lt;/td&gt;
  &lt;td&gt;Read user email address through OIDC.&lt;/td&gt;
&lt;/tr&gt;

&lt;tr&gt;
  &lt;td&gt;`folder:permission:write`&lt;/td&gt;
  &lt;td&gt;Set, update, or remove permissions assigned to the user's folders.&lt;/td&gt;
&lt;/tr&gt;

&lt;tr&gt;
  &lt;td&gt;`folder:read`&lt;/td&gt;
  &lt;td&gt;View the metadata and contents of the user's folders, including their **Projects**
  folder.&lt;/td&gt;
&lt;/tr&gt;

&lt;tr&gt;
  &lt;td&gt;`folder:write`&lt;/td&gt;
  &lt;td&gt;Add, move, or remove the user's folders. It also lets you edit folder metadata,
  such as the folder's name.&lt;/td&gt;
&lt;/tr&gt;

&lt;tr&gt;
  &lt;td&gt;`openid`&lt;/td&gt;
  &lt;td&gt;Read user information through Open ID Connect (OIDC).&lt;/td&gt;
&lt;/tr&gt;

&lt;tr&gt;
  &lt;td&gt;`profile`&lt;/td&gt;
  &lt;td&gt;Read user profile information through OIDC.&lt;/td&gt;
&lt;/tr&gt;

&lt;tr&gt;
  &lt;td&gt;`profile:read`&lt;/td&gt;
  &lt;td&gt;Read a user's profile and account information.&lt;/td&gt;
&lt;/tr&gt;

</tbody> </table>

For example, if you just require your integration to read design metadata, you can use the design:meta:read scope. If you require your integration to read designs, as well as write to any folder, you can use both the design:meta:read and the folder:write scopes.

<Note> When enabling and using scopes, you must be explicit.

For example, the asset:write scope doesn't grant asset:read permissions. To get both read and write permissions for assets, you must enable both scopes in your integration settings, and request both scopes during the authorization process. </Note>

Scopes ​

Scopes