Update account center settings

PATCH /api/account-center

OAuth2

Update the account center settings with the provided settings.

application/json

Body Required

enabled boolean

Enable or disable the account API.
fields object

The fields settings for the account API.

Additional properties are allowed.
Hide fields attributes Show fields attributes object
- name string
  
  Values are Off, ReadOnly, or Edit.
- avatar string
  
  Values are Off, ReadOnly, or Edit.
- profile string
  
  Values are Off, ReadOnly, or Edit.
- email string
  
  Values are Off, ReadOnly, or Edit.
- phone string
  
  Values are Off, ReadOnly, or Edit.
- password string
  
  Values are Off, ReadOnly, or Edit.
- username string
  
  Values are Off, ReadOnly, or Edit.
- social string
  
  Values are Off, ReadOnly, or Edit.
- customData string
  
  Values are Off, ReadOnly, or Edit.

Responses

200 application/json

Updated account center settings.
Hide response attributes Show response attributes object
- tenantId string Required
  
  Maximum length is 21.
- id string Required
  
  Minimum length is 1, maximum length is 21.
- enabled boolean Required
- fields object Required
  
  Additional properties are allowed.
  
  Hide fields attributes Show fields attributes object
  
  name string
  
  Values are Off, ReadOnly, or Edit.
  
  avatar string
  
  Values are Off, ReadOnly, or Edit.
  
  profile string
  
  Values are Off, ReadOnly, or Edit.
  
  email string
  
  Values are Off, ReadOnly, or Edit.
  
  phone string
  
  Values are Off, ReadOnly, or Edit.
  
  password string
  
  Values are Off, ReadOnly, or Edit.
  
  username string
  
  Values are Off, ReadOnly, or Edit.
  
  social string
  
  Values are Off, ReadOnly, or Edit.
  
  customData string
  
  Values are Off, ReadOnly, or Edit.
400

Bad Request
401

Unauthorized
403

Forbidden

PATCH /api/account-center

curl \
 -X PATCH https://[tenant_id].logto.app/api/account-center \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"enabled":true,"fields":{"name":"Off","avatar":"Off","profile":"Off","email":"Off","phone":"Off","password":"Off","username":"Off","social":"Off","customData":"Off"}}'

Request examples

{
  "enabled": true,
  "fields": {
    "name": "Off",
    "avatar": "Off",
    "profile": "Off",
    "email": "Off",
    "phone": "Off",
    "password": "Off",
    "username": "Off",
    "social": "Off",
    "customData": "Off"
  }
}

Response examples (200)

{
  "tenantId": "string",
  "id": "string",
  "enabled": true,
  "fields": {
    "name": "Off",
    "avatar": "Off",
    "profile": "Off",
    "email": "Off",
    "phone": "Off",
    "password": "Off",
    "username": "Off",
    "social": "Off",
    "customData": "Off"
  }
}