- 9 minutes to read

Add or Manage Claim

Master Claims management in Nodinite v7 with this comprehensive guide. Learn how to create, edit, delete, and restore authorization Claims for your OIDC/OAuth 2.0 deployment.

  • ✅ Inline editing for quick Claim creation
  • ✅ Track Claim usage across Policies
  • ✅ Restore deleted Claims when needed
  • ✅ Filter and search large Claim lists

Note

Claims are only available when Nodinite is configured for OIDC/OAuth 2.0 authentication mode (Install Nodinite v7 - OpenID). For Windows authentication mode, use Users and Windows AD Groups instead.

New to Claims? Read What is a Claim? first to understand the authorization model.

Accessing Claims Management

Navigate to Administration → Access Management → Claims in the Nodinite Web Client. The list itself is described in the Claims Overview.

Administration sidebar with the Claims menu item
Location of the Claims menu item in the Administration sidebar.

Claims List View

The Claims management page displays all Claims with the following information:

Claims Overview list with filter box, Include deleted checkbox, and the Group=Admin Claim
The Claims list with Key, Value, Description, and the Policies each Claim is used in.

Columns

Column Description
Status Visual indicator - Available or Deleted (when "Include deleted" is checked)
Key The claim key identifier
Value The claim value
Description Optional description explaining the Claim's purpose
Used In Shows which Policies use this Claim (up to 10 displayed as badges)
Created Timestamp when the Claim was created
Changed Timestamp when the Claim was last modified
Actions Pencil (Edit) button, and an Action menu with Delete (or Restore for a deleted Claim)

Filters and Controls

  • Add Claim button - Create a new Claim
  • Search Filter - Filter Claims by Key, Value, or Description
  • Include deleted - Toggle to show/hide deleted Claims (Show deleted records)
  • Column Sorting - Click column headers to sort

Adding a New Claim

Follow these steps to create a new Claim:

Step 1: Click "Add Claim"

Click the "Add Claim" button in the top-right corner of the Claims page.

Add Claim button on the Claims page
The "Add Claim" button adds a new row in inline edit mode.

Step 2: Enter Claim Details

A new row appears in inline edit mode. Fill in the required fields:

New Claim row in inline edit mode with Key, Value, and Description fields
The new row accepts the Key, Value, and an optional Description.

Field Required Description
Key ✅ Yes The claim key identifier (e.g., roles, groups, department), exactly as in the identity provider token
Value ✅ Yes The claim value (e.g., finance, admin, europe)
Description ❌ No A clear description of what this Claim represents

Tip

Best Practices for Keys:

  • Use the exact key name your identity provider sends (see OpenID Field Mapping Quick Reference)
  • Use lowercase for consistency in your own keys
  • Use underscores for multi-word keys (e.g., access_level)
  • Choose descriptive names (e.g., department not dept)

[!TIP] Best Practices for Values:

  • Use lowercase for consistency
  • Keep values simple and meaningful
  • Avoid special characters when possible

Step 3: Save the Claim

Click the "Save" button (checkmark icon) to create the Claim.

Save button with checkmark icon on the new Claim row
The checkmark Save button creates the Claim.

Step 4: Verify Creation

The new Claim appears in the list with:

  • Green success notification
  • Timestamp in the "Created" column
  • Empty "Used In" column (not yet assigned to any Policy)

Claims list row showing the newly created Claim
The new Claim appears in the list with an empty 'Used In' column.

Editing an Existing Claim

To modify a Claim's Key, Value, or Description:

Step 1: Click the Edit Button

Click the Edit button (pencil icon) to the left of the Action button.

Claims list row with the pencil Edit button highlighted
The pencil button puts the Claim row in edit mode.

Step 2: Modify Fields

The row enters edit mode. Modify any of the fields:

Claim row in edit mode with editable Key, Value, and Description
A Claim row in edit mode; all three fields can be changed.

  • Key - Change the claim key
  • Value - Change the claim value
  • Description - Update the description

Warning

Changing Key or Value:

  • Creates a new unique Key/Value combination
  • Cannot create a duplicate of an existing Claim
  • Changes what every Policy that uses this Claim requires; if your identity provider doesn't send the new value, users matched by those Policies lose access

Step 3: Save or Cancel

  • Click "Save" (checkmark icon) to apply changes:
    Save button with checkmark icon on the Claim row
    The checkmark button saves the row.
  • Click "Cancel" (X icon) to discard changes:
    Save and Cancel buttons on a Claim row in edit mode
    The X button discards the changes.

Step 4: Verify Changes

  • Timestamp in "Changed" column updates
  • Success notification appears
  • Changes are immediately applied to any Policies using this Claim

Deleting a Claim

To delete a Claim:

Step 1: Open Actions Menu

Click the "Action" dropdown button on the Claim row.

Action dropdown menu on a Claim row with the Delete menu item
The Action menu on an available Claim holds the Delete menu item.

Step 2: Select Delete

Select "Delete" from the menu.

Action menu with the Delete menu item highlighted
The highlighted 'Delete' menu item opens the confirmation modal.

Step 3: Confirm Deletion

A confirmation modal appears:

Delete Claim confirmation modal with Delete and Cancel buttons
The confirmation modal names the Claim before you delete it.

Review the information:

  • Claim Key and Value being deleted
  • List of Policies that currently use this Claim
  • Warning about impact

Click "Delete" to confirm, or "Cancel" to abort.

Important Notes About Deletion

Important

Deleted Claims and Policies:

  • Deleted Claims remain visible in Policies where they were used
  • They are marked with a warning badge in Policies
  • This maintains audit trail and prevents broken references
  • You can restore deleted Claims at any time

[!TIP] Best Practice: Review the "Used In" column before deleting to understand which Policies will be affected.

Step 4: Verify Deletion

  • Claim is removed from the main list
  • Success notification appears
  • To see deleted Claims, enable the "Include deleted" filter

Restoring a Deleted Claim

To restore a previously deleted Claim:

Step 1: Enable "Include deleted" Filter

Check the "Include deleted" checkbox at the top of the Claims page.

Claims list with Include deleted checked showing a Deleted and an Available Claim
With "Include deleted" checked, a Status column shows 'Deleted' and 'Available' badges.

Step 2: Locate the Deleted Claim

Deleted Claims appear with:

  • Red "Deleted" status badge
  • Grayed-out or strike-through text
  • Full historical information preserved

Claims list row with a red Deleted status badge
Deleted Claims keep their Key, Value, and Description.

Step 3: Open Actions Menu

Click the "Action" dropdown on the deleted Claim.

Step 4: Select Restore

Select "Restore" from the menu.

Action menu with the Restore menu item on a deleted Claim
On a deleted Claim, 'Restore' replaces 'Delete' in the Action menu.

Step 5: Confirm Restoration

A confirmation modal appears:

Restore Claim confirmation modal with Restore and Cancel buttons
The confirmation modal names the Claim before you restore it.

Click "Restore" to confirm.

Step 6: Verify Restoration

  • Claim returns to active status
  • "Deleted" badge removed
  • Available for use in Policies again
  • Warning badges removed from Policies where it was referenced

Validation Rules

Nodinite enforces these rules when managing Claims:

Required Fields

  • ❌ Cannot save without a Key
  • ❌ Cannot save without a Value

Claim row with required field validation messages for Key and Value
The row can't be saved until both Key and Value have a value.

Unique Combination

  • ❌ Cannot create a Claim with an existing Key/Value combination
  • ✅ Can create department=finance and department=hr (different values)
  • ✅ Can create department=finance and region=finance (different keys)

Error message for a duplicate Claim Key and Value combination
Check 'Include deleted' when this appears: the duplicate may be a deleted Claim you can restore.

Case Sensitivity

  • department=Finance ≠ department=finance
  • Department=finance ≠ department=finance
  • Keys and Values are case-sensitive

Viewing Claim Usage

Understanding which Policies use a Claim:

"Used In" Column

The "Used In" column shows:

Used In column with Country Administrator and Default Policy badges
Each badge in the "Used In" column links to a Policy that contains the Claim.

  • Policy badges - Clickable links to each Policy
  • Count indicator - "(+2 more)" when more than 10 Policies
  • Hover tooltip - Full list of all Policies
  • Empty - Claim not used in any Policy

Click any Policy badge to:

  • Open that Policy detail page
  • See all Claims in the Policy
  • Edit the Policy if needed

Before Deletion

Use the "Used In" column to:

  • Identify impact of deleting a Claim
  • Plan migration to replacement Claims
  • Coordinate with team members

Best Practices

Naming Conventions

Consistent Key Naming 

✅ Good:
   department
   access_level
   region
   environment

❌ Avoid:
   Dept
   AccessLevel
   REGION
   env-name

Consistent Value Naming 

✅ Good:
   finance
   admin
   europe
   production

❌ Avoid:
   Finance_Dept
   ADMIN
   EU
   prod-01

Descriptions

Always provide clear descriptions:

✅ Good Description:
   "Member of the Finance Department - grants access to financial 
    integrations, invoicing systems, and financial reporting"

❌ Poor Description:
   "Finance"
   "Department claim"

Organization

Group related Claims logically:

Department Claims

  • department=finance
  • department=operations
  • department=hr
  • department=it

Access Level Claims

  • access_level=readonly
  • access_level=editor
  • access_level=admin

Regional Claims

  • region=europe
  • region=americas
  • region=asia

Regular Maintenance

  • Review Claims quarterly
  • Remove unused Claims
  • Update descriptions for clarity
  • Verify Policy assignments

Tip

Looking for more examples? See Common Scenarios for comprehensive implementation guides including department-based access, regional authorization, and multi-tenant setups.

[!NOTE] Having issues? Check the Troubleshooting Guide for solutions to common Claim management problems.

Security Considerations

Principle of Least Privilege

Create specific Claims rather than overly broad ones:

✅ Specific Claims:
   department=finance
   access_level=readonly
   view=invoices_only

❌ Too Broad:
   access=all
   permission=everything
   role=superuser

Audit Trail

Every Claim action is tracked and searchable in Log Audits:

  • Creation timestamp and user
  • Modification history
  • Deletion and restoration events
  • Usage in Policies

Review Before Deletion

Always check "Used In" before deleting:

  1. Understand impact on Policies
  2. Plan replacement Claims if needed
  3. Communicate with team
  4. Document the change

Quick Reference

Action Steps
Add Claim Click "Add Claim" → Enter Key, Value, Description → Save
Edit Claim Click Edit icon → Modify fields → Save
Delete Claim Action menu → Delete → Confirm
Restore Claim Enable "Include deleted" → Action menu → Restore → Confirm
Find Usage Check "Used In" column → Click Policy badges
Search Claims Use search filter → Type Key, Value, or Description

Next Steps

Claims

Policies

Roles

Configuration

Guides