Skip to end of metadata
Go to start of metadata

Returns the settings of the specified customer.

Method: GET

Fields

Name

Type

Description

INPUT


customer_id (Mandatory)


Integer

This field indicates the customer ID number

OUTPUT 

ad_sync

Boolean

This field indicates if AD sync capability is enabled or not

ad_sync_agent_version

String

This field indicates the version of the AD sync agent

ad_sync_agent_download_url

URL

This field indicates the URL used for downloading the AD sync agent

email_notifications

Boolean

This field indicates if email notifications will be sent when adding new user’s

web_security_agent_download_url

URL

This field indicates the URL used for downloading the web security agent

https_inspection

Boolean

This field indicates if HTTP inspection capability is enabled or not

ssl_certificate_url

URL

This field indicates the URL used for downloading the SSl certificate

mobile

Boolean

This field indicates if mobile capability is enabled or not

google_play_url

URL

This field indicates the URL used for downloading the Andriod application

ios_global_proxy_url

URL

This field indicates the URL used for downloading the global proxy settings for iOS

support_contact_email

Email

This field indicates the email for the support contact for the customer

Request Example
http -a <admin_email>:<admin_password> GET https://<host>/api/settings/<customer_id>/
Response Example
Code:  200 OK
Content: {
"ad_sync": true,
"ad_sync_agent_version": "2.0.7.00",
"ad_sync_agent_download_url":
"https://.../get_adsync_agent/5133a21ff/",
"email_notifications": true,
"web_security_agent_download_url": "https://.../pac_gen/proxy.pac",
"https_inspection": true,
"ssl_certificate_url": "https://.../organizations/ssl_download/",
"mobile": "true",
"google_play_url": "https://play.google.com/store...",
"ios_global_proxy_url": "https://.../files/globalproxy.mobileconfig",
 "support_contact_email": "support@hostname.com"
}


  • No labels