Authentication Scopes

A list of supported auth scopes for token generation.

Scope

Description

Supported API Services

community.read

This scope provides you the ability to read a community's data.

community.write

This scope provides you the ability to edit community's data.

  • Add recipes to a community.

  • Remove a recipe from a community.

cookbook:read

This scope provides you the ability to read recipes, recipe collections, and custom labels data.

cookbook:write

This scope provides you the ability to edit data of recipes and recipe collections.

food_list:read

This scope provides you the ability to read food list data.

Get a food list.

food_list:write

This scope provides you the ability to edit food list data.

  • Add an item to a food list.

  • Update an item in a food list.

  • Delete an item from a food list.

shopping_list:read

This scope provides you the ability to read shopping list data.

shopping_list:write

This scope provides you the ability to edit shopping list data.

  • Create a shopping list.

  • Move items from one shopping list to another.

  • Delete a shopping list.

  • Edit a shopping list.

  • Clear items from a shopping list.

  • Add items to a shopping list.

  • Delete an item from a shopping list.

  • Update an item in a shopping list.

meal_plan:read

This scope provides you the ability to read meal plan data.

meal_plan:write

This scope provides you the ability to edit meal plan data.

storeitem:read

This scope provides you the ability to read a particular store items' data.

Get store items.

user.profile:read

This scope provides you the ability to read a user profile's data.

user.profile:write

This scope provides you the ability to edit a user profile's data.

Last updated