Update admin console config

PATCH /api/configs/admin-console

OAuth2

Update the global configuration object for Logto Console. This method performs a partial update.

application/json

Body Required

signInExperienceCustomized boolean
organizationCreated boolean
developmentTenantMigrationNotification object
Hide developmentTenantMigrationNotification attributes Show developmentTenantMigrationNotification attributes object
- isPaidTenant boolean Required
- tag string Required
- readAt number
checkedChargeNotification object
Hide checkedChargeNotification attributes Show checkedChargeNotification attributes object
- token boolean
- apiResource boolean
- machineToMachineApp boolean
- tenantMember boolean

Responses

200 application/json

The updated configuration object.
Hide response attributes Show response attributes object
- signInExperienceCustomized boolean Required
- organizationCreated boolean Required
- developmentTenantMigrationNotification object
  
  Hide developmentTenantMigrationNotification attributes Show developmentTenantMigrationNotification attributes object
  
  isPaidTenant boolean Required
  
  tag string Required
  
  readAt number
- checkedChargeNotification object
  
  Hide checkedChargeNotification attributes Show checkedChargeNotification attributes object
  
  token boolean
  
  apiResource boolean
  
  machineToMachineApp boolean
  
  tenantMember boolean
400

Bad Request
401

Unauthorized
403

Forbidden
404

Configuration not found.

PATCH /api/configs/admin-console

curl \
 -X PATCH https://[tenant_id].logto.app/api/configs/admin-console \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"signInExperienceCustomized":true,"organizationCreated":true,"developmentTenantMigrationNotification":{"isPaidTenant":true,"tag":"string","readAt":42.0},"checkedChargeNotification":{"token":true,"apiResource":true,"machineToMachineApp":true,"tenantMember":true}}'

Request examples

{
  "signInExperienceCustomized": true,
  "organizationCreated": true,
  "developmentTenantMigrationNotification": {
    "isPaidTenant": true,
    "tag": "string",
    "readAt": 42.0
  },
  "checkedChargeNotification": {
    "token": true,
    "apiResource": true,
    "machineToMachineApp": true,
    "tenantMember": true
  }
}

Response examples (200)

{
  "signInExperienceCustomized": true,
  "organizationCreated": true,
  "developmentTenantMigrationNotification": {
    "isPaidTenant": true,
    "tag": "string",
    "readAt": 42.0
  },
  "checkedChargeNotification": {
    "token": true,
    "apiResource": true,
    "machineToMachineApp": true,
    "tenantMember": true
  }
}