Getting started with the Secure Private Access Hybrid REST API mode

This document provides guidance and highlights key differences for using the Secure Private Access API in Hybrid REST API mode.

Key Differences in Hybrid REST API mode

• Authentication:
  While the standard API uses username, password, and domain for authentication, Hybrid mode may require different credentials or an alternative authentication flow, such as OAuth2 or API keys. Consult your administrator for the correct process.

• Headers:
  All standard headers (Authorization, Accept, Content-Type, Host, and Content-Length) must still be included. However, Hybrid mode may introduce additional required headers or tokens, depending on your organization’s configuration.

• Citrix-TransactionId:
  The behavior for the Citrix-TransactionId header’ remains the same. If a transaction ID is received in a response, include it in all subsequent requests.

• Error Handling:
  Error responses in Hybrid mode continue to be returned as JSON, but the error structure or codes may differ depending on the integration with other systems in your hybrid environment.

• OpenAPI Specification:
  The Hybrid REST API’s OpenAPI specification differs from the on-premises API. For more details please refer to the Hybrid REST API OpenAPI Specification page.

Placeholders

All values in curly braces {} must be replaced with your actual hybrid environment values.

Points to note

• Always use https for all requests in Hybrid mode.
• Ensure your client is configured to handle any additional authentication or header requirements unique to your hybrid deployment.
• Consult your administrator or hybrid deployment documentation for environment-specific requirements.

Support

For issues or further details about Hybrid REST API mode, contact your Secure Private Access administrator or refer to your organization’s hybrid deployment guides.