Skip to content
    Docs
    Oblax Modules
    Auth
    Realm

    Realm

    A Realm object represents an authentication portal within a project. Realms separate different login contexts such as customer-facing portals, admin dashboards, or partner areas. Roles are defined within realms, and sessions are scoped to a specific realm.

    Sample Object 

    {
  "id": "rlm_abc123def456",
  "name": "app"
}

    Fields

    FieldTypeDescription
    idstringUnique identifier for the Realm.
    namestringHuman-readable name of the realm. Used as the realm parameter in session endpoints.

    Actions

    Creating a realm

    Create a new authentication realm. The realm name is used in session endpoints and role assignments.

    obx app auth:realms init
    | SUCCESS: Realm initialized
| Edit the initialized realm file ./app/auth-realms/init.json

    After editing the template file:

    obx app auth:realms push init
    | SUCCESS: Realm created
| The realm has been successfully created on the platform.
| Local copy of the record is saved in ./app/auth-realms/rlm_abc123def456.json

    Getting a realm

    Retrieve a single realm by its ID.

    obx app auth:realms pull rlm_abc123def456
    | SUCCESS: Realm pulled
| The realm data has been saved to ./app/auth-realms/rlm_abc123def456.json

    Listing all realms

    Retrieve all realms in the project.

    obx app auth:realms list
    | SUCCESS: Realms listed
| All realms have been listed successfully.

    Updating a realm

    Update a realm’s name by its ID.

    Edit the local file ./app/auth-realms/rlm_abc123def456.json and run:

    obx app auth:realms push rlm_abc123def456
    | SUCCESS: Realm updated
| The realm has been updated successfully.

    Deleting a realm

    Archive a realm by its ID. Archived realms are hidden from list results but can be unarchived. A realm with assigned people cannot be deleted.

    obx app auth:realms delete rlm_abc123def456
    | SUCCESS: Realm deleted
| The realm has been deleted successfully.

    Listing archived realms

    Retrieve all archived (deleted) realms.

    No CLI command available. Use the REST or SDK methods.

    Unarchiving a realm

    Restore an archived realm by its ID.

    obx app auth:realms unarchive rlm_abc123def456
    | SUCCESS: Realm unarchived
| The realm has been unarchived successfully.
    SessionRole