[Index]
CustomerBuild-UpdateMicrosoftTenantConnection-WFC_REL
Model ref.: relation/CustomerBuild-UpdateMicrosoftTenantConnection-WFC_REL
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"name": {
"is_password": false,
"title": "Name",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"relation_MicrosoftTenant": {
"title": "Relation Microsoft Tenant",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "Microsoft Tenant user defined name can have a max length of 255 charactors within the following regex pattern - ^[a-zA-Z0-9-_ ]+$",
"type": "string",
"maxLength": 255,
"required": true,
"pattern": "^[a-zA-Z0-9-_. ]+$"
},
"description": {
"title": "Description",
"description": "Microsoft Tenant user defined description can have a max length of 255 charactors.",
"type": "string",
"maxLength": 255
},
"hostName": {
"title": "Host",
"description": "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.",
"type": "string",
"maxLength": 255,
"required": true
},
"proxyUsername": {
"title": "Username",
"description": "Windows powershell host service account.",
"type": "string",
"maxLength": 255,
"required": true,
"is_password": false
},
"proxyPassword": {
"title": "Password",
"description": "Windows powershell host password of the above service account.",
"type": "string",
"maxLength": 255,
"required": true,
"is_password": true,
"store_encrypted": true
},
"powershellDeploymentMode": {
"title": "Powershell Deployment Mode",
"description": "Switch between running powershell scripts using a serverless function in the Azure cloud or an om-prem Windows host",
"type": "string",
"maxLength": 255,
"is_password": false,
"default": "onprem",
"choices": [
{
"value": "cloud",
"title": "Cloud"
},
{
"value": "onprem",
"title": "OnPrem"
}
]
},
"syncGraph": {
"title": "Microsoft 365 sync on Create/Update",
"description": "Sync Microsoft 365 on Create and Update. When this checkbox is checked it will execute a full Pull Sync from the Microsoft 365.",
"type": "boolean",
"default": false
},
"client_id": {
"title": "Client ID",
"description": "The Client ID or Application ID located in the Azure AD app registration portal.",
"type": "string",
"required": true,
"readonly": false,
"is_password": false,
"displayable": false
},
"tenant_id": {
"title": "Tenant ID",
"description": "The Tenant ID or Directory ID located in the Azure AD app registration portal.",
"type": "string",
"required": true,
"readonly": false,
"is_password": false,
"displayable": false
},
"client_secret": {
"title": "Secret",
"description": "A Client secret previously created in the Azure AD app registration portal. Not used for Exchange.",
"type": "string",
"required": false,
"readonly": false,
"is_password": true,
"store_encrypted": true
},
"certificate_bkey": {
"title": "Certificate (deprecated)",
"description": "A locally stored certificate the public portion of which has been previously uploaded in the Azure AD app registration portal.",
"type": "string"
},
"certificate_pkid": {
"title": "Certificate",
"description": "A locally stored certificate the public portion of which has been previously uploaded in the Azure AD app registration portal.",
"type": "string"
},
"enable_exchange": {
"title": "Enable Microsoft Exchange",
"description": "Enable Microsoft Exchange.",
"type": "boolean",
"default": false
},
"exchange_admin_domain": {
"title": "Admin Domain",
"description": "Microsoft Exchange admin domain used to authenticate.",
"type": "string"
},
"graph_api_certificate_thumbprint": {
"title": "Graph Certificate Thumbprint (deprecated)",
"description": "Certificate Thumbprint for a certificate which has been previously uploaded in the Azure AD app registration portal. Deprecated.",
"type": "string",
"required": false,
"readonly": false
},
"exchange_certificate_thumbprint": {
"title": "Exchange Certificate Thumbprint (deprecated)",
"description": "Certificate Thumbprint for a certificate which has been previously uploaded in the Azure AD app registration portal. Deprecated.",
"type": "string",
"required": false,
"readonly": false,
"is_password": true,
"store_encrypted": true
},
"certificate_thumbprint": {
"title": "Certificate Thumbprint",
"description": "Certificate Thumbprint for a certificate which has been previously uploaded in the Azure AD app registration portal. Required for Exchange.",
"type": "string"
},
"syncExchange": {
"title": "Microsoft Exchange sync on Create/Update",
"description": "Sync Microsoft Exchange on Create and Update. When this checkbox is checked it will execute a full Pull Sync from the Microsoft Exchange",
"type": "boolean",
"default": false
},
"tenantUsername": {
"title": "Admin Username",
"description": "Username of an admin account used by VOSS to access Microsoft Teams. Required to use device models which do not support application authentication.",
"type": "string",
"maxLength": 255,
"required": false,
"readonly": false,
"displayable": false
},
"tenantPassword": {
"title": "Admin Password",
"description": "Admin password of the above account. Required to use device models which do not support application authentication.",
"type": "string",
"maxLength": 255,
"required": false,
"readonly": false,
"is_password": true,
"store_encrypted": true
},
"use_proxy": {
"title": "Use HTTP Proxy",
"description": "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",
"type": "boolean",
"default": "false"
},
"syncTeams": {
"title": "Microsoft Teams sync on Create/Update",
"description": "Sync Microsoft Teams on Create and Update. When this checkbox is checked it will execute a full Pull Sync from the Microsoft Teams",
"type": "boolean",
"default": false
},
"http_proxy_username": {
"title": "Username",
"description": "Username for the proxy server through which the powershell host connects to the cloud.",
"type": "string",
"maxLength": 255,
"displayable": false
},
"http_proxy_password": {
"title": "Password",
"description": "Password for the proxy server through which the powershell host connects to the cloud.",
"type": "string",
"maxLength": 255,
"required": false,
"readonly": false,
"is_password": true,
"store_encrypted": true
},
"use_http_proxy_auth": {
"title": "Use HTTP Proxy Authentication",
"description": "The proxy server through which the powershell server connects to the cloud requires credentials.",
"type": "boolean",
"default": "false"
},
"msol_user_api_page_size": {
"title": "Max page size for MsolUser",
"description": "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.",
"type": "string"
},
"groups_api_page_size": {
"title": "Max page size for Groups",
"description": "Governs the number of records fetched at once from the device/msgraph/Group 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.",
"type": "string"
},
"http_proxy": {
"title": "MS 365 proxy",
"description": "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.",
"type": "string",
"store_encrypted": true
},
"https_proxy": {
"title": "MS 365 secure proxy",
"description": "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.",
"type": "string",
"store_encrypted": true
},
"resourceAccountBasicAuthEnabled": {
"title": "Resource Account Basic Authentication",
"description": "Enable basic authentication for resource accounts",
"type": "boolean",
"default": false
},
"shadow": {
"title": "Shadow",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"is_password": false,
"title": "Name",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"maxItems": 1
}
}
},
"maxItems": 1
}
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/CustomerBuild-UpdateMicrosoftTenantConnection-WFC_REL/add/ |
|
The GUI Add form of relation/CustomerBuild-UpdateMicrosoftTenantConnection-WFC_REL as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Create | POST | /api/relation/CustomerBuild-UpdateMicrosoftTenantConnection-WFC_REL | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/CustomerBuild-UpdateMicrosoftTenantConnection-WFC_REL | POST | /api/relation/CustomerBuild-UpdateMicrosoftTenantConnection-WFC_REL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/CustomerBuild-UpdateMicrosoftTenantConnection-WFC_REL/ |
|
The relation/CustomerBuild-UpdateMicrosoftTenantConnection-WFC_REL schema and all instances as JSON. |
(The list will return 0 to 3 relation/CustomerBuild-UpdateMicrosoftTenantConnection-WFC_REL instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/relation/CustomerBuild-UpdateMicrosoftTenantConnection-WFC_REL/?skip=0&limit=3&order_by=name&direction=asc&traversal=fulltree"
},
"operations": [
"update",
"field_display_policy",
"remove",
"help",
"add",
"export",
"list",
"configuration_template",
"get",
"bulk_update",
"export_bulkload_template"
],
"meta": {
"model_type": "relation/CustomerBuild-UpdateMicrosoftTenantConnection-WFC_REL",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": [],
"self": [
{
"href": "/api/relation/CustomerBuild-UpdateMicrosoftTenantConnection-WFC_REL/None/",
"pkid": null
}
]
},
"model_specific_actions": [
"get",
"update",
"remove",
"add",
"export_bulkload_template",
"export",
"list"
],
"schema_version": null,
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/relation/CustomerBuild-UpdateMicrosoftTenantConnection-WFC_REL/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/relation/CustomerBuild-UpdateMicrosoftTenantConnection-WFC_REL/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/relation/CustomerBuild-UpdateMicrosoftTenantConnection-WFC_REL/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/CustomerBuild-UpdateMicrosoftTenantConnection-WFC_REL/[pkid] | hierarchy=[hierarchy] | The relation/CustomerBuild-UpdateMicrosoftTenantConnection-WFC_REL instance with [pkid]. |