google_api_apigee v0.2.0 GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Zone View Source
Attributes
accountCreationEmail
(type:String.t
, default:nil
) - Address to which notification emails are sent when a new account is created.active
(type:boolean()
, default:nil
) - Boolean flag that specifies whether the zone is active.allowedDomains
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ZoneAllowedDomains.t
, default:nil
) - 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.companyName
(type:String.t
, default:nil
) - Company associated with the zone.copyright
(type:String.t
, default:nil
) - Copyright information displayed on the sign in page for the zone to enable custom branding.created
(type:String.t
, default:nil
) - Time the zone was created in milliseconds since epoch.customEmailTemplates
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ZoneCustomEmailTemplates.t
, default:nil
) - 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
(type:list(GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CustomRegistrationField.t)
, default:nil
) - Customized fields used on user registration form.description
(type:String.t
, default:nil
) - Description of the zone.footerLinks
(type:map()
, default:nil
) - Mapping of display text to URL for forming hyperlinks used in the footer.hostWhitelistedDomains
(type:list(String.t)
, default:nil
) - 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.id
(type:String.t
, default:nil
) - ID of the zone.links
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ZoneLinks.t
, default:nil
) - Links in the UI used by the zone.manualApproval
(type:boolean()
, default:nil
) - Boolean flag that specifies whether manual approval of users is required.modified
(type:String.t
, default:nil
) - Time the zone was last modified in milliseconds since epoch.name
(type:String.t
, default:nil
) - Name of the zone.organization
(type:String.t
, default:nil
) - Apigee organization associated with the zone.portals
(type:list(String.t)
, default:nil
) - List of portals associated with the zone.productLogo
(type:String.t
, default:nil
) - Product logo PNG image (base64-encoded string).samlConfig
(type:map()
, default:nil
) - SAML configuration used by the zone.smtpConfig
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ZoneSmtpConfig.t
, default:nil
) - SMTP configuration for the zone.squareLogo
(type:String.t
, default:nil
) - Product logo PNG image (base64-encoded string).tokenPolicy
(type:GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ZoneTokenPolicy.t
, default:nil
) - Token policy for the zone.zoneId
(type:String.t
, default:nil
) - ID of the zone.
Link to this section Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Link to this section Types
Link to this type
t()
View Sourcet() :: %GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1Zone{ accountCreationEmail: String.t(), active: boolean(), allowedDomains: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ZoneAllowedDomains.t(), companyName: String.t(), copyright: String.t(), created: String.t(), customEmailTemplates: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ZoneCustomEmailTemplates.t(), customRegistrationFields: [ GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1CustomRegistrationField.t() ], description: String.t(), footerLinks: map(), hostWhitelistedDomains: [String.t()], id: String.t(), links: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ZoneLinks.t(), manualApproval: boolean(), modified: String.t(), name: String.t(), organization: String.t(), portals: [String.t()], productLogo: String.t(), samlConfig: map(), smtpConfig: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ZoneSmtpConfig.t(), squareLogo: String.t(), tokenPolicy: GoogleApi.Apigee.V1.Model.GoogleCloudApigeeV1ZoneTokenPolicy.t(), zoneId: String.t() }
Link to this section Functions
Unwrap a decoded JSON object into its complex fields.