Skip to content

Authentication

NEMAR uses API key authentication with an admin approval workflow.

  1. Sign up - Create an account with your details
  2. Verify email - Click the link in the verification email
  3. Wait for approval - Admin reviews your request
  4. Retrieve API key - Use nemar auth retrieve-key with your email and password
  5. Log in - Use your API key to authenticate
Terminal window
nemar auth signup

You’ll be prompted for:

FieldDescription
Username3-30 characters, alphanumeric with - and _
EmailValid email for verification
PasswordMinimum 12 characters
GitHub UsernameRequired for PR collaboration
ORCID iDOptional, used for DOI creator metadata
DescriptionWhy you need NEMAR access (min 20 chars)
Terminal window
nemar auth login
Terminal window
nemar auth login -k nemar_your_api_key_here
Terminal window
export NEMAR_API_KEY=nemar_your_api_key_here
nemar auth login
Terminal window
# View cached credentials
nemar auth status
# Refresh from server
nemar auth status --refresh
Terminal window
# Remove the active account
nemar auth logout
# Remove all stored accounts
nemar auth logout --all

If you have multiple NEMAR accounts:

Terminal window
# Interactive account picker
nemar auth switch
# Switch to a specific account
nemar auth switch <username>

If you didn’t receive the verification email:

Terminal window
nemar auth resend-verification

Your API key is linked to:

  • Your GitHub Personal Access Token (for repository operations)
  • Your S3 credentials (for data upload/download)

If you suspect your key is compromised, regenerate it immediately:

Terminal window
nemar auth regenerate-key

This sends a verification email and revokes the old key upon confirmation.