Skip to main content
GET
/
tenant
/
{tenantId}
/
admin
/
user
/
{userIdToLogout}
/
signout
SignOut
curl --request GET \
  --url https://api.example.com/tenant/{tenantId}/admin/user/{userIdToLogout}/signout
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

​
Description

This endpoint signs out a tenant user, terminating their current session and requiring re-authentication for future access.

​
Input

  • tenantId (path, required): Identifier of the tenant requesting the sign-out
  • userIdToLogout (path, required): Identifier of the user to sign out
  • cancellationToken (optional): Token to cancel the asynchronous operation

​
Output

Returns a Result<UserModel> containing the signed-out user details.

​
Examples

Request: 
GET /api/tenant/1024/users/4242/sign-out
Response (200 OK): 
{
  "data": {
    "id": 4242,
    "email": "[email protected]",
    "firstName": "Casey",
    "lastName": "Taylor",
    "isActive": false
  },
  "isSuccess": true
}

​
Errors

  • 400 Bad Request: Invalid identifiers
  • 401 Unauthorized: Authentication credentials are missing or invalid
  • 403 Forbidden: User lacks permission to sign out users
  • 404 Not Found: User does not exist
  • 500 Internal Server Error: Unexpected server error occurred

​
Notes

  • Terminates active session immediately
  • User must re-authenticate to access tenant
  • Does not disable the user account

Path Parameters

​
tenantId
integer<int64>
required

Identifier of the tenant requesting the sign-out.

​
userIdToLogout
integer<int64>
required

Identifier of the user to sign out.

Response

User signed out successfully.

Wrapper for API operation results containing success status, error information, and return value.

​
isSuccess
boolean

True if the operation completed successfully, false otherwise.

Example:

true

​
isFailure
boolean

True if the operation failed, false otherwise.

Example:

false

​
error
object

Error information returned when the operation fails.

Example:
{
  "code": "ValidationError",
  "message": "The request parameters failed validation.",
  "info": [
    "The Name field is required.",
    "The Id field must be greater than 0."
  ]
}
​
value
object

The result value returned when the operation is successful.

Example:
{
  "id": 4242,
  "email": "[email protected]",
  "firstName": "Casey",
  "lastName": "Taylor",
  "isActive": true
}