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 27.20.1. For the JSON schema refer to section 27.20.2.

Example

GET http://127.0.0.1:8111/api/sba/get?version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "application": "",
  "log": {
    "level": "INFO",
    "directory": "./test",
    "maxArchiveFiles": 30
  },
  "identity": "",
  "tenantId": "",
  "fingerprint": {
    "source": "CUSTOM",
    "value": "2f8164f7-217b-4809-821d-73fc6ae71d0c"
  }
}

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 27.20.1. For the JSON schema refer to section 27.20.2.

Response Body Structure

The response body is structured as MsTeamsSbaOptions JSON object. A description for its fields is at section 27.20.1. For the JSON schema refer to section 27.20.2.

Example

PUT http://127.0.0.1:8110/api/sba/set?version=0
HTTP Request Body
{
  "application": "",
  "log": {
    "directory": "./test",
    "maxArchiveFiles": 0
  },
  "identity": "",
  "fingerprint": {
    "source": "CUSTOM",
    "value": "4e2d721b-73e7-4af8-9953-c910ece64299"
  },
  "tenantId": "",
  "secret": ""
}
HTTP Response Body
{
  "application": "",
  "log": {
    "level": "INFO",
    "directory": "./test",
    "maxArchiveFiles": 30
  },
  "identity": "",
  "tenantId": "",
  "fingerprint": {
    "source": "CUSTOM",
    "value": "4e2d721b-73e7-4af8-9953-c910ece64299"
  }
}

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

POST http://127.0.0.1:8110/api/sba/enable?version=0

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

POST http://127.0.0.1:8111/api/sba/disable?version=0
HTTP Response
HTTP/1.1 200 OK

17.5 Get Status

GET https://<HOST>:<PORT>/api/sba/status/get?version=0

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 27.21.1. For the JSON schema refer to section 27.21.2.

Example

GET http://127.0.0.1:8110/api/sba/status/get?version=0
HTTP Response Body
{
  "state": "waitingInitialParameters",
  "status": "warning"
}

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

Request parameters

  • filename

    The path to the file that will be imported.

Example

GET http://127.0.0.1:8111/api/sba/privateKey/get?version=0
HTTP Response
HTTP/1.1 200 OK

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.

  • filepath

    The path to the file that will be imported.

Request Body Structure

The body must contain the file of the private key.

Example

PUT http://127.0.0.1:8111/api/sba/privateKey/set?version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
    "pem": "-----BEGIN RSA PRIVATE KEY-----
MIIEogIBAAKCAQEAlp0FmyimgyAQUQm06In+YiIzXzcRo1U+8OzRkj0H5Z9ow9g4
z/w5Az1ArN7SmQ8rvZiWqKpgNlqJMIT0d4PGIJAxak5meNQfJidsZh9ly7iRhfRh
KyAj6lhPA6smRrNwS4f7WZC0tFpAsw9v9tRcWPqGR+vPzAegx30ctijSbAruJUSo
fiNbll4aVWSKDCGL1PFdgRRE1wnKvwk/OmiKldliV8rWANDf+TAlE/9kJ/ro7zpN
CiC6opidYh4MYhx+gje6SQD20Bp7pWbrWpwQEl8Zq/ra5x3qLrCY9kiN5WdldaM8
Qul7j3Ok11N6104NG4mda5JgH066emx/o0irhQIDAQABAoIBAAVIjtjJjUXOSyQ8
ne8GYDkbEAhIC0NaizGybQufPnasp+Uu4ZdSNsHJVUp7KpIZ+SPWhXp3N5bQiD1+
fIDwy3N6+3DKPUgB0PHqsh/G/DAwUlKLpxj3MKtY27S6PUZ/pvHPXF7g96XYAKsH
YJsdCfxJFYrSV+DFZ7t3xRkSx4bosXkgm0FAd9GNaWDP4PTyH77BHWC0xr40Rx7+
9HJN80utBEBPGtIiWbuyUCRmrKohrA7j9mecScnZYEw8ntJebrETW+kGRUDCuMzT
i1aU14t346LqF24U7GtY1kLolW/3+f+IoJm2WGUoNgc+8mDvJ2hlx2i5+PbYIV25
oo5Kh+UCgYEAxUkQ9kMyilTtROM3p+gCm0pWNOf/pQFZrrDj/N83TuV+9ZZVy8ES
c4FtoFUCMMyNrYynckrG5n6eYFJKhdYV8BI7yoLa/wIx2bsXj5PqlU+hO7jQMPfV
/rCLfWA4iDMjNF76CW5HykaDk7C1+zVWfodCiaexwy49Bep3rbU1fwcCgYEAw3AR
zWqE6KMuzy9ySCjmaCXY8dUVIZAXEx3We8kNpRH5jlkUe5RaVRQYDi/r0oB4PBoU
qK+vMRrUBzXOghgUPvyBcz0qDqDQS45LVNu4CQj0+ZZUKPgJ1zJJAcfawdIts8KF
GvaZqcSxzNc5NicybKqjhYLqjtH9v++4Nn1gUhMCgYBJs3Edvp7L5Mw61vN8y4Tl
xJCN9Tmgx+9b/oM9fZoo5D1Yu8/TbY5aDjkJE5jc6B3pfskzPlIt25GJBFUIyKCr
bfReRCJR79z1rRoxLh4Np5DhQbqtAHk2S3fg36he4VO+hdi82zEAlPUkoHhrn1Jv
tFIcIMSc2NI9Ool5IGAa0wKBgG2yTLvAyyMM3Ow71Gh+VH0mqTNsB7VT/C+lssq+
GeOKSEnG5EFNDrrsUWg9K592roYFmYzpN2tXhKUbZXMN8uc7sakuLpoRV3jhQJU7
0nt3xJEG+OwZ9OQN/H58X+QkhbR9PVraCXwJxEaWky07KQlnaes5hVBuu3/tHLew
/cxzAoGAdHp4g4Ml1H5JYMBDXO5DkZ7zLaI6TH6SpHVwqi565k3xdi3/NRTkFC/V
8OKEFLL9hieSigTcgo1riyfFDZMGOUhW3qXImzyEAyKYD3Bp1cDIkKO+omk+G+v9
F7mOIjwvbrPVR53oejFhUjVGiz8Bv2d3K7FqLsCP+bqJj+iFDSk=
-----END RSA PRIVATE KEY-----
"
}

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

Request parameters

Example

GET http://127.0.0.1:8111/api/sba/certificate/get?version=0
HTTP Response
HTTP/1.1 200 OK

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.

  • filepath

    The path to the file that will be imported.

Request Body Structure

The body must contain the certificate file.

Example

PUT http://127.0.0.1:8111/api/sba/certificate/set?version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
    "pem": "-----BEGIN CERTIFICATE-----
MIIDRjCCAi6gAwIBAgIICKL1N6x8IoQwDQYJKoZIhvcNAQELBQAwFDESMBAGA1UE
AxMJdGVzdC5jZXJ0MB4XDTIzMDcwNTEyNTgwMFoXDTI0MDcwNDEyNTgwMFowFDES
MBAGA1UEAxMJdGVzdC5jZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKC
AQEAlp0FmyimgyAQUQm06In+YiIzXzcRo1U+8OzRkj0H5Z9ow9g4z/w5Az1ArN7S
mQ8rvZiWqKpgNlqJMIT0d4PGIJAxak5meNQfJidsZh9ly7iRhfRhKyAj6lhPA6sm
RrNwS4f7WZC0tFpAsw9v9tRcWPqGR+vPzAegx30ctijSbAruJUSofiNbll4aVWSK
DCGL1PFdgRRE1wnKvwk/OmiKldliV8rWANDf+TAlE/9kJ/ro7zpNCiC6opidYh4M
Yhx+gje6SQD20Bp7pWbrWpwQEl8Zq/ra5x3qLrCY9kiN5WdldaM8Qul7j3Ok11N6
104NG4mda5JgH066emx/o0irhQIDAQABo4GbMIGYMAwGA1UdEwEB/wQCMAAwHQYD
VR0OBBYEFFgJQMmaiZdLkxGQfErjpVivPBj8MAsGA1UdDwQEAwID6DATBgNVHSUE
DDAKBggrBgEFBQcDATAUBgNVHREEDTALggl0ZXN0LmNlcnQwEQYJYIZIAYb4QgEB
BAQDAgZAMB4GCWCGSAGG+EIBDQQRFg94Y2EgY2VydGlmaWNhdGUwDQYJKoZIhvcN
AQELBQADggEBAEv09qpCxyDrvGXQG4M94En7U5dsSd7XijBHlO8+gnn/HqBqgqE+
JxB9fBx+WI+6ubQ/wwNvvx/FRyJ3ixU7sFj/jWDuqs1g4XPwXN72nMqxp/s5Sotd
vQ4tb8khu7nBh489DJJe7+ijy4NS06YuCh0eplamkYfSXxgQlHxLbDFLxWwWPriQ
00FDsBvHZ8q+Qqr8YQIdONKgUocR3mNhCa2li+14AxSZ7ksTFRUO6qc4UbOYmfMU
GgEUKLP9DqpSMdrf0yySPGlHpeLIbE4bLnhY3gg1tyfk6LjIHKSpTNy9eIwpG51B
ylfki4qQ9ck7HxOhZH53qbiXlpwUl0l26t4=
-----END CERTIFICATE-----
"
}

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 27.22.1. For the JSON schema refer to section 27.22.2.

Example

GET http://127.0.0.1:8110/api/sba/fingerprint/get?version=0
HTTP Response Body
{
  "source": "CUSTOM",
  "value": "d7006346-5e68-49b2-8341-fa0882e30c44"
}

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 27.22.1. For the JSON schema refer to section 27.22.2.

Response Body Structure

The response body is structured as MsTeamsSbaFingerprint JSON object. A description for its fields is at section 27.22.1. For the JSON schema refer to section 27.22.2.

Example

PUT http://127.0.0.1:8111/api/sba/fingerprint/set?version=0
HTTP Request Body
{
  "source": "CUSTOM",
  "value": "fc56c95d-a379-46f8-b1d3-8113791242ff"
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "source": "CUSTOM",
  "value": "fc56c95d-a379-46f8-b1d3-8113791242ff"
}

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

GET http://127.0.0.1:8111/api/sba/ipAddress/get?version=0
HTTP Response
HTTP/1.1 200 OK

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

PUT http://127.0.0.1:8110/api/sba/ipAddress/set?version=0
HTTP Request Body
127.0.0.1
HTTP Response Body
127.0.0.1

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

GET http://127.0.0.1:8110/api/sba/identity/get?version=0

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

PUT http://127.0.0.1:8111/api/sba/identity/set?version=0
HTTP Request Body
testIdentity
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
testIdentity

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

GET http://127.0.0.1:8110/api/sba/tenantId/get?version=0
HTTP Response Body
6d813f04-3832-4323-94ab-763e87746984

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

PUT http://127.0.0.1:8111/api/sba/tenantId/set?version=0
HTTP Request Body
6d813f04-3832-4323-94ab-763e87746984
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
6d813f04-3832-4323-94ab-763e87746984

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

GET http://127.0.0.1:8110/api/sba/application/get?version=0
HTTP Response Body
e60f1f2a-f24a-4f70-a9bd-f2f062024588

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

PUT http://127.0.0.1:8111/api/sba/application/set?version=0
HTTP Request Body
ef4a0ba4-f42b-46a4-93ca-49b1aa462549
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
ef4a0ba4-f42b-46a4-93ca-49b1aa462549

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

PUT http://127.0.0.1:8111/api/sba/secret/set?version=0
HTTP Request Body
bcf4ed11-f996-4609-8bbc-3bc4e4f95e87
HTTP Response
HTTP/1.1 200 OK

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 27.23.1. For the JSON schema refer to section 27.23.2.

Example

GET http://127.0.0.1:8111/api/sba/log/get?version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "level": "INFO",
  "directory": "./test",
  "maxArchiveFiles": 30
}

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 27.23.1. For the JSON schema refer to section 27.23.2.

Response Body Structure

The response body is structured as MsTeamsSbaLog JSON object. A description for its fields is at section 27.23.1. For the JSON schema refer to section 27.23.2.

Example

PUT http://127.0.0.1:8110/api/sba/log/set?version=0
HTTP Request Body
{
  "level": "FATAL",
  "directory": "",
  "maxArchiveFiles": 24
}
HTTP Response Body
{
  "level": "FATAL",
  "directory": "",
  "maxArchiveFiles": 24
}

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 27.61.1. For the JSON schema refer to section 27.61.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 27.61.1. For the JSON schema refer to section 27.61.2.