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

# IAM

> Overview of NexusOne's IAM feature used for managing NexusOne roles for users and groups.

The IAM feature allows you to manage NexusOne roles for users and groups. A NexusOne role decides which NexusOne
features and data a user or group can access. You can either create new roles or use the default roles.

After you purchase NexusOne, your identity provider supplies your users, and [Keycloak](https://docs.nx1cloud.com/platform-components/keycloak)
controls what they can access. You don't create users in NexusOne. Instead, you create roles and groups in the NexusOne
portal, and you assign a role to a user or group to give them access to NexusOne features. Avoid making these changes
in the Keycloak Admin Console.

## Default roles in NexusOne

NexusOne ships with the following default roles, grouped by feature area:

* **AI roles**: The following roles apply to features in the AI section:
  * `nx1_admin`: Read and upload your own [notebooks](https://docs.nx1cloud.com/documentation/ai/overview/automl/notebooks.md),
    and classify tables in the metastore.
  * `nx1_airouter_admin`: Manage and update the AI router settings, and view all router metrics and replay records.
  * `nx1_airouter_viewer`: View the AI router settings, and view your own router metrics and replay records.
  * `nx1_analyst`: Read and upload your own notebooks, and build charts and dashboards from queries.
  * `nx1_ask`: Read and write access to the [Ask](https://docs.nx1cloud.com/documentation/ai/overview/ask.md)
    feature on the portal.
  * `nx1_automl_admin`: View, run, and delete [AutoML](https://docs.nx1cloud.com/documentation/ai/overview/automl/introduction.md)
    training and feature engineering jobs created by all users, and manage package sources.
  * `nx1_automl_user`: View, run, and delete the AutoML training and feature engineering
    jobs you created.
  * `nx1_crew`: Use the [Crews](https://docs.nx1cloud.com/documentation/agents/overview/crews.md) feature, including the builder, templates,
    history, and your own schedules.
  * `nx1_crew_admin`: View, disable, and delete the crew schedules of all users.
  * `nx1_llm_admin`: Configure routing rules and monitor the LLM router through the dashboard.
  * `nx1_llm_user`: Send requests to LLM models through the LLM router.
  * `nx1_steward`: Read and upload your own notebooks, and classify tables in the metastore.
* **Data pipeline roles**: The following roles apply to features in the Data pipeline section:
  * `nx1_catalog_admin`: Create catalogs, add columns to tables, sync data shares, and manage data share credentials.
  * `nx1_document_admin`: Upload and manage documents created by all users, and register document source providers.
  * `nx1_document_user`: Upload and manage the documents you created.
  * `nx1_engineer`: Read and write access to the [Engineer](https://docs.nx1cloud.com/documentation/data-pipeline/overview/engineer.md)
    feature on the portal.
  * `nx1_ingest`: Read access to the [Ingest](https://docs.nx1cloud.com/documentation/data-pipeline/overview/ingest.md)
    feature on the portal.
  * `nx1_quality`: Read and write access to the [Quality](https://docs.nx1cloud.com/documentation/data-pipeline/overview/quality.md)
    feature.
  * `nx1_quality_admin`: Approve suggested data quality rules, delete rules, and pause or delete the quality schedules of all users.
  * `nx1_s3_admin`: Complements the `nx1_ingest` role with write access to the
    object storage used in the Ingest feature.
  * `nx1_s3_viewer`: Read-only access to the object storage.
  * `nx1_semantic_admin`: Deploy, undeploy, approve, and reject [semantic models](https://docs.nx1cloud.com/documentation/catalog-and-models/overview/semantic-models.md),
    and manage all models.
  * `nx1_semantic_modeller`: Create, edit, and submit semantic models, and preview SQL.
  * `nx1_semantic_user`: View deployed semantic models.
* **Platform roles**: The following roles apply to apps and the Monitor page in the Platform section:
  * `nx1_app_manager`: Use Create, Read, Update, and Delete (CRUD)
    operations on apps and add or remove roles associated with the apps.
  * `nx1_monitor`: View, trigger, or delete the Airflow DAGs you created
    by interacting with other NexusOne features such as Ingest.
    DAGs appear on the [Monitor](https://docs.nx1cloud.com/documentation/platform/overview/monitor.md) page and on Airflow.
  * `nx1_monitor_admin`: View, trigger, or delete DAGs created by all users in the NexusOne portal.
  * `nx1_monitor_ops`: Same permissions as the `nx1_monitor` role, with a few additional ones.
* **Tools roles**: The following roles apply to the data migration tool:
  * `nx1_migration_admin`: Run data migrations, manage data policies,
    and configure the migration infrastructure settings.
  * `nx1_migration_ops`: Run and monitor data migrations and manage data policies,
    but not configure the migration infrastructure settings.
  * `nx1_migration_user`: View the status of data migration runs.

> [!NOTE]
>
> Each role has pre-assigned permissions that you can't access. However, you can create a new role and associate
> it to multiple roles.

## Additional roles in NexusOne

Several OSS tools power specific features in NexusOne, and they do this using roles. These roles are
different from the default NexusOne roles, and they include the following:

* **Apache Airflow**: The following roles are specific to the [Airflow](https://docs.nx1cloud.com/platform-components/apache-airflow) tool:
  * `airflow_admin`: Read and write permissions to all users.
  * `airflow_viewer`: View DAGs, tasks, logs, and metrics.
  * `airflow_user`: Create and edit personal DAGs,
    trigger your workflows, and view your task logs.
  * `airflow_ops`: Same permissions as the user role, with a few additional ones.
* **Apache Spark**: The following roles are specific to the [Spark](https://docs.nx1cloud.com/platform-components/apache-spark) tool:
  * `spark_sql`: Run SQL commands.
  * `spark-history-admins`: Read and write access to the Spark History Server.
  * `spark-history-viewers`: Read access to the Spark History Server.
* **Apache Superset**: The following roles are specific to the [Superset](https://docs.nx1cloud.com/platform-components/apache-superset) tool:
  * `superset_admin`: Manage users, databases, dashboards,
    SQL Lab, data sources, security policies, and all app configurations.
  * `superset_user`: Create and view dashboards, run SQL queries in SQL Lab,
    and explore datasets.
* **DataHub**: The following role is specific to the [DataHub](https://docs.nx1cloud.com/platform-components/datahub) tool
  * `datahub-admin`: Manage tags, domains, assertions, and more.
* **Trino**: The following role is specific to the [Trino](https://docs.nx1cloud.com/platform-components/trino) tool
  * `trino-admin`: Manage Trino queries and catalogs across all users, with full query access to all catalogs
    and schemas. Also grants read and write access to S3 buckets from the Jupyter UI.

## Use cases

These examples show how different industries can use NexusOne's IAM capabilities:

* **Financial services**: Combine the [`nx1_ingest`](#default-roles-in-nexusone)
  and [`nx1_quality`](#default-roles-in-nexusone) roles into one custom role, so an analyst
  gets both features in a single assignment.
* **Healthcare**: Assign a custom role that grants a compliance officer access only to audit
  logs and regulatory reports, without exposing sensitive patient data.

## Additional resources

To learn how NexusOne uses Keycloak for roles and groups, refer to
[Keycloak](https://docs.nx1cloud.com/platform-components/keycloak/keycloak-in-nx1.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.