Get Users Waiting for Group Key

Get

/api/v1/e2e.fetchUsersWaitingForGroupKey

Retrieves, for each of the specified encrypted rooms, the members who are waiting for the room's E2E key and have an E2E public key. Members who already have a room key or a suggested key are not returned, and the authenticated user is excluded. Up to 50 users are returned per room, and rooms with no waiting users are left out of the response.

If E2E encryption is disabled in the workspace, usersWaitingForE2EKeys is an empty object.

Changelog

Version	Description
6.10.0	Added

Header parameters

X-User-Id

stringRequired

The user ID.

ExampleCkCPNctrgCDfmWLqC

X-Auth-Token

stringRequired

The authentication token.

Example1Dd4iN_ClKn5jl-xPC36snQ4s9Zd5GZnXCQuCNSKcVE

Query parameters

roomIds

array of stringRequired

The IDs of the rooms to check. To check several rooms, repeat the parameter, for example roomIds=wCiXndNp5NqNY3uCc&roomIds=GENERAL.

Example[ "wCiXndNp5NqNY3uCc" ]

Responses

200

Success Example

{
  "usersWaitingForE2EKeys": {
    "wCiXndNp5NqNY3uCc": [
      {
        "_id": "XycfA5CetCPuEjqxw",
        "public_key": "{\"alg\":\"RSA-OAEP-256\",\"e\":\"AQAB\",\"ext\":true,\"key_ops\":[\"encrypt\"],\"kty\":\"RSA\",\"n\":\"oMO9ydjRxD3JzcAgMvyBZAc_pIOBIxOLVUChZ8mB3JNtLREC751hHT\"}"
      }
    ]
  },
  "success": true
}

Expand All

object

usersWaitingForE2EKeys

object

An object keyed by room ID. Each value lists the users waiting for that room's key.

property*

Array of object additionalProperties

object

_id

string

public_key

string

success

boolean

400

Bad Request

Invalid Params

{
  "success": false,
  "error": "must have required property 'roomIds'",
  "errorType": "error-invalid-params"
}

object

success

boolean

error

string

errorType

string

401

Unauthorized

Authorization Error

{
  "status": "error",
  "message": "You must be logged in to do this."
}

object

status

string

message

string

Was this article helpful?