Get Users of Room Without E2E key

Prev Next
Get
/api/v1/e2e.getUsersOfRoomWithoutKey

Retrieves user IDs Of room without E2E key.

Header parameters
X-User-Id
stringRequired

The user ID.

ExampleCkCPNctrgCDfmWLqC
X-Auth-Token
stringRequired

The authentication token.

Example1Dd4iN_ClKn5jl-xPC36snQ4s9Zd5GZnXCQuCNSKcVE
Query parameters
rid
stringRequired

The room ID.

Responses
200

OK

Success Example
{
  "users": [
    {
      "_id": "XycfA5CetCPuEjqxw",
      "e2e": {
        "public_key": "{\"alg\":\"RSA-OAEP-256\",\"e\":\"AQAB\",\"ext\":true,\"key_ops\":[\"encrypt\"],\"kty\":\"RSA\",\"n\":\"oMO9ydjRxD3JzcAgMvyBZAc_pIOBIxOLVUChZ8mB3JNtLREC751hHT-WPZVZquWA6X4CihHejFfpIyAD_w-0MIToudTGO-f1aeE4Wc9-SBKjSQPphCuZMTwZ7iRtfUwHeGy5yM94uQPp07sEi9BmJSZqHscHc-6G520MyBhNU6uznQf-Sp85Q4etl4Ifs09khM-VMnBqKwh2QJx8w0880Vc3Zufve6udg0aSQ\"}"
      }
    }
  ],
  "success": true
}
Expand All
object
users
Array of object
object
_id
string
e2e
object
public_key
string
success
boolean
400

Bad Request

Invalid Params
{
  "success": false,
  "error": "must have required property 'rid' [invalid-params]",
  "errorType": "invalid-params"
}
Invalid Room
{
  "success": false,
  "error": "Invalid room [error-invalid-room]",
  "errorType": "error-invalid-room",
  "details": {
    "method": "e2e.getUsersOfRoomWithoutKey"
  }
}
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