> ## Documentation Index
> Fetch the complete documentation index at: https://docs.noxus.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Users

> Manage team members, permissions, and access control

Users in Noxus represent individual team members who have access to your workspaces. Each user has their own credentials, role, and activity tracking across one or more workspaces.

## User Profile

Each user has a personal profile that applies across all workspaces. It carries the following information:

* Name and display name
* Email address (login credential)
* Profile picture/avatar

### User Roles

Noxus provides a role-based access control (RBAC) system with clearly defined permissions. There are two role types:

* **Organization role** - Defines the permissions at the organization (platform) level.
* **Workspace role** - Defines the permissions at the workspace level. One per workspace.

<Note>
  When a user is an admin in the organization, they will also be an admin on all workspaces. To learn more, see [Permissions & roles](/platform/concepts/permissions).
</Note>

### API Keys

API keys provide programmatic access to a specific workspace. Each key is scoped to one workspace and can optionally be restricted to a subset of that workspace's permissions.

```bash theme={null}
# Using an API key
curl -X GET https://api.noxus.ai/v1/workflows \
  -H "Authorization: Bearer noxus_abc123..."
```

Keys are created from **Workspace Control** → **API keys**. When creating a key you can toggle **Restrict permissions** to limit the key to only specific workspace permissions.

<Warning>
  A key can never have more permissions than the user who created it. If a user's permissions are reduced, any keys they created retain only the permissions that still overlap.
</Warning>

***

## User Management

### Adding New Users

Add new members to your organization:

<Steps>
  <Step title="Navigate to Settings">
    Go to Settings → Users
  </Step>

  <Step title="Add User">
    Click "Add user" and:

    * Enter their name, email address, and organization role
    * Select which workspaces to add the user to
  </Step>

  <Step title="Assign Workspace Roles">
    Click "Next" and select the role for each workspace (platform admins are admins on all workspaces)
  </Step>

  <Step title="Invite User">
    Click "Add". The invited user will receive an email with the invitation
  </Step>
</Steps>

### Adding Existing Users to a Workspace

Invite team members to a workspace:

<Steps>
  <Step title="Navigate to Workspace Users">
    Go to Workspace settings → Users
  </Step>

  <Step title="Send Invitation">
    Click "Add users" and select which users to add
  </Step>

  <Step title="Assign Role">
    Select the appropriate role for each user
  </Step>

  <Step title="Add user">
    Click "Add". The user will be added to that workspace
  </Step>
</Steps>

<Note>
  You can also use the API and SDK to add users to the platform.
</Note>

### User Onboarding and Offboarding

<Tabs>
  <Tab title="Onboarding">
    When a user first joins a workspace:

    1. **Email invitation** - Receives an invite with workspace details.
    2. **Account creation** - Creates an account or signs in to an existing one.
    3. **Workspace tour** - Optional guided tour of key features.
    4. **Role assignment** - Receives an assigned role and permissions.
    5. **Resource access** - Can immediately access resources based on their role.

    ### Training & Resources

    <CardGroup cols={2}>
      <Card title="Documentation" icon="book" href="/core/getting-started">
        Comprehensive platform documentation.
      </Card>

      <Card title="Video Tutorials" icon="youtube" href="https://www.youtube.com/channel/UCUEYyBLmATYFegUxAdBKEaA">
        Step-by-step video guides (coming soon).
      </Card>

      <Card title="Example flows" icon="workflow" href="https://app.noxus.ai/templates">
        Templates and examples to learn from inside the platform.
      </Card>

      <Card title="Support" icon="headset" href="mailto:help@noxus.ai">
        Reach out to our support team.
      </Card>
    </CardGroup>
  </Tab>

  <Tab title="Offboarding">
    When a removing a user:

    1. **Review access** - Audit what resources the user created or has access to.
    2. **Revoke access** - Remove the user from the organization.
    3. **Invalidate keys** - Rotate any API keys or credentials the user had access to.

    ### Preserving Work

    User-created resources remain in the workspace:

    * Workflows continue to function
    * Agents remain operational
    * Knowledge bases stay intact
    * Activity logs are preserved

    <Warning>
      Removing a user immediately revokes all access. Ensure critical resources are reassigned first.
    </Warning>
  </Tab>
</Tabs>

***

## Best Practices

<Tabs>
  <Tab title="Permission management">
    * **Follow Least Privilege**: Grant the minimum permissions required for each user's role.
    * **Regular Access Reviews**: Quarterly review of user permissions and adjust as needed.
    * **Separate Roles by Function**: Don't make everyone an Admin; use appropriate roles.
    * **Use Service Accounts**: For integrations, avoid using personal accounts.
  </Tab>

  <Tab title="Organization">
    * **Document Roles**: Maintain documentation of who has what access and why.
    * **Clear Ownership**: Assign clear ownership for important resources.
    * **Offboarding Checklist**: Follow a consistent process when users leave.
    * **Training for New Users**: Ensure new team members understand their permissions and responsibilities.
  </Tab>
</Tabs>

***

## Other Core Concepts

<CardGroup cols={2}>
  <Card title="Workspaces" icon="boxes" href="/core/concepts/workspaces">
    Isolated environments for your projects and resources
  </Card>

  <Card title="Flows" icon="workflow" href="/core/concepts/flows">
    Start building flows in your workspace
  </Card>

  <Card title="Agents" icon="bot" href="/core/concepts/agents">
    Create and develop AI agents for your team
  </Card>

  <Card title="Knowledge Bases" icon="folder" href="/core/concepts/knowledge-bases">
    Intelligent data repositories to enhance your tools
  </Card>
</CardGroup>
