Get Current User

GET 
http://localhost:3000/api/whoami

Retrieve information about the current user session.

Responses

200

Current user information retrieved successfully.

application/json

Schema

Schema

idstring

The unique identifier of the session.

profile object

The profile information of the user.

namestring

The name of the member.

is_adminboolean

Indicates if the member is an admin.

can_loginboolean

Indicates if the member can log in.

can_connectboolean

Indicates if the member can connect.

can_watchboolean

Indicates if the member can watch.

can_hostboolean

Indicates if the member can host.

can_share_mediaboolean

Indicates if the member can share media.

can_access_clipboardboolean

Indicates if the member can access the clipboard.

sends_inactive_cursorboolean

Indicates if the member sends inactive cursor.

can_see_inactive_cursorsboolean

Indicates if the member can see inactive cursors.

plugins object

Additional plugin settings.

property name*any

Additional plugin settings.

state object

The current state of the session.

is_connectedboolean

Indicates if the user is connected.

is_watchingboolean

Indicates if the user is watching.

Example (auto)

{
  "id": "string",
  "profile": {
    "name": "string",
    "is_admin": true,
    "can_login": true,
    "can_connect": true,
    "can_watch": true,
    "can_host": true,
    "can_share_media": true,
    "can_access_clipboard": true,
    "sends_inactive_cursor": true,
    "can_see_inactive_cursors": true,
    "plugins": {}
  },
  "state": {
    "is_connected": true,
    "is_watching": true
  }
}

401

The request requires user authentication.

application/json

Schema

Schema

messagestring

Detailed error message.

Example (auto)

{
  "message": "string"
}

403

The server understood the request, but refuses to authorize it.

application/json

Schema

Schema

messagestring

Detailed error message.

Example (auto)

{
  "message": "string"
}

Authorization: http

name: BearerAuthtype: httpscheme: bearerdescription: Authentication using a Bearer token.

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "http://localhost:3000/api/whoami");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

http://localhost:3000

Auth

Security Scheme

BearerAuthCookieAuthTokenAuth

Bearer Token

ResponseClear

Click the Send API Request button above and see the response here!