17 Microsoft Teams SBA
17.1 Get SBA configuration
GET https://<HOST>:<PORT>/api/sba/get?version=0
Returns the current Microsoft Teams SBA configuration
Required Permissions
-
API
-
Administration
Response Body Structure
The response body is structured as MsTeamsSbaOptions JSON object. A description for its fields is at section 30.22.1. For the JSON schema refer to section 30.22.2.
Example
17.2 Set SBA configuration.
PUT https://<HOST>:<PORT>/api/sba/set?version=0
Modifies the Microsoft Teams SBA configuration.
Required Permissions
-
API
-
Administration
Request Body Structure
The request body is structured as MsTeamsSbaOptions JSON object. A description for its fields is at section 30.22.1. For the JSON schema refer to section 30.22.2.
Response Body Structure
The response body is structured as MsTeamsSbaOptions JSON object. A description for its fields is at section 30.22.1. For the JSON schema refer to section 30.22.2.
Example
17.3 Enable SBA Services
POST https://<HOST>:<PORT>/api/sba/enable?version=0
Enables the Microsoft Teams SBA services.
Required Permissions
-
API
-
Administration
Example
17.4 Disable SBA Services
POST https://<HOST>:<PORT>/api/sba/disable?version=0
Disables the Microsoft Teams SBA services.
Required Permissions
-
API
-
Administration
Example
17.5 Get Status
GET https://<HOST>:<PORT>/api/sba/status/get?version=1
Returns the status of the Micosoft Teams SBA service
Required Permissions
-
API
-
Administration
Response Body Structure
The response body is structured as MsTeamsSbaStatus JSON object. A description for its fields is at section 30.23.1. For the JSON schema refer to section 30.23.2.
Example
17.6 Get Private Key
GET https://<HOST>:<PORT>/api/sba/privateKey/get?version=0
Returns the private key of the SBA service.
Required Permissions
-
API
-
Administration
Example
17.7 Set Private Key
PUT https://<HOST>:<PORT>/api/sba/privateKey/set?version=0
Sets a new private key to the SBA services.
Required Permissions
-
API
-
Administration
Request parameters
-
password
The password of the private key file.
Request Body Structure
The body must contain the file of the private key as "multipart/form-data".
Example
17.8 Get Certificate
GET https://<HOST>:<PORT>/api/sba/certificate/get?version=0
Returns the certificate of the SBA service.
Required Permissions
-
API
-
Administration
Example
17.9 Set Certificate
PUT https://<HOST>:<PORT>/api/sba/certificate/set?version=0
Sets a new certificate to the SBA services.
Required Permissions
-
API
-
Administration
Request parameters
-
password
The password of the certificate file.
Request Body Structure
The body must contain the certificate file as "multipart/form-data".
Example
17.10 Get Fingerprint
GET https://<HOST>:<PORT>/api/sba/fingerprint/get?version=0
Returns the currently configured fingerprint of the SBA service.
Required Permissions
-
API
-
Administration
Response Body Structure
The response body is structured as MsTeamsSbaFingerprint JSON object. A description for its fields is at section 30.24.1. For the JSON schema refer to section 30.24.2.
Example
17.11 Set Fingerprint
PUT https://<HOST>:<PORT>/api/sba/fingerprint/set?version=0
Sets a new fingerprint to the SBA service.
Required Permissions
-
API
-
Administration
Request Body Structure
The request body is structured as MsTeamsSbaFingerprint JSON object. A description for its fields is at section 30.24.1. For the JSON schema refer to section 30.24.2.
Response Body Structure
The response body is structured as MsTeamsSbaFingerprint JSON object. A description for its fields is at section 30.24.1. For the JSON schema refer to section 30.24.2.
Example
17.12 Get IP Address
GET https://<HOST>:<PORT>/api/sba/ipAddress/get?version=0
Returns the IP address of the SBA service.
Required Permissions
-
API
-
Administration
Example
17.13 Set IP Address
PUT https://<HOST>:<PORT>/api/sba/ipAddress/set?version=0
Sets the IP address of the SBA service.
Required Permissions
-
API
-
Administration
Request Body Structure
The body needs to contain the new IP address (e.g. "127.0.0.1").
Example
17.14 Get Identity
GET https://<HOST>:<PORT>/api/sba/identity/get?version=0
Returns the identity / FQDN of the SBA.
Required Permissions
-
API
-
Administration
Example
17.15 Set Identity
PUT https://<HOST>:<PORT>/api/sba/identity/set?version=0
Sets the identity / FQDN of the SBA.
Required Permissions
-
API
-
Administration
Request Body Structure
The body must contain the new Identity for the SBA service.
Example
17.16 Get TenantId
GET https://<HOST>:<PORT>/api/sba/tenantId/get?version=0
Returns the tenant id of the SBA service.
Required Permissions
-
API
-
Administration
Example
17.17 Set TenantId
PUT https://<HOST>:<PORT>/api/sba/tenantId/set?version=0
Sets the tenant id of the SBA service.
Required Permissions
-
API
-
Administration
Request Body Structure
The body must contain the new tenant id for the SBA service.
Example
17.18 Get Application
GET https://<HOST>:<PORT>/api/sba/application/get?version=0
Returns the application / client id of the SBA service.
Required Permissions
-
API
-
Administration
Example
17.19 Set Application
PUT https://<HOST>:<PORT>/api/sba/application/set?version=0
Sets the application / client id of the SBA service.
Required Permissions
-
API
-
Administration
Request Body Structure
The body must contain the application / client id for the SBA service.
Example
17.20 Set Secret
PUT https://<HOST>:<PORT>/api/sba/secret/set?version=0
Sets the application / client secret of the SBA service.
Required Permissions
-
API
-
Administration
Request Body Structure
The body must contain the application / client secret for the SBA service.
Example
17.21 Get Log
GET https://<HOST>:<PORT>/api/sba/log/get?version=0
Returns the logging options of the SBA service.
Required Permissions
-
API
-
Administration
Response Body Structure
The response body is structured as MsTeamsSbaLog JSON object. A description for its fields is at section 30.25.1. For the JSON schema refer to section 30.25.2.
Example
17.22 Set Log
PUT https://<HOST>:<PORT>/api/sba/log/set?version=0
Sets the logging options of the SBA service.
Required Permissions
-
API
-
Administration
Request Body Structure
The request body is structured as MsTeamsSbaLog JSON object. A description for its fields is at section 30.25.1. For the JSON schema refer to section 30.25.2.
Response Body Structure
The response body is structured as MsTeamsSbaLog JSON object. A description for its fields is at section 30.25.1. For the JSON schema refer to section 30.25.2.
Example
17.23 Get Users
GET https://<HOST>:<PORT>/api/sba/users/get?version=0
Returns a list of the Teams SBA users.
Required Permissions
-
API
-
Administration
Response Body Structure
The response body is strutured as an array. The array consists of MsTeamsSbaUser JSON objects. A description for its fields is at section 30.75.1. For the JSON schema refer to section 30.75.2.
17.24 Refresh Users
POST https://<HOST>:<PORT>/api/sba/users/refresh?version=0
Refreshes and returns the list of the Teams SBA users.
Required Permissions
-
API
-
Administration
Response Body Structure
The response body is strutured as an array. The array consists of MsTeamsSbaUser JSON objects. A description for its fields is at section 30.75.1. For the JSON schema refer to section 30.75.2.