JaaS endpoints

The following endpoints are exposed by JaaS services for conference management options:

The endpoints require a JWT that contains the claim: admin: true. The JWT token has to be signed with a private key that has the corresponding public key uploaded in the jaas api-keys section of the console.

JWT payload example:

{
  "aud": "jitsi",
  "exp": 1696284052,
  "iss": "chat",
  "admin":true,
  "nbf": 1596197652,
  "sub": "vpaas-magic-cookie-1d2e6a201d594c8f87a630e3f71826d3"
}

• BAN_USER: ban an user based on the user id

  Endpoint: https://api-vo.jitsi.net/jaccess/v1/access-management/{appId}/ban/user/{userId}

  Path Variables:

  • appId: application Id
  • userId: user id to ban

  Request example:

  curl -X POST "https://api-vo.jitsi.net/jaccess/v1/access-management/vpaas-magic-cookie-831b6c556b2d43f4aa297930ebdfe188/ban/user/userIdValue" -H "accept: */*" -H "Authorization: Bearer eyJraWQiOiJ2cGFhcy1tYWdpYy1jb29raWUtODMxYjZjNTU2YjJkNDNmNGFhMjk3OTMwZWJkZmUxODgvMGEyMDBhIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJjb250ZXh0Ijp7InVzZXIiOnsiaWQiOiI3MzM2OWFhMi0xMDk1LTRmZDEtYmJhYi1hN2VhYmM1NjEzYzciLCJuYW1lIjoiYWJyYXR1IiwiYXZhdGFyIjoiaHR0cHM6Ly9mcmVlLWltYWdlcy5jb20vZGlzcGxheS9vY2Vhbl9yb2Nrc19zZWFfbmF0dXJlXzAuaHRtbCIsImVtYWlsIjoiYUBiLmNvbSIsIm1vZGVyYXRvciI6InRydWUifSwiZmVhdHVyZXMiOnsibGl2ZXN0cmVhbWluZyI6ImZhbHNlIiwidHJhbnNjcmlwdGlvbiI6InRydWUiLCJyZWNvcmRpbmciOiJ0cnVlIn19LCJhZG1pbiI6dHJ1ZSwicm9vbSI6IioiLCJzdWIiOiJ2cGFhcy1tYWdpYy1jb29raWUtODMxYjZjNTU2YjJkNDNmNGFhMjk3OTMwZWJkZmUxODgiLCJleHAiOjE2Mzc2NzIxNTMsImF1ZCI6ImppdHNpIiwiaXNzIjoiY2hhdCIsIm5iZiI6MTYzNzU4NTY5M30.BoawvRxUWF9y_nJolP2wFIgrUD8PrC2JpgiUic-_E49BKnECaMNaynmL_FMNT-fMFoUdvin8Wuc4T6GrCwgCXwe1ILxXtOon-A4PcKspgVx1zwQbROPtB04R2I29SycEv9UenGXae8RQhLyRWIURuFoyDWgdewquBIyGpCtX1n7nwbPluVls32twkYvljDgssl0kcGI0dqQbvx_pNdvcTfLSzoBgRo0Z-FHyFn4LZ_3tmLLvRsWL4VGDPenivsHhQ1UxgYGc-Rw13irZ6zghAY52JTYxN9-VqZVi4slNXU2z6tyZlc5HWHja5B0CTchoP4O5i1DydNZz1KOS5LY_SWZ-RV25sskea0uExzQX0qc7Z1zQGYkuqN2S13YPCIODuDwATqVGq00CaMj-GbdIFxnxu05fUVRj4utBX8ImzxWXpCft5VwN2nAAXZ_QrP0mB8lOIhv9QsN3MIBDWcWlh6VUBmXqrltV_cowUwJzjcnceROjp3H_JI6heQCc8vBxym96HH9mR8jkDVPjUVTjDBltx0KkpEAJRfzwvcJoJRyAvYzzXAYwv-l0EooesNLw_tr6rxBmBFdvCBbU0i-KToMCgB_BcdnFYQj2QlgnY86tKziqMtkkuK_cnxhwaZpBSdqubU-orR5WuyCNuH1cuxaAEku9EFzwlxo9486qWrg"
  

• BAN_JWT: ban a jwt

  Endpoint: https://api-vo.jitsi.net/jaccess/v1/access-management/{appId}/ban/jwt

  Path Variables:

  • appId: application Id

  Body (JSON)

  • jwt: jwt to ban

  Request example:

  curl -X POST "https://api-vo.jitsi.net/jaccess/v1/access-management/vpaas-magic-cookie-831b6c556b2d43f4aa297930ebdfe188/ban/jwt" -H "accept: */*" -H "Authorization: Bearer eyJraWQiOiJ2cGFhcy1tYWdpYy1jb29raWUtODMxYjZjNTU2YjJkNDNmNGFhMjk3OTMwZWJkZmUxODgvMGEyMDBhIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJjb250ZXh0Ijp7InVzZXIiOnsiaWQiOiI3MzM2OWFhMi0xMDk1LTRmZDEtYmJhYi1hN2VhYmM1NjEzYzciLCJuYW1lIjoiYWJyYXR1IiwiYXZhdGFyIjoiaHR0cHM6Ly9mcmVlLWltYWdlcy5jb20vZGlzcGxheS9vY2Vhbl9yb2Nrc19zZWFfbmF0dXJlXzAuaHRtbCIsImVtYWlsIjoiYUBiLmNvbSIsIm1vZGVyYXRvciI6InRydWUifSwiZmVhdHVyZXMiOnsibGl2ZXN0cmVhbWluZyI6ImZhbHNlIiwidHJhbnNjcmlwdGlvbiI6InRydWUiLCJyZWNvcmRpbmciOiJ0cnVlIn19LCJhZG1pbiI6dHJ1ZSwicm9vbSI6IioiLCJzdWIiOiJ2cGFhcy1tYWdpYy1jb29raWUtODMxYjZjNTU2YjJkNDNmNGFhMjk3OTMwZWJkZmUxODgiLCJleHAiOjE2Mzc2NzIxNTMsImF1ZCI6ImppdHNpIiwiaXNzIjoiY2hhdCIsIm5iZiI6MTYzNzU4NTY5M30.BoawvRxUWF9y_nJolP2wFIgrUD8PrC2JpgiUic-_E49BKnECaMNaynmL_FMNT-fMFoUdvin8Wuc4T6GrCwgCXwe1ILxXtOon-A4PcKspgVx1zwQbROPtB04R2I29SycEv9UenGXae8RQhLyRWIURuFoyDWgdewquBIyGpCtX1n7nwbPluVls32twkYvljDgssl0kcGI0dqQbvx_pNdvcTfLSzoBgRo0Z-FHyFn4LZ_3tmLLvRsWL4VGDPenivsHhQ1UxgYGc-Rw13irZ6zghAY52JTYxN9-VqZVi4slNXU2z6tyZlc5HWHja5B0CTchoP4O5i1DydNZz1KOS5LY_SWZ-RV25sskea0uExzQX0qc7Z1zQGYkuqN2S13YPCIODuDwATqVGq00CaMj-GbdIFxnxu05fUVRj4utBX8ImzxWXpCft5VwN2nAAXZ_QrP0mB8lOIhv9QsN3MIBDWcWlh6VUBmXqrltV_cowUwJzjcnceROjp3H_JI6heQCc8vBxym96HH9mR8jkDVPjUVTjDBltx0KkpEAJRfzwvcJoJRyAvYzzXAYwv-l0EooesNLw_tr6rxBmBFdvCBbU0i-KToMCgB_BcdnFYQj2QlgnY86tKziqMtkkuK_cnxhwaZpBSdqubU-orR5WuyCNuH1cuxaAEku9EFzwlxo9486qWrg" -H "Content-Type: application/json" -d "{ \"jwt\": \"eyJraWQiOiJ2cGFhcy1tYWdpYy1jb29raWUtODMxYjZjNTU2YjJkNDNmNGFhMjk3OTMwZWJkZmUxODgvMGEyMDBhIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJjb250ZXh0Ijp7InVzZXIiOnsiaWQiOiI3MzM2OWFhMi0xMDk1LTRmZDEtYmJhYi1hN2VhYmM1NjEzYzciLCJuYW1lIjoiYWJyYXR1IiwiYXZhdGFyIjoiaHR0cHM6Ly9mcmVlLWltYWdlcy5jb20vZGlzcGxheS9vY2Vhbl9yb2Nrc19zZWFfbmF0dXJlXzAuaHRtbCIsImVtYWlsIjoiYUBiLmNvbSIsIm1vZGVyYXRvciI6InRydWUifSwiZmVhdHVyZXMiOnsibGl2ZXN0cmVhbWluZyI6ImZhbHNlIiwidHJhbnNjcmlwdGlvbiI6InRydWUiLCJyZWNvcmRpbmciOiJ0cnVlIn19LCJhZG1pbiI6dHJ1ZSwicm9vbSI6IioiLCJzdWIiOiJ2cGFhcy1tYWdpYy1jb29raWUtODMxYjZjNTU2YjJkNDNmNGFhMjk3OTMwZWJkZmUxODgiLCJleHAiOjE2Mzc2NzIxNTMsImF1ZCI6ImppdHNpIiwiaXNzIjoiY2hhdCIsIm5iZiI6MTYzNzU4NTY5M30.BoawvRxUWF9y_nJolP2wFIgrUD8PrC2JpgiUic-_E49BKnECaMNaynmL_FMNT-fMFoUdvin8Wuc4T6GrCwgCXwe1ILxXtOon-A4PcKspgVx1zwQbROPtB04R2I29SycEv9UenGXae8RQhLyRWIURuFoyDWgdewquBIyGpCtX1n7nwbPluVls32twkYvljDgssl0kcGI0dqQbvx_pNdvcTfLSzoBgRo0Z-FHyFn4LZ_3tmLLvRsWL4VGDPenivsHhQ1UxgYGc-Rw13irZ6zghAY52JTYxN9-VqZVi4slNXU2z6tyZlc5HWHja5B0CTchoP4O5i1DydNZz1KOS5LY_SWZ-RV25sskea0uExzQX0qc7Z1zQGYkuqN2S13YPCIODuDwATqVGq00CaMj-GbdIFxnxu05fUVRj4utBX8ImzxWXpCft5VwN2nAAXZ_QrP0mB8lOIhv9QsN3MIBDWcWlh6VUBmXqrltV_cowUwJzjcnceROjp3H_JI6heQCc8vBxym96HH9mR8jkDVPjUVTjDBltx0KkpEAJRfzwvcJoJRyAvYzzXAYwv-l0EooesNLw_tr6rxBmBFdvCBbU0i-KToMCgB_BcdnFYQj2QlgnY86tKziqMtkkuK_cnxhwaZpBSdqubU-orR5WuyCNuH1cuxaAEku9EFzwlxo9486qWrg\"}"
  

• DESTROY_ROOM: Terminate an ongoing meeting

  Endpoint: https://api-vo.jitsi.net/conference-commands/v1/meeting

  Request type: POST

  Body (JSON):

  • action (string): Must have DESTROY value
  • conferenceFullName (string): The full name of the conference that is constructed using the following rule: [email protected]

  Note: The appId part from the conferenceFullName must be the same as the sub claim from the admin JWT.

    {
      "action": "DESTROY",
      "payload": {
        "conferenceFullName": "[email protected]70826d2.8x8.vc"
      }
    }
  

  Request example:

  curl -X 'POST' \
    'https://api-vo.jitsi.net/conference-commands/v1/meeting' \
    -H 'accept: */*' \
    -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsImtpZCI6InZwYWFzLW1hZ2ljLWNvb2tpZS04MzFiNmM1NTZiMmQ0M2Y0YWEyOTc5MzBlYmRmZTE4OC81YjEyMzQiLCJ0eXAiOiJKV1QifQ.eyJhdWQiOiJqaXRzaSIsImNvbnRleHQiOnsidXNlciI6eyJpZCI6IjExNDAyNTc1NDgyMDM3OTU5NTAzMCIsIm5hbWUiOiJ0ZXN0dXNlciIsImF2YXRhciI6Imh0dHBzOi8vZnJlZS1pbWFnZXMuY29tL2Rpc3BsYXkvb2NlYW5fcm9ja3Nfc2VhX25hdHVyZV8wLmh0bWwiLCJlbWFpbCI6InRlc3RAdXNlci5jb20iLCJtb2RlcmF0b3IiOiJ0cnVlIn0sImZlYXR1cmVzIjp7ImxpdmVzdHJlYW1pbmciOiJ0cnVlIiwicmVjb3JkaW5nIjoidHJ1ZSIsInRyYW5zY3JpcHRpb24iOiJ0cnVlIiwiZmxpcCI6dHJ1ZX19LCJleHAiOjE2Mzc2NzIxNTMsImlzcyI6ImNoYXQiLCJuYmYiOjE2Mzc1ODU2OTMsImFkbWluIjp0cnVlLCJyb29tIjoiKiIsInN1YiI6InZwYWFzLW1hZ2ljLWNvb2tpZS04MzFiNmM1NTZiMmQ0M2Y0YWEyOTc5MzBlYmRmZTE4OCJ9.KCbJt_jgD4j4rxam8DHRYy7B2IUf4jmuhHaQ_pb0bNxzubfCa61T0eWaTDEZ6xBKdG0J3nl7a_J42GDCM-Wo4WKSH2_PuIxzeaY4SEezjn5T9cKo-GdHLB2xpo9YNXdaYTAVdEObiuIfv0OHNDQNkNsEzmQnnlHyoSI51nsyk4NfXRpnuUPIRS4qCBLYLEQM-ZfztX5J5T_VpT9Z28ANX5S3sS0FChznxiZ-55vBP8GoSHM_hlMc3U3nP-jncREK0yR9AySkCNOcQj1aIkzHmZry6Jtazu1WcqtSZcUVyP2J7anHKc9U-JnWtxzXQQnm5MdfaatT3PhYu7W7PEO3hQfCdznoLlex0AYzDLtpwTzauSpY_b5QZJj6h8eEsw9_JLMItvBuA5XECXZY20iliwKd8_aojgM8gW18dLDkUIsNWS9Sp8GMxpNECDgtjMwk4G4Xmr7vWPTAb6TpRIL5Q2LDp4DGYjD3KbRJnWpDF_dBLwacD2ElTG04eIfDbehqmoSz_01O1WbjMpIYNDdqNgo5klKBxZlImQyvGSrawT7iBn7PVl1SlzNvR4mv5bgkAksxkXlEMOdS-WZJ-VxDsTTfHO-Vlqbh6PAXAhHkW8cD1puvcHT0pJdpu7tginIwgOfVsCcubbtTtYb0E9_-HN80_j3G_KKbJmZpxhUEtZw' \
    -H 'Content-Type: application/json' \
    -d '{
    "action": "DESTROY",
    "payload": {
      "conferenceFullName": "[email protected]70826d2.8x8.vc"
    }
  }'