[Index]

Model: relation/CustomerBuild-AddCiscoWebexApp-WFC_REL

CustomerBuild-AddCiscoWebexApp-WFC_REL

Model Details: relation/CustomerBuild-AddCiscoWebexApp-WFC_REL

Title Description Details
Name *
  • Field Name: name
  • Type: String
  • MaxLength: 1024
Relation Spark Customer
  • Field Name: relation_SparkCustomer.[n]
  • Type: Array
  • Cardinality: [0..1]
Customer Name * Name of this customer
  • Field Name: relation_SparkCustomer.[n].name
  • Type: String
Organization Account Number This can be found when logging into the Webex Control Hub portal under the Account menu. E.g. 000fd0e4-83ef-d398-be23-d06998580fed
  • Field Name: relation_SparkCustomer.[n].account_number_external
  • Type: String
Admin Account Email This is the email address of the account used to generate the access token.
  • Field Name: relation_SparkCustomer.[n].account_email
  • Type: String
Organization Account Number (Internal) This is the internal API id for the organization. This is automatically resolved from the external account number.
  • Field Name: relation_SparkCustomer.[n].account_number
  • Type: String
Default Calling Behaviour This is the default calling behaviour for the organization.
  • Field Name: relation_SparkCustomer.[n].default_calling_behaviour
  • Type: String
  • Choices: ["Calling in Webex App", "Calling in Webex App (Unified CM)", "Cisco Jabber app", "Third-Party app"]
Email Domain for Hybrid Calling in Workspaces This is the email domain that will be used when creating a Unified CM user associated with a Workspace in Webex App Control Hub for hybrid calling.
  • Field Name: relation_SparkCustomer.[n].email_domain
  • Type: String
Directory Synchronization Enabled This setting must be enabled if the Organization has been enabled for Directory Synchronization on the Webex Control Hub side.
  • Field Name: relation_SparkCustomer.[n].dirsync_enabled
  • Type: Boolean
Please Note Field to display notes to the user.
  • Field Name: relation_SparkCustomer.[n].notes
  • Type: String
Authorize Webex This is the link to initiate the Webex OAuth flow to obtain tokens.
  • Field Name: relation_SparkCustomer.[n].token_link
  • Type: String
  • Format: link
Admin Access Token This is the Access Token provided when logging into Webex App Developer portal. This token is valid for 14 days. The Refresh token can be used to generate a new Access Token.
  • Field Name: relation_SparkCustomer.[n].token
  • Type: String
  • Is Password: True
Refresh Token This is the Refresh Token provided when logging into Webex App Developer portal. This token will be used to create a new access token. The refresh token is valid for 90 dyas.
  • Field Name: relation_SparkCustomer.[n].refresh_token
  • Type: String
  • Is Password: True
Access Token Expires At Time when the Access Token will expire.
  • Field Name: relation_SparkCustomer.[n].access_token_expires
  • Type: String
Refresh Token Expires At Time when the Refresh Token will expire.
  • Field Name: relation_SparkCustomer.[n].refresh_token_expires
  • Type: String
HTTP Proxy String HTTP Proxy string e.g. http://10.10.10.10:8123
  • Field Name: relation_SparkCustomer.[n].http_proxy
  • Type: String
HTTPS Proxy String HTTPS Proxy string e.g. https://10.10.10.10:8123
  • Field Name: relation_SparkCustomer.[n].https_proxy
  • Type: String
  • Is Password: True
  • Store Encrypted: True
Sync on Create Sync this organization's roles and licenses from Control Hub on creation.
  • Field Name: relation_SparkCustomer.[n].sync
  • Type: Boolean
Shadow
  • Field Name: shadow.[n]
  • Type: Array
  • Cardinality: [0..1]
Name *
  • Field Name: relation_SparkCustomer.[n].shadow.[n].name
  • Type: String
  • MaxLength: 1024