Creating roles and permissions

Creating a new role#

When using SuperTokens, roles and permissions are simple strings that can be assigned to users and verified on your backend and frontend.

When creating new roles you can choose to add 0 or multiple permissions to the role.

important

Roles must be ceated before they can be assigned to users

NodeJS
GoLang
Python
cURL

import UserRoles from "supertokens-node/recipe/userroles";
async function createRole() {    /**     * You can choose to give multiple or no permissions when creating a role    * createNewRoleOrAddPermissions("user", []) - No permissions    * createNewRoleOrAddPermissions("user", ["read", "write"]) - Multiple permissions    */    const response = await UserRoles.createNewRoleOrAddPermissions("user", ["read"]);
    if (response.createdNewRole === false) {        // The role already exists    }}

import (    "github.com/supertokens/supertokens-golang/recipe/userroles")
func createRole() {    /**     * You can choose to give multiple or no permissions when creating a role    * createNewRoleOrAddPermissions("user", []string{}) - No permissions    * createNewRoleOrAddPermissions("user", []string{"read", "write"}) - Multiple permissions    */    resp, err := userroles.CreateNewRoleOrAddPermissions("user", []string{        "read",    }, nil)
    if err != nil {        // TODO: Handle error        return    }    if resp.OK.CreatedNewRole == false {        // The role already exists    }}

Asyncio
Syncio

from supertokens_python.recipe.userroles.asyncio import create_new_role_or_add_permissions
async def create_role():    res = await create_new_role_or_add_permissions("user", ["read"])    if not res.created_new_role:        # The role already existed        pass

from supertokens_python.recipe.userroles.syncio import create_new_role_or_add_permissions
def create_role():    res = create_new_role_or_add_permissions("user", ["read"])    if not res.created_new_role:        # The role already existed        pass

curl --location --request PUT '/recipe/role' \--header 'api-key: ' \--header 'Content-Type: application/json' \--data-raw '{  "role": "user",  "permissions": [    "read"  ]}'