Skip to main content
POST
auth.user.ban

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
userId
string
required

The user to ban, as returned by auth.users.list.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
reason
string

Why, up to 512 characters. Kept with the ban where supported.

Required string length: 1 - 512
expiresInSeconds
number

Make the ban temporary: whole seconds, 60 to 10 years. Rejected where the auth system cannot do temporary bans.

Required range: 60 <= x <= 315360000

Response

The result

userId
string
required

The banned user.

banned
boolean
required

Always true.