Update a user

Updates the specified user.

PUT /environments/{environmentId}/users/{userId}

Update a user

cURL

curl --request PUT \
  --url https://app.dynamicauth.com/api/v0/environments/{environmentId}/users/{userId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "alias": "An example name",
  "firstName": "An example name",
  "lastName": "An example name",
  "jobTitle": "An example name",
  "phoneNumber": "An example name",
  "metadata": {},
  "mfaBackupCodeAcknowledgement": "pending",
  "tShirtSize": "An example name",
  "team": "An example name",
  "policiesConsent": true,
  "country": "US",
  "username": "johndoe",
  "btcWallet": "3FZbgi29cpjq2GjdwV8eyHuJJnkLtktZc5",
  "kdaWallet": "k:0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF",
  "ltcWallet": "LUttH43tQ4x4qniCKr1Rqo8ESeXFPdv9ax",
  "ckbWallet": "ckt1q9876543210abcdefghijklmnopqrstuvwxyz",
  "kasWallet": "kaspa:qrelgny7sr3vahq69yykxx36m65gvmhryxrlwngfzgu8xkdslum2yxjp3ap8m",
  "dogeWallet": "DPcy35vmuk8GXcfu1vgFFEeij3BuYYJQKB",
  "emailNotification": true,
  "discordNotification": true,
  "newsletterNotification": true
}
'

200

{}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

environmentId · string · required

ID of the environment

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

userId · string · required

UUID of the user

Required string length: 36

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example:

"95b11417-f18f-457f-8804-68e361f9164f"

Body

application/json

User new fields data

User fields that can be updated on dashboard or through the rest API which do not involve any uniqueness checks or further verification

alias · string

Maximum string length: 255

Pattern: ^$|^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$

Example:

"An example name"

firstName · string

Maximum string length: 255

Pattern: ^$|^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$

Example:

"An example name"

lastName · string

Maximum string length: 255

Pattern: ^$|^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$

Example:

"An example name"

jobTitle · string

Maximum string length: 255

Pattern: ^$|^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$

Example:

"An example name"

phoneNumber · string

Maximum string length: 255

Pattern: ^$|^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$

Example:

"An example name"

metadata · object

mfaBackupCodeAcknowledgement · enum<string> | null

Available options: pending, complete

tShirtSize · string

Maximum string length: 255

Pattern: ^$|^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$

Example:

"An example name"

team · string

Maximum string length: 255

Pattern: ^$|^(?=\S)[\p{L}\p{N}a-zA-Z _.,:!?&%@\/+\-'|]+(?<=\S)$

Example:

"An example name"

policiesConsent · boolean

country · string | null

Standard ISO 3166-1 alpha-2 two-letter country code

Maximum string length: 255

Pattern: ^[A-Z]{2}$

Example:

"US"

username · string | null

Alphanumeric with slugs and underscores username

Maximum string length: 255

Pattern: ^$|^[\p{L}\p{N}_-]{3,20}$

Example:

"johndoe"

btcWallet · string | null

BTC wallet address

Pattern: ^(bc1|[13])[a-zA-HJ-NP-Z0-9]{25,59}$

Example:

"3FZbgi29cpjq2GjdwV8eyHuJJnkLtktZc5"

kdaWallet · string | null

KDA wallet address

Pattern: ^k:[0-9a-fA-F]{64}$

Example:

"k:0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF0123456789ABCDEF"

ltcWallet · string | null

LTC wallet address

Pattern: ^[LM3][a-km-zA-HJ-NP-Z1-9]{26,53}$

Example:

"LUttH43tQ4x4qniCKr1Rqo8ESeXFPdv9ax"

ckbWallet · string | null

CKB wallet address

Pattern: ^(ckb1q|ckt1q)[0-9a-z]{25,111}$

Example:

"ckt1q9876543210abcdefghijklmnopqrstuvwxyz"

kasWallet · string | null

KAS wallet address

Pattern: ^kaspa:[1234567890ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz]{56,}$

Example:

"kaspa:qrelgny7sr3vahq69yykxx36m65gvmhryxrlwngfzgu8xkdslum2yxjp3ap8m"

dogeWallet · string | null

DOGE wallet address

Pattern: ^D[a-zA-Z0-9_.-]{33}$

Example:

"DPcy35vmuk8GXcfu1vgFFEeij3BuYYJQKB"

emailNotification · boolean

discordNotification · boolean

newsletterNotification · boolean

Response

200

application/json

Successful response of a user

user · object

Show child attributes