PUT/api/user/profileAuthenticated

Replace my profile

Replaces the caller's profile name fields. Full-replacement semantics: fields that are omitted or set to null are cleared. Unknown fields are rejected.

operationId put_api_user_profileAccount

Authentication & permissionsAuthenticated

Any authenticated user

Accepted credentials: Auth server session (refresh token cookie)cookie "refresh_token_<auth_server_app_id>"
Access token (cookie)cookie "access_token_<auth_server_app_id>"
Access token (Bearer)Authorization: Bearer <JWT>
Who may call: Any authenticated user

Request body

Required

application/json

UpdateUserProfileRequestThe new profile name fields; omitted or null fields are cleared.

Property	Type	Description
username	string \| null \| null	minLength: 3maxLength: 32pattern: ^[A-Za-z0-9](?:[A-Za-z0-9._-]*[A-Za-z0-9])?$
first_name	string \| null \| null	minLength: 1maxLength: 64pattern: ^[^\u0000-\u001F\u007F]*$
middle_name	string \| null \| null	minLength: 1maxLength: 64pattern: ^[^\u0000-\u001F\u007F]*$
last_name	string \| null \| null	minLength: 1maxLength: 64pattern: ^[^\u0000-\u001F\u007F]*$
display_name	string \| null \| null	minLength: 1maxLength: 64pattern: ^[^\u0000-\u001F\u007F]*$

JSONExample

"username""string"

"first_name""string"

"middle_name""string"

"last_name""string"

"display_name""string"

Responses

application/json

UserProfileResponseThe caller's profile name fields; absent fields are unset.

Property	Type	Description
success*	true
profile*	object
username	string	minLength: 3maxLength: 32pattern: ^[A-Za-z0-9](?:[A-Za-z0-9._-]*[A-Za-z0-9])?$
first_name	string	minLength: 1maxLength: 64pattern: ^[^\u0000-\u001F\u007F]*$
middle_name	string	minLength: 1maxLength: 64pattern: ^[^\u0000-\u001F\u007F]*$
last_name	string	minLength: 1maxLength: 64pattern: ^[^\u0000-\u001F\u007F]*$
display_name	string	minLength: 1maxLength: 64pattern: ^[^\u0000-\u001F\u007F]*$

JSONExample

"success"true

"profile"

"username""string"

"first_name""string"

"middle_name""string"

"last_name""string"

"display_name""string"

Example request

bashcurl

curl -X PUT 'https://auth.schemavaults.com/api/user/profile' \
  -b 'refresh_token_<auth_server_app_id>=<value>' \
  -H 'Content-Type: application/json' \
  -d '{
  "username": "string",
  "first_name": "string",
  "middle_name": "string",
  "last_name": "string",
  "display_name": "string"
}'

Other methods on this path

GETGet my profile

Authentication & permissionsAuthenticated

Request body

Responses

200The updated profile

400The request failed validation (issues lists the offending fields) or was refused by the handler

401No valid session cookie, access token cookie or bearer access token was presented, or the token was revoked

403The account is disabled, or the credential is valid but not allowed to perform this operation

404The caller's account no longer exists

409The requested username is already taken

500Failed to update the profile

Example request

Other methods on this path