Skip to main content
POST
auth.user.update

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 rename, as returned by auth.users.list.

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

The new display name, up to 256 characters.

Required string length: 1 - 256

Response

The result

userId
string
required

The user's id.

email
string

Email address.

emailVerified
boolean

Whether the email is verified.

name
string

Display name.

imageUrl
string

Profile image URL.

createdAt
string

When the user was created, ISO 8601.

lastSignInAt
string

Last sign-in time, ISO 8601.

banned
boolean

Whether the user is banned.