BYOS architecture considerations and troubleshooting
As a Lead System Architect (LSA), you can use Bring Your Own Secrets (BYOS) across the mission-critical integration, security, and storage layers of Pega Platform™. Instead of storing credentials directly within Rule forms or data instances, Pega Platform references secrets dynamically from the external vault at runtime.
The following table describes the primary Pega Platform components through which LSA retrieve secrets and federate identity by using BYOS:
|
Pega component or Rule |
BYOS usage |
Architectural considerations |
|---|---|---|
|
OAuth 2.0 Authentication Profiles |
References client IDs, client secrets, proxy credentials, and credentials for Resource Owner Password Credentials (ROPC) grant types. |
Verify that the external secret store uses the required key-value formats and character encodings. Ensure that the Pega Platform instance has network connectivity and IAM/service principal authorization to read the secret path. |
|
OAuth 2.0 client registrations |
You can store, validate, and automatically rotate client credentials issued by Pega Platform externally. |
Microsoft Azure Key Vault is a supported provider for BYOS; however, Azure Key Vault references are not available on the OAuth 2.0 Client Registration Rule form. |
|
Cloud repositories |
Amazon S3 and Google Cloud Storage use identity federation instead of manually entered cloud credentials. |
Google Cloud Storage federation is available starting with the Pega Platform 26.1.1 release. |
|
Keystores |
Retrieves keystore files and passwords from external secret stores. |
Supported consumers include Apache Kafka instances, Apache Avro schema registries, and Google Cloud Pub/Sub datasets. |
|
Encryption key management |
References master key encryption IDs in AWS Key Management Service (AWS KMS) or Google Cloud KMS. |
KMS authentication uses identity federation, eliminating the need to upload a credential file. |
Architecture decisions
Before selecting a secret-management strategy, consider the following architectural questions.
Where will the organization store secrets: in the application or externally?
If the organization already uses an enterprise secret manager, avoid creating an additional copy of the secret in the application.
Who is responsible for secret governance and rotation?
The security team manages the secret lifecycle, while the application consumes the secret through a stable reference.
How can the architecture reduce the risk of credential exposure?
Reducing the number of locations that store a secret can reduce the impact and scope of a credential compromise.
Can the integration use federation instead of long-lived credentials?
Use federated authentication instead of stored cloud credentials when the provider and the consuming Rule are compatible with federation.
What enterprise requirements drive the secret-management strategy?
Evaluate ownership, auditing, access controls, lifecycle management, and rotation requirements to determine whether centralized secret management is appropriate.
Recommended practices
The following recommendations are architectural guidance:
- Apply least-privilege access to identities that retrieve secrets from the enterprise secret manager.
- Grant access only to the secrets and operations required by the integration.
- Avoid wildcard permissions to reduce the attack surface.
- Use consistent secret reference names across environments to simplify deployment and operations.
- Map stable reference names to environment-specific secret values rather than updating application configurations.
- Avoid embedding cloud-provider-specific resource identifiers or vault endpoints directly in application Rules.
- Use private network connectivity for secret retrieval when required by the organization's security architecture.
- Design trust relationships that allow cross-account, cross-subscription, or cross-project access when environments are separated.
- Align secret-rotation processes with the applications and services that consume the secrets.
- Validate secret retrieval, refresh, and caching behavior in lower environments before implementing a production rotation strategy.
For AWS implementations, the federated identity requires permissions to retrieve secrets from AWS Secrets Manager. For example, secretsmanager:GetSecretValue allows the identity to retrieve a secret value. If the secret uses a customer-managed AWS KMS key, the identity also requires kms:Decrypt permission to decrypt the secret value.
Troubleshooting BYOS
Begin troubleshooting by determining whether the failure occurs during identity federation or secret retrieval. The following table describes common BYOS alerts and symptoms, their possible causes, and recommended actions:
|
Alert or symptom |
Meaning |
Possible causes |
Recommended action |
|---|---|---|---|
|
SECU0023 cloud identity federation failure |
Pega Platform cannot obtain temporary cloud credentials. |
The federation configuration, assigned role, policy, or scope is missing or invalid; a token or provider credential has expired; network access to the token endpoint is blocked; or the trust policy is insufficient. |
Review the Identity Federation Rule named in the alert. Verify the federation configuration, trust settings, roles, policies, and scopes in the cloud provider console. Confirm network access from the Pega Platform nodes to the provider token endpoint. |
|
SECU0024 external secret reference failure |
Identity federation succeeds, but Pega Platform cannot retrieve the secret. |
Common causes include an incorrect reference mapping, an invalid secret identifier, insufficient permissions to access or decrypt the secret, or other external secret store configuration issues. |
Verify the reference mapping in the External Secret Store Rule. Review the secret identifier and confirm that the federated identity has the required permissions to access and decrypt the secret. |
|
Missing Rule forms |
The Identity Federation or External Secret Store Rule form does not appear. |
One or both feature toggles are disabled. |
Confirm that EnableIdentityFederation and EnableSecretStoreMapping are enabled. |
Check your knowledge with the following interaction:
This Topic is available in the following Module:
Want to help us improve this content?