Added

{ New } - Account Management Endpoint

Docs: My Account Endpoint

  • Added a new endpoint: GET /my-account

Purpose: Provides comprehensive self-service account information and API permissions for authenticated users based on their API key authentication.

  • Response includes:
    • name: User's full name and contact information
    • email: Primary account email address
    • companies: List of associated company configurations (when available)
    • domains/external_domains/apps: Asset configuration for non-enterprise accounts
    • alert_emails: Configured notification recipients for security alerts
    • date_created: Account creation timestamp for audit trails
    • permissions: Categorized API access controls organized by data, search, visibility, and filtering categories

Example Request:

curl --request GET \
     --url https://api.hudsonrock.com/json/v3/my-account \
     --header 'accept: application/json' \
     --header 'api-key: <API_KEY>'

Use Cases:

  • Permission Auditing: Self-service visibility into API access levels and categorized permissions for compliance workflows
  • Account Verification: Validate configured assets, notification settings, and account metadata
  • Company ID Discovery: Retrieve company identifiers for use with enterprise search endpoints
  • Integration Planning: Understand available API capabilities and access scope for application development
  • Governance & Compliance: Audit trail access and permission verification for security assessments