Zone

JSON representation
{
  "zoneId": string,
  "name": string,
  "description": string,
  "organization": string,
  "manualApproval": boolean,
  "portals": [
    string
  ],
  "companyName": string,
  "copyright": string,
  "accountCreationEmail": string,
  "allowedDomains": {
    object (AllowedDomains)
  },
  "productLogo": string,
  "squareLogo": string,
  "tokenPolicy": {
    object (TokenPolicy)
  },
  "links": {
    object (Links)
  },
  "smtpConfig": {
    object (SmtpConfig)
  },
  "footerLinks": {
    string: string,
    ...
  },
  "customEmailTemplates": {
    object (CustomEmailTemplates)
  },
  "customRegistrationFields": [
    {
      object (CustomRegistrationField)
    }
  ],
  "hostWhitelistedDomains": [
    string
  ],
  "samlConfig": {
    object
  },
  "active": boolean,
  "created": string,
  "modified": string,
  "id": string
}
Fields
zoneId

string

ID of the zone.

name

string

Name of the zone.

description

string

Description of the zone.

organization

string

Apigee organization associated with the zone.

manualApproval

boolean

Boolean flag that specifies whether manual approval of users is required.

portals[]

string

List of portals associated with the zone.

companyName

string

Company associated with the zone.

copyright

string

Copyright information displayed on the sign in page for the zone to enable custom branding.

accountCreationEmail

string

Address to which notification emails are sent when a new account is created.

allowedDomains

object (AllowedDomains)

List of individual email addresses (developer@some-company.com) or email domains (some-company.com, without the leading @) that can create accounts on your portal.

tokenPolicy

object (TokenPolicy)

Token policy for the zone.

smtpConfig

object (SmtpConfig)

SMTP configuration for the zone.

customEmailTemplates

object (CustomEmailTemplates)

Email templates used by the zone. Email templates enable a user to customize the emails that are sent by a zone for different actions including: account verification, password reset, and account creation.

customRegistrationFields[]

object (CustomRegistrationField)

Customized fields used on user registration form.

hostWhitelistedDomains[]

string

List of portal URLs that are allowed to use this zone for sign in and zone redirection after successful sign in. This list is used as a security measure so that the zone only redirects to a predefined set of URLs that are configured when the zone or portal is created, and when a custom domain is set on a portal.

samlConfig

object (Struct format)

SAML configuration used by the zone.

active

boolean

Boolean flag that specifies whether the zone is active.

created

string (int64 format)

Time the zone was created in milliseconds since epoch.

modified

string (int64 format)

Time the zone was last modified in milliseconds since epoch.

id

string

ID of the zone.

AllowedDomains

JSON representation
{
  "whitelistedDomains": [
    string
  ]
}
Fields
whitelistedDomains[]

string

Individual email addresses (developer@some-company.com) or email domains (some-company.com, without the leading @) that can create accounts on your portal.

TokenPolicy

JSON representation
{
  "accessTokenValidity": string,
  "refreshTokenValidity": string,
  "keys": {
    object
  }
}
Fields
accessTokenValidity

string (int64 format)

Duration in seconds that the access token will be valid after it is created.

refreshTokenValidity

string (int64 format)

Duration in seconds that the refresh token will be valid after it is created.

keys

object (Struct format)

Keys used by the token policy.

Logout

Links and information used when signing out of zone.

JSON representation
{
  "redirectUrl": string,
  "redirectParameterName": string,
  "disabledRedirectParameter": boolean,
  "whitelist": string
}
Fields
redirectUrl

string

URL to which users are directed when signing out of zone.

redirectParameterName

string

URI parameter for the sign-out redirection.

disabledRedirectParameter

boolean

Boolean flag that specifies whether the redirect parameter is disabled.

whitelist

string

Comma-delimited string of email addresses and domains that can create accounts on your portal.

SelfService

JSON representation
{
  "passwd": string,
  "selfServiceLinksEnabled": boolean,
  "signup": string
}
Fields
passwd

string

Link in the UI to reset the password for the zone.

signup

string

Link in the UI to create an account in the zone.

SmtpConfig

SMTP configuration for a zone.

JSON representation
{
  "sender": string,
  "serverHost": string,
  "serverUsername": string,
  "serverPassword": string,
  "serverPort": string,
  "secureAuthType": string
}
Fields
sender

string

Email address used as the sender.

serverHost

string

Hostname of the SMTP server, such as smtp.gmail.com.

serverUsername

string

Username of the SMTP account.

serverPassword

string

Password of the SMTP account.

serverPort

string

Port to be used, such as 465 if you are using TLS/SSL.

secureAuthType

string

Authorization type. Valid values include: SSL or TLS. Leave this field blank for no authorization.

CustomEmailTemplates

Email templates used by a zone.

JSON representation
{
  "activate": {
    object (CustomEmailTemplate)
  },
  "accountNotify": {
    object (CustomEmailTemplate)
  },
  "accountVerify": {
    object (CustomEmailTemplate)
  },
  "resetPassword": {
    object (CustomEmailTemplate)
  }
}
Fields
activate

object (CustomEmailTemplate)

Email template used for activating a user's account.

accountNotify

object (CustomEmailTemplate)

Email template that is sent when a user registers an account.

accountVerify

object (CustomEmailTemplate)

Email template that is sent when a user needs to verify their email address.

resetPassword

object (CustomEmailTemplate)

Email template used for resetting a user's password.

CustomEmailTemplate

Template for an email.

JSON representation
{
  "subject": string,
  "body": string
}
Fields
subject

string

Template for the subject of the email.

body

string

Template for the body of the email.

CustomRegistrationField

JSON representation
{
  "fieldType": string,
  "required": boolean,
  "sortOrder": integer,
  "active": boolean,
  "fieldName": string
}
Fields
fieldType

string

Type of custom registration field.

required

boolean

Boolean flag that specifies whether the field is required.

sortOrder

integer

Sort order for the custom field.

active

boolean

Boolean flag that specifies whether the field is enabled.

fieldName

string

Name of the custom field.