[Index]
This relation implements the workflows to manage Microsoft Tenant connection parameters and enabled services.
Model ref.: relation/MicrosoftTenant
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": { "http_proxy_password": { "is_password": true, "description": "Password for the proxy server through which the powershell host connects to the cloud.", "title": "Password", "required": false, "readonly": false, "maxLength": 255, "store_encrypted": true, "type": "string" }, "hostName": { "maxLength": 255, "required": true, "type": "string", "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.", "title": "Host" }, "tenantPassword": { "is_password": true, "description": "Admin password of the above account", "title": "Admin Password", "required": true, "readonly": false, "maxLength": 255, "store_encrypted": true, "type": "string" }, "syncExchange": { "default": false, "type": "boolean", "description": "Sync Microsoft Exchange on Create and Update. When this checkbox is checked it will execute a full Pull Sync from the Microsoft Exchange", "title": "Microsoft Exchange sync on Create/Update" }, "use_proxy": { "default": "false", "type": "boolean", "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", "title": "Use HTTP Proxy" }, "syncTeams": { "default": false, "type": "boolean", "description": "Sync Microsoft Teams on Create and Update. When this checkbox is checked it will execute a full Pull Sync from the Microsoft Teams", "title": "Microsoft Teams sync on Create/Update" }, "proxyPassword": { "is_password": true, "description": "Windows powershell host password of the above service account.", "title": "Password", "required": true, "maxLength": 255, "store_encrypted": true, "type": "string" }, "enable_exchange": { "default": false, "type": "boolean", "description": "Enable Microsoft Exchange.", "title": "Enable Microsoft Exchange" }, "version": { "default": "2019.1", "required": true, "type": "string", "description": "MS Teams Version", "title": "Version" }, "syncGraph": { "default": false, "type": "boolean", "description": "Sync Microsoft 365 on Create and Update. When this checkbox is checked it will execute a full Pull Sync from the Microsoft 365.", "title": "Microsoft 365 sync on Create/Update" }, "certificate_thumbprint": { "is_password": true, "description": "Certificate Thumbprint use for Microsoft Exchange connectivity.", "title": "Certificate Thumbprint", "required": false, "readonly": false, "store_encrypted": true, "type": "string" }, "description": { "title": "Description", "type": "string", "description": "Microsoft Tenant user defined description can have a max length of 255 charactors.", "maxLength": 255 }, "tenantUsername": { "description": "Username of an admin account used by VOSS to access Microsoft Teams.", "title": "Admin Username", "required": true, "displayable": false, "readonly": false, "maxLength": 255, "type": "string" }, "proxyUsername": { "is_password": false, "description": "Windows powershell host service account.", "title": "Username", "required": true, "maxLength": 255, "type": "string" }, "client_id": { "is_password": false, "description": "The Client ID or Application ID assigned by the Azure app registration portal.", "title": "Client ID", "required": true, "displayable": false, "readonly": false, "type": "string" }, "shadow": { "items": { "type": "object", "properties": { "name": { "is_password": false, "title": "Name", "required": true, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" } } }, "type": "array", "maxItems": 1, "title": "Shadow" }, "auth_method": { "choices": [ { "value": "BASIC", "title": "HTTP Basic Authentication" }, { "value": "OAUTH", "title": "OAuth(OApen Authorization)" }, { "value": "SESSION", "title": "Session Based Authentication" } ], "required": false, "type": "string", "description": "Type of authentication to use when interfacing to the external service.", "title": "Authentication Method" }, "name": { "description": "Microsoft Tenant user defined name can have a max length of 255 charactors within the following regex pattern - ^[a-zA-Z0-9-_ ]+$", "title": "Name", "pattern": "^[a-zA-Z0-9-_. ]+$", "required": true, "maxLength": 255, "type": "string" }, "tenant_id": { "is_password": false, "description": "Your Microsoft 365 tenant ID is a globally unique identifier (GUID) that is different than your organization name or domain. You may need this identifier when you configure OneDrive policies. Your tenant ID can be found in the Tenant ID box on the Properties page.", "title": "Tenant ID", "required": true, "displayable": false, "readonly": false, "type": "string" }, "use_http_proxy_auth": { "default": "false", "type": "boolean", "description": "The proxy server through which the powershell server connects to the cloud requires credentials.", "title": "Use HTTP Proxy Authentication" }, "client_secret": { "is_password": true, "description": "A Client (application) Secret, either a password or a public/private key pair (certificate).", "title": "Secret", "required": true, "readonly": false, "store_encrypted": true, "type": "string" }, "http_proxy_username": { "displayable": false, "maxLength": 255, "type": "string", "description": "Username for the proxy server through which the powershell host connects to the cloud.", "title": "Username" } }, "schema_version": "0.1" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/relation/MicrosoftTenant/add/ |
|
The GUI Add form of relation/MicrosoftTenant 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/MicrosoftTenant/ | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk delete [pkid1],[pkid2]... | DELETE | /api/relation/MicrosoftTenant/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/MicrosoftTenant/[pkid1]", "/api/relation/MicrosoftTenant/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/MicrosoftTenant/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/MicrosoftTenant; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/MicrosoftTenant/export/ |
|
{ "hrefs":["/api/relation/MicrosoftTenant/[pkid1]", "/api/relation/MicrosoftTenant/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip Content-Language:en Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of relation/MicrosoftTenant and the JSON format can be used to import instances of relation/MicrosoftTenant.
GET http://[host-proxy]/api/relation/MicrosoftTenant/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for relation/MicrosoftTenant | POST | /api/relation/MicrosoftTenant/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Configuration Template | GET | /api/relation/MicrosoftTenant/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/relation/MicrosoftTenant/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/relation/MicrosoftTenant/ |
|
The relation/MicrosoftTenant schema and all instances as JSON. |
(The list will return 0 to 3 relation/MicrosoftTenant instances)
{ "operations": [ "field_display_policy", "configuration_template", "help", "get", "export_bulkload_template", "list", "update", "remove", "add", "bulk_update", "export" ], "pagination": { "direction": "asc", "order_by": "name", "maximum_limit": 2000, "skip": 0, "current": "/api/relation/MicrosoftTenant/?skip=0&limit=3&order_by=name&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 0 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": {}, "schema_version": "0.1", "references": { "device": [ { "pkid": "", "href": "" } ], "self": [ { "pkid": null, "href": "/api/relation/MicrosoftTenant/None/" } ], "children": [], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "add": { "support_async": false, "class": "add", "href": "/api/relation/MicrosoftTenant/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/relation/MicrosoftTenant/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/relation/MicrosoftTenant/export/?hierarchy=[hierarchy]", "method": "POST", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "export_bulkload_template": { "support_async": false, "class": "bulkload_template", "href": "/api/relation/MicrosoftTenant/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/relation/MicrosoftTenant/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/relation/MicrosoftTenant/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/relation/MicrosoftTenant/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/relation/MicrosoftTenant/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } } ], "model_type": "relation/MicrosoftTenant", "model_specific_actions": [ "field_display_policy", "configuration_template", "help", "get", "export_bulkload_template", "list", "update", "remove", "add", "export" ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "description", "title": "Description" }, { "name": "hostName", "title": "Host" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "resources": [] }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for relation/MicrosoftTenant. | GET | /api/relation/MicrosoftTenant/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/MicrosoftTenant as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/relation/MicrosoftTenant/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/relation/MicrosoftTenant/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a selected [export_format] of the schema and a single instance with [pkid] of relation/MicrosoftTenant; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/MicrosoftTenant/[pkid]/export/ |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip Content-Language:en Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of relation/MicrosoftTenant and the JSON format can be used to import instances of relation/MicrosoftTenant.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/relation/MicrosoftTenant/[pkid]/ | hierarchy=[hierarchy] | The relation/MicrosoftTenant instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/relation/MicrosoftTenant/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/MicrosoftTenant. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Sync All | POST | /api/relation/MicrosoftTenant/[pkid]/+SyncAll/ | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Test Connection | POST | /api/relation/MicrosoftTenant/[pkid]/+TestConnection/ | hierarchy=[hierarchy] | If payload required: |