[Index]

Model: relation/CustomerBuild-AddMicrosoftTenant-WFC_REL

CustomerBuild-AddMicrosoftTenant-WFC_REL

Model Details: relation/CustomerBuild-AddMicrosoftTenant-WFC_REL

Title Description Details
Name *
  • Field Name: name
  • Type: String
  • MaxLength: 1024
Relation Microsoft Tenant
  • Field Name: relation_MicrosoftTenant.[n]
  • Type: Array
  • Cardinality: [0..1]
Name * Microsoft Tenant user defined name can have a max length of 255 charactors within the following regex pattern - ^[a-zA-Z0-9-_ ]+$
  • Field Name: relation_MicrosoftTenant.[n].name
  • Type: String
  • MaxLength: 255
  • Pattern: ^[a-zA-Z0-9-_. ]+$
Description Microsoft Tenant user defined description can have a max length of 255 charactors.
  • Field Name: relation_MicrosoftTenant.[n].description
  • Type: String
  • MaxLength: 255
Host * Windows powershell host, serves as an intermediary between VOSS and Microsoft Teams, can be an IP address or a host name up to 255 charactors.
  • Field Name: relation_MicrosoftTenant.[n].hostName
  • Type: String
  • MaxLength: 255
Username * Windows powershell host service account.
  • Field Name: relation_MicrosoftTenant.[n].proxyUsername
  • Type: String
  • MaxLength: 255
Password * Windows powershell host password of the above service account.
  • Field Name: relation_MicrosoftTenant.[n].proxyPassword
  • Type: String
  • Is Password: True
  • Store Encrypted: True
  • MaxLength: 255
Powershell Deployment Mode Switch between running powershell scripts using a serverless function in the Azure cloud or an om-prem Windows host Default: onprem
  • Field Name: relation_MicrosoftTenant.[n].powershellDeploymentMode
  • Type: String
  • Default: onprem
  • MaxLength: 255
  • Choices: ["Cloud", "OnPrem"]
Authentication Method Type of authentication to use when interfacing to the external service.
  • Field Name: relation_MicrosoftTenant.[n].auth_method
  • Type: String
  • Choices: ["HTTP Basic Authentication", "OAuth(OApen Authorization)", "Session Based Authentication"]
Microsoft 365 sync on Create/Update Sync Microsoft 365 on Create and Update. When this checkbox is checked it will execute a full Pull Sync from the Microsoft 365.
  • Field Name: relation_MicrosoftTenant.[n].syncGraph
  • Type: Boolean
Client ID * The Client ID or Application ID located in the Azure AD app registration portal.
  • Field Name: relation_MicrosoftTenant.[n].client_id
  • Type: String
Tenant ID * The Tenant ID or Directory ID located in the Azure AD app registration portal.
  • Field Name: relation_MicrosoftTenant.[n].tenant_id
  • Type: String
Secret A Client secret previously created in the Azure AD app registration portal.
  • Field Name: relation_MicrosoftTenant.[n].client_secret
  • Type: String
  • Is Password: True
  • Store Encrypted: True
Certificate A locally stored certificate the public portion of which has been previously uploaded in the Azure AD app registration portal.
  • Field Name: relation_MicrosoftTenant.[n].certificate_bkey
  • Type: String
  • Target: data/Certificate
  • Format: uri
Enable Microsoft Exchange Enable Microsoft Exchange.
  • Field Name: relation_MicrosoftTenant.[n].enable_exchange
  • Type: Boolean
Certificate Thumbprint Certificate Thumbprint for a certificate which has been previously uploaded in the Azure AD app registration portal.
  • Field Name: relation_MicrosoftTenant.[n].graph_api_certificate_thumbprint
  • Type: String
Certificate Thumbprint Certificate Thumbprint for a certificate which has been previously uploaded in the Azure AD app registration portal.
  • Field Name: relation_MicrosoftTenant.[n].exchange_certificate_thumbprint
  • Type: String
  • Is Password: True
  • Store Encrypted: True
Microsoft Exchange sync on Create/Update Sync Microsoft Exchange on Create and Update. When this checkbox is checked it will execute a full Pull Sync from the Microsoft Exchange
  • Field Name: relation_MicrosoftTenant.[n].syncExchange
  • Type: Boolean
Admin Username * Username of an admin account used by VOSS to access Microsoft Teams.
  • Field Name: relation_MicrosoftTenant.[n].tenantUsername
  • Type: String
  • MaxLength: 255
Admin Password * Admin password of the above account
  • Field Name: relation_MicrosoftTenant.[n].tenantPassword
  • Type: String
  • Is Password: True
  • Store Encrypted: True
  • MaxLength: 255
Use HTTP Proxy Use Proxy is for when there is an internet proxy set up between the powershell server and the internet. Setting it to true will make the powershell script make use of it properly so that it can get to the MS cloud. There is another setting use_proxy_auth which comes into play only if use_proxy is true which will do additional configuration when the internet proxy requires auth Default: false
  • Field Name: relation_MicrosoftTenant.[n].use_proxy
  • Type: Boolean
  • Default: false
Version * MS Teams Version Default: 2019.1
  • Field Name: relation_MicrosoftTenant.[n].version
  • Type: String
  • Default: 2019.1
Microsoft Teams sync on Create/Update Sync Microsoft Teams on Create and Update. When this checkbox is checked it will execute a full Pull Sync from the Microsoft Teams
  • Field Name: relation_MicrosoftTenant.[n].syncTeams
  • Type: Boolean
Username Username for the proxy server through which the powershell host connects to the cloud.
  • Field Name: relation_MicrosoftTenant.[n].http_proxy_username
  • Type: String
  • MaxLength: 255
Password Password for the proxy server through which the powershell host connects to the cloud.
  • Field Name: relation_MicrosoftTenant.[n].http_proxy_password
  • Type: String
  • Is Password: True
  • Store Encrypted: True
  • MaxLength: 255
Use HTTP Proxy Authentication The proxy server through which the powershell server connects to the cloud requires credentials. Default: false
  • Field Name: relation_MicrosoftTenant.[n].use_http_proxy_auth
  • Type: Boolean
  • Default: false
Max page size for MsolUser Controls the number of records retrieved at a time from the device/msgraph/MSOLUser related API. Leaving it blank uses a default of 999 for optimal performance. Only modify this value if you encounter sync errors (e.g., 'Template output exceeded memory limit'), where you can specify a smaller value to resolve the issue. Note that reducing the value may affect sync performance, so use the largest value that doesn't cause errors.
  • Field Name: relation_MicrosoftTenant.[n].msol_user_api_page_size
  • Type: String
Max page size for Groups Governs the number of records fetched at once from the device/msgraph/Groups and device/msgraph/Teams related APIs. When left empty, it defaults to 999 for efficient performance. Adjust this value only if you encounter synchronization errors, like ('Template output exceeded memory limit.'). You can specify a smaller value to resolve errors, but be aware that reducing the value may impact sync performance, so use the largest suitable page size.
  • Field Name: relation_MicrosoftTenant.[n].groups_api_page_size
  • Type: String
MS 365 proxy Specifies an outbound internet proxy server for traffic to the public Internet when no authentication is required. The format should be (https://host:port/), and can include either a Fully Qualified Domain Name (FQDN) or an IP address for the Internet proxy.
  • Field Name: relation_MicrosoftTenant.[n].http_proxy
  • Type: String
  • Store Encrypted: True
MS 365 secure proxy Sets an outbound internet proxy server when authentication is required. The format should be (https://proxyuser:proxypassword@host:port/), and it allows secure access to the Internet proxy. You can use either a Fully Qualified Domain Name (FQDN) or an IP address for the Internet proxy.
  • Field Name: relation_MicrosoftTenant.[n].https_proxy
  • Type: String
  • Store Encrypted: True
Shadow
  • Field Name: shadow.[n]
  • Type: Array
  • Cardinality: [0..1]
Name *
  • Field Name: relation_MicrosoftTenant.[n].shadow.[n].name
  • Type: String
  • MaxLength: 1024