API Overview

​

API Services

​

Account Management

• Accounts - User account registration, activation, and identity management
• API Keys - Revocable authentication keys for API access

​

Security & Cryptography

• Certificates - X.509 certificate management and revocation
• Public Keys - Encryption public key management

​

Resource Patterns

• Accounts: accounts/{account}
• API Keys: measurementConsumers/{measurement_consumer}/apiKeys/{api_key}
• Certificates: {parent}/certificates/{certificate} where parent can be:
  • dataProviders/{data_provider}
  • duchies/{duchy}
  • measurementConsumers/{measurement_consumer}
  • modelProviders/{model_provider}
• Public Keys: {parent}/publicKey where parent can be:
  • dataProviders/{data_provider}
  • measurementConsumers/{measurement_consumer}

​

Authentication

1. API Keys - Created via the API Keys service for programmatic access
2. OpenID Connect - For user authentication with OIDC providers

​

Common Patterns

​

Pagination

message ListRequest {
  int32 page_size = 1;
  string page_token = 2;
}

message ListResponse {
  repeated Resource resources = 1;
  string next_page_token = 2;
}

​

Field Behavior

• REQUIRED - Must be provided in requests
• OUTPUT_ONLY - Only returned in responses, ignored in requests
• IMMUTABLE - Can only be set on creation
• IDENTIFIER - Resource name field

​

Error Handling

• PERMISSION_DENIED - Caller lacks permission for the operation
• NOT_FOUND - Resource not found
• ALREADY_EXISTS - Resource already exists
• INVALID_ARGUMENT - Invalid request parameters
• FAILED_PRECONDITION - Operation rejected due to system state

​

Protocol Buffers

​

Next Steps

• Review the Accounts API for user management
• Learn about API Keys for authentication
• Understand Certificate management
• Explore Public Key encryption