Zoho: Specific Portal

Zoho portals.getPortal: arguments, response, policy and SDK examples.

Operation zoho.getportal

Provider route: GET /crm/v8/settings/portals/{portal}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/zoho with npm, or alter-sdk-zoho with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { ZohoIntegration } from "@alter-ai/zoho";

async function execute(input: Parameters<ZohoIntegration["portals"]["getPortal"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new ZohoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.portals.getPortal(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_zoho import ZohoIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = ZohoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.portals.get_portal(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.portal`	string	Required within parent	Represents the unique name of the portal. Maximum length: 60

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	JSON	Root
`$ (anyOf 1)`	object	Alternative	Represents the 200 response schema for getting a portal by identifier, containing the full portal configuration. Additional keys: not allowed
`$ (anyOf 1).portals`	array	Required within parent	Represents the list of portal objects returned by the response. Maximum items: 100
`$ (anyOf 1).portals[]`	object	Each item	Represents the detailed configuration of a single portal. Additional keys: not allowed
`$ (anyOf 1).portals[].acs_url`	string	Optional	Represents the Assertion Consumer Service (ACS) URL for the portal. Maximum length: 2048
`$ (anyOf 1).portals[].active`	boolean	Required within parent	Indicates whether the portal is active.
`$ (anyOf 1).portals[].admin_zuid`	JSON	Optional
`$ (anyOf 1).portals[].admin_zuid (anyOf 1)`	integer	Alternative	Represents the Zoho account zone ID of the portal administrator. Format: int32
`$ (anyOf 1).portals[].admin_zuid (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).portals[].created_by`	object	Required within parent	Represents the Zoho CRM user who created this portal. Additional keys: not allowed
`$ (anyOf 1).portals[].created_by.id`	string	Required within parent	Represents the unique identifier of the CRM user who created this portal. Maximum length: 255
`$ (anyOf 1).portals[].created_by.name`	string	Required within parent	Represents the name of the CRM user who created this portal. Maximum length: 255
`$ (anyOf 1).portals[].created_time`	string	Required within parent	Represents the timestamp when the portal was first added. Format: date-time
`$ (anyOf 1).portals[].default_relay_state_url`	string	Optional	Represents the default relay state URL used after a successful SAML login. Maximum length: 2048
`$ (anyOf 1).portals[].issuer`	string	Optional	Represents the SAML issuer identifier (entity ID) for the portal. Maximum length: 2048
`$ (anyOf 1).portals[].login_url`	string	Optional	Represents the login URL for the portal. Displayed on the portal login page. Maximum length: 2048
`$ (anyOf 1).portals[].modified_by`	object	Required within parent	Represents the Zoho CRM user who last modified this portal. Additional keys: not allowed
`$ (anyOf 1).portals[].modified_by.id`	string	Required within parent	Represents the unique identifier of the user who last modified this portal. Maximum length: 255
`$ (anyOf 1).portals[].modified_by.name`	string	Required within parent	Represents the name of the user who last modified this portal. Maximum length: 255
`$ (anyOf 1).portals[].modified_time`	string	Required within parent	Represents the timestamp when the portal configuration was last modified. Format: date-time
`$ (anyOf 1).portals[].name`	string	Optional	Represents the unique name of the portal. Maximum length: 50
`$ (anyOf 1).portals[].saml_configuration`	JSON	Required within parent
`$ (anyOf 1).portals[].saml_configuration (anyOf 1)`	object	Alternative	Represents the SAML authentication configuration for the portal. Additional keys: not allowed
`$ (anyOf 1).portals[].saml_configuration (anyOf 1).active`	boolean	Required within parent	Indicates whether the SAML configuration is active for the portal. Possible values: true - SAML SSO is enabled. Known values: True
`$ (anyOf 1).portals[].saml_configuration (anyOf 1).created_by`	object	Optional	Represents the Zoho CRM user who created this SAML configuration. Additional keys: not allowed
`$ (anyOf 1).portals[].saml_configuration (anyOf 1).created_by.id`	string	Required within parent	Represents the unique identifier of the CRM user who created this SAML configuration. Maximum length: 255
`$ (anyOf 1).portals[].saml_configuration (anyOf 1).created_by.name`	string	Required within parent	Represents the name of the CRM user who created this SAML configuration. Maximum length: 255
`$ (anyOf 1).portals[].saml_configuration (anyOf 1).login_url`	string	Required within parent	Represents the SAML SSO login URL where the portal redirects users for authentication. Maximum length: 2048
`$ (anyOf 1).portals[].saml_configuration (anyOf 1).logout_url`	string	Required within parent	Represents the SAML SSO logout URL where the portal redirects users when they sign out. Must begin with `https://www.`. Maximum length: 2048 Pattern: http[s]://www[.][a-z]{7}[.]com
`$ (anyOf 1).portals[].saml_configuration (anyOf 1).modified_by`	object	Optional	Represents the Zoho CRM user who last modified this SAML configuration. Additional keys: not allowed
`$ (anyOf 1).portals[].saml_configuration (anyOf 1).modified_by.id`	string	Required within parent	Represents the unique identifier of the user who last modified this SAML configuration. Maximum length: 255
`$ (anyOf 1).portals[].saml_configuration (anyOf 1).modified_by.name`	string	Required within parent	Represents the name of the user who last modified this SAML configuration. Maximum length: 255
`$ (anyOf 1).portals[].saml_configuration (anyOf 1).public_key`	string	Required within parent	Represents the SAML X.509 public key certificate used to verify assertions from the identity provider. Known values: -----BEGIN CERTIFICATE-----nMIICkTCCAXkCBgGFNDYS5DANBgkqhkiG9w0BAQsFADAMMQowCAYDVQQDEwFBMB4XDTIyMTIyMDEwMjM1N1oXDTI1MTIyMDEwMjM1N1owDDEKMAgGA1UEAxMBQTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAJ9JHZa/KoI1v4bl9HyDB2EB684y1P8hykirP0BoGpf2o4hj2ITjkhncbBJt9PFR8Cp8PmxL7UnGIZl/4g0VQMIxtq82UuvaC8uTZUQJeUDbrPEVMoN12YOF2sJ2AZ4gf3Pr6rf+kXYDp5T9gyFMFUzqNS/WL5xOpyzVJkROv69YbPkcLWms+orpcs+ADXXNfwhIfwF6ZLcNqgi1itX9T/vuvW5KEcU5QtOLLQdqNQ0Oi/0oiyIXhcsjGD1e+QSAtxdTpM44WkxOYW3TUj0+8EZOdU+Vj0lhgr61+bJHgnYiyA83LHqKcIKXEYVs70Lb3Ors4dU7XU6gBzxLnsf9nCECAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAUiTh+to8d/QKYh9yOLqE25PraBEVselNgNx8Dly//JXfXz42lzwG5WOY94bmUur2qYe8sVUqY07O/1XSW7QBrGMhGA9Hhvgz6zrRPzGPUVVQT3caTG/b+1pNLriga7OSam6rp1uL5emutkyyn6ZUZ7px4K1vGEx6/GBFsepGH5E2N0PRuekTp0eiV+5m+6z4VL7tVtYGQbWUfVgBqBUEhkdu450ry0jJT6SPs1W8TPBQEZQ/Pjis4MubIRKrUtkb+SkLDpBSWmXdoKlsIJt8VqhdqN04bmt91sB+XdgSC4X7ideK7WPcEj2DYna4v/YB13MitxQrKKU9uT/HNm1JHg==n-----END CERTIFICATE----- Maximum length: 5000
`$ (anyOf 1).portals[].saml_configuration (anyOf 2)`	null	Alternative	Represents the SAML authentication configuration for the portal. Additional keys: not allowed
`$ (anyOf 1).portals[].saml_configuration (anyOf 2).active`	boolean	Required within parent	Indicates whether the SAML configuration is active for the portal. Possible values: true - SAML SSO is enabled. Known values: True
`$ (anyOf 1).portals[].saml_configuration (anyOf 2).created_by`	object	Optional	Represents the Zoho CRM user who created this SAML configuration. Additional keys: not allowed
`$ (anyOf 1).portals[].saml_configuration (anyOf 2).created_by.id`	string	Required within parent	Represents the unique identifier of the CRM user who created this SAML configuration. Maximum length: 255
`$ (anyOf 1).portals[].saml_configuration (anyOf 2).created_by.name`	string	Required within parent	Represents the name of the CRM user who created this SAML configuration. Maximum length: 255
`$ (anyOf 1).portals[].saml_configuration (anyOf 2).login_url`	string	Required within parent	Represents the SAML SSO login URL where the portal redirects users for authentication. Maximum length: 2048
`$ (anyOf 1).portals[].saml_configuration (anyOf 2).logout_url`	string	Required within parent	Represents the SAML SSO logout URL where the portal redirects users when they sign out. Must begin with `https://www.`. Maximum length: 2048 Pattern: http[s]://www[.][a-z]{7}[.]com
`$ (anyOf 1).portals[].saml_configuration (anyOf 2).modified_by`	object	Optional	Represents the Zoho CRM user who last modified this SAML configuration. Additional keys: not allowed
`$ (anyOf 1).portals[].saml_configuration (anyOf 2).modified_by.id`	string	Required within parent	Represents the unique identifier of the user who last modified this SAML configuration. Maximum length: 255
`$ (anyOf 1).portals[].saml_configuration (anyOf 2).modified_by.name`	string	Required within parent	Represents the name of the user who last modified this SAML configuration. Maximum length: 255
`$ (anyOf 1).portals[].saml_configuration (anyOf 2).public_key`	string	Required within parent	Represents the SAML X.509 public key certificate used to verify assertions from the identity provider. Known values: -----BEGIN CERTIFICATE-----nMIICkTCCAXkCBgGFNDYS5DANBgkqhkiG9w0BAQsFADAMMQowCAYDVQQDEwFBMB4XDTIyMTIyMDEwMjM1N1oXDTI1MTIyMDEwMjM1N1owDDEKMAgGA1UEAxMBQTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAJ9JHZa/KoI1v4bl9HyDB2EB684y1P8hykirP0BoGpf2o4hj2ITjkhncbBJt9PFR8Cp8PmxL7UnGIZl/4g0VQMIxtq82UuvaC8uTZUQJeUDbrPEVMoN12YOF2sJ2AZ4gf3Pr6rf+kXYDp5T9gyFMFUzqNS/WL5xOpyzVJkROv69YbPkcLWms+orpcs+ADXXNfwhIfwF6ZLcNqgi1itX9T/vuvW5KEcU5QtOLLQdqNQ0Oi/0oiyIXhcsjGD1e+QSAtxdTpM44WkxOYW3TUj0+8EZOdU+Vj0lhgr61+bJHgnYiyA83LHqKcIKXEYVs70Lb3Ors4dU7XU6gBzxLnsf9nCECAwEAATANBgkqhkiG9w0BAQsFAAOCAQEAUiTh+to8d/QKYh9yOLqE25PraBEVselNgNx8Dly//JXfXz42lzwG5WOY94bmUur2qYe8sVUqY07O/1XSW7QBrGMhGA9Hhvgz6zrRPzGPUVVQT3caTG/b+1pNLriga7OSam6rp1uL5emutkyyn6ZUZ7px4K1vGEx6/GBFsepGH5E2N0PRuekTp0eiV+5m+6z4VL7tVtYGQbWUfVgBqBUEhkdu450ry0jJT6SPs1W8TPBQEZQ/Pjis4MubIRKrUtkb+SkLDpBSWmXdoKlsIJt8VqhdqN04bmt91sB+XdgSC4X7ideK7WPcEj2DYna4v/YB13MitxQrKKU9uT/HNm1JHg==n-----END CERTIFICATE----- Maximum length: 5000
`$ (anyOf 1).portals[].single_logout_url`	string	Optional	Represents the single logout URL (SLO) used to terminate SAML sessions across all service providers. Maximum length: 2048
`$ (anyOf 1).portals[].zaid`	string	Required within parent	Represents the Zoho account ID (`zaid`) associated with the portal. Maximum length: 255
`$ (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: zoho.getportal. Catalog operation: getPortal. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

No-content response statuses: [204]

Official provider source

Report an issue with this page