EnSync Engine Documentation Help

EnSync Access Keys

Overview

Access Keys are a fundamental security and integration feature of the EnSync platform. They serve as secure credentials that control how applications, services, and users interact with the EnSync ecosystem.

Types of Access Keys

Account Keys

Account Keys are designed for administrative and management purposes:

  • Administrative Control: Manage resources, configurations, and settings

  • Resource Management: Create, read, update, and delete EnSync resources

  • Permission-based: Can be configured with specific permissions for different resources

  • UI Integration: Used by dashboard applications and administrative tools

Service Keys

Service Keys enable secure service-to-service communication:

  • Event Streaming: Allow services to send and receive events

  • Automated Processes: Used by background processes and automated workflows

  • Specialized Access: Typically limited to specific event types or operations

  • System Integration: Connect external systems to the EnSync ecosystem

Key Benefits

Enhanced Security

  • Granular Permissions: Define exactly what each key can access

  • Revocable Access: Instantly revoke access when needed

  • Audit Trail: Track which keys are accessing which resources

  • Reduced Attack Surface: Limit exposure by providing only necessary permissions

Simplified Integration

  • Standardized Authentication: Consistent authentication method across all EnSync services

  • Easy Implementation: Simple to implement in any programming language

  • Self-Service: Teams can manage their own keys without central IT involvement

  • Flexible Usage: Works with both REST and gRPC APIs

Operational Excellence

  • Reduced Overhead: Eliminate complex authentication schemes

  • Scalable Management: Easily manage thousands of keys across your organization

  • Environment Isolation: Create separate keys for development, testing, and production

  • Rotation Policies: Implement key rotation for enhanced security

Governance and Compliance

  • Access Control: Enforce the principle of least privilege

  • Compliance Support: Help meet regulatory requirements for access control

  • Visibility: Clear overview of who has access to what resources

  • Centralized Management: Single point of control for all access credentials

Real-World Use Cases

Multi-Team Development

When multiple teams are developing against EnSync, each team can have their own access keys with appropriate permissions, preventing accidental interference between teams.

Microservice Architecture

In a microservice architecture, each service can have its own access key with precisely the permissions it needs, enhancing security and reducing potential blast radius of compromised credentials.

Third-Party Integration

When integrating with third-party services, provide them with limited-scope access keys that only grant access to the specific resources they need.

CI/CD Pipelines

Automated deployment pipelines can use service keys to securely deploy and configure EnSync resources without requiring human intervention.

Best Practices

  1. Follow Least Privilege: Only grant the permissions that are absolutely necessary

  2. Regular Rotation: Implement a key rotation schedule for sensitive environments

  3. Environment Separation: Use different keys for development, testing, and production

  4. Monitoring: Set up alerts for unusual access key usage patterns

  5. Documentation: Maintain clear documentation of what each key is used for

Access Keys are a cornerstone of EnSync's security model, providing both protection and flexibility while enabling seamless integration across your technology ecosystem.

Last modified: 07 October 2025