API Reference

Change the status of a user session (e.g., kick a user or restrict chat access).

post
https://localhost:44395/api/admin/user-session

Behavior: Updates the status of the specified user session to a new value such as Kicked, ChatRestricted, or Expired. This is commonly used to kick a user off the system or restrict their chat privileges. The affected user will see the status change on their next session ping.

Authorization: Requires a valid Bearer token (class-level [Authorize]).

Side Effects: Changes the session status. The affected user will see the status change on their next ping.

Error Scenarios: Returns 400 if the request is null or Id/UserSessionStatus are missing.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

A Nomad.Common.Models.Admin.UserSession.ChangeSessionStatusModel containing the session Id (required), UserSessionStatus to set (required), and optional ApplicationId.

Request model for changing the status of a user session (e.g., kicking a user or restricting chat access).

uuid
required

Gets or sets the unique identifier of the user session to update. Required.

string
enum
required

Indicates the current status of a user session.

Normal

ChatDisabled

SessionReplaced

Deactivated

SharedAccess

PendingInvite

Expired

DeletedInvite

uuid | null

Gets or sets the optional application identifier to scope the session lookup.

Headers
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

401

The caller is not authenticated.

Updated about 20 hours ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 20 hours ago