Tenant ID Naming Conventions

Tenant ID naming

The tenant ID (also called "user ID" or "org ID") is the unique identifier of a tenant within a Cortex cluster. The tenant ID is opaque information to Cortex, which doesn't make any assumptions on its format/content, but its naming has three limitations:

1. Supported characters
2. Invalid tenant IDs
3. Length

Supported characters

The following character sets are generally safe for use in the tenant ID:

• Alphanumeric characters
  • 0-9
  • a-z
  • A-Z
• Special characters
  • Exclamation point (!)
  • Hyphen (-)
  • Underscore (_)
  • Single Period (.), but the tenant IDs . and .. are considered invalid
  • Asterisk (*)
  • Single quote (')
  • Open parenthesis (()
  • Close parenthesis ())

All other characters are not safe to use. In particular, slashes / and whitespaces ( ) are not supported.

Invalid tenant IDs

The following tenant IDs are considered invalid in Cortex.

• Current directory (.)
• Parent directory (..)
• Markers directory (__markers__)
• User Index File (user-index.json.gz)

Length

The tenant ID length should not exceed 150 bytes/characters.