Skip to content
Quickstart
Project Setup

Project Setup

Set up your Roled project through the Console in minutes. This guide walks you through creating resources, permissions, roles, and users—the foundation for both authentication approaches.

What you’ll build

StepOutcome
1Project named Business App
2Custom resources: products, orders
3Custom permissions: create, read, update, delete for each resource
4Two roles: Store Manager, Inventory Staff
5Two users: Alice Smith, Bob Johnson

1. Sign up and access the Console

  1. Create your account at Roled Console.

  2. Optionally verify your email.

  3. You’ll see the empty project list—ready to create your first project.

    Empty project list in Roled Console

2. Create your project

A project is an isolated workspace containing everything for one application: users, roles, resources, permissions, and OAuth clients.

  1. From the project list, click Add Project.

  2. Fill in the project details:

    FieldValue
    NameBusiness App
    DescriptionApp for managing business operations

  3. Click Create to provision your project.

    Create a new project in Roled Console

  4. Your project is created with these built-in components:

    • Resources: users, roles, resources, permissions, clients
    • Permissions: create, read, update, delete on each built-in resource
    • Default OAuth client ready for authentication flows
Redirect URIs are required for Fully Managed Users but optional for Decoupled Users. You can configure them now or later in the project details page.

3. Define resources and permissions

Resources represent entities you want to protect (like products, orders, or documents). Permissions define actions users can perform, using the format resource:action (e.g., products:create).

Create two custom resources for Business App:

  • Products

    PermissionCodeDescription
    CreatecreateCreate a new product
    ReadreadList and view products
    UpdateupdateEdit an existing product
    DeletedeleteRemove a product

  • Orders

    PermissionCodeDescription
    ReadreadList and view orders
    UpdateupdateUpdate order status

Add resources to your project:

  1. On the project details page, navigate to the Resources tab.

  2. Click Add Resource for each resource above.

  3. For each resource, add its permissions by clicking Add Permission.

    Create a new resource in Roled Console

  4. Verify both resources and their permissions appear in the list.

    Resource list in Roled Console

4. Create roles

Roles bundle permissions together and get assigned to users. Create two roles for Business App:

RoleCodeDescriptionPermissions
Store Managerstore-managerManage store operations including products, orders, and staffproducts:create, products:read, products:update, products:delete, orders:read, orders:update, users:read
Inventory Staffinventory-staffManage product inventory and stock levelsproducts:read, products:update, orders:read

  1. Navigate to the Roles tab.

  2. Click Add Role for each role above.

  3. Select the appropriate resources and permissions for the roles.

    Create a new role in Roled Console

  4. Verify both roles appear in the list.

    Role list in Roled Console

Role permission changes apply immediately to all users assigned that role. No need to update users individually.

5. Add users

Users represent human identities in your project. Each user is assigned exactly one role that determines their permissions.

Add two users for testing:

NameEmailRole
Alice Smithalice.smith@example.comStore Manager
Bob Johnsonbob.johnson@example.comInventory Staff

  1. Navigate to the Users tab.

  2. Click Add User for each user.

  3. Fill in their details and set an initial password.

    Create a new user in Roled Console

  4. Verify both users appear in the list.

    User list in Roled Console

Your project is now fully configured and ready for authentication integration!

Project list after setup

Next steps

Choose your authentication approach:

Need more details?

IntroductionFully Managed Users