banUser

POST

/admin/ban-user

curl --request POST \
  --url https://gymgym.club/api/auth/admin/ban-user \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "userId": "example", "banReason": "example", "banExpiresIn": 1 }'

Ban a user

Authorizations

• bearerAuth

Request Body^required

Media typeapplication/json

object

userId

required

The user id

string

banReason

The reason for the ban

string

banExpiresIn

The number of seconds until the ban expires

number

Example^generated

{
  "userId": "example",
  "banReason": "example",
  "banExpiresIn": 1
}

Responses

200

User banned

Media typeapplication/json

object

user

object

id

required

string

name

required

string

email

required

string

emailVerified

required

boolean

image

string

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

role

string

banned

boolean

banReason

string

banExpires

string format: date-time

isAnonymous

boolean

lastLoginMethod

string

Example

{
  "user": {
    "emailVerified": false,
    "banned": false,
    "isAnonymous": false
  }
}

400

Bad Request. Usually due to missing parameters, or invalid parameters.

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

401

Unauthorized. Due to missing or invalid authentication.

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

403

Forbidden. You do not have permission to access this resource or to perform this action.

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

404

Not Found. The requested resource was not found.

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

429

Too Many Requests. You have exceeded the rate limit. Try again later.

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

500

Internal Server Error. This is a problem with the server that you cannot fix.

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}