---
title: "POST /get-account-settings"
method: POST
path: "/get-account-settings"
tags: ["Account"]
---

# POST /get-account-settings

`POST /get-account-settings`

## Request

- Base URL: `https://api.akeyless.io`
- URL: `https://api.akeyless.io/get-account-settings`
- Auth: none declared

## Request body

- GetAccountSettings
  - `json` boolean: Set output format to JSON
  - `token` string: Authentication token (see `/auth` and `/configure`)
  - `uid-token` string: The universal identity token, Required only for universal_identity authentication

## Response `200`

getAccountSettingsResponse wraps response body.

- GetAccountSettingsCommandOutput
  - `account_id` string
  - `address` CustomerFullAddress
    - `city` string
    - `country` string
    - `postal_code` string
    - `street` string
  - `company_name` string
  - `email` string
  - `general_settings` AccountGeneralSettings: AccountGeneralSettings describes general settings for an account
    - `account_default_key_item_id` integer: AccountDefaultKeyItemID is the item ID of the DFC key item configured as the default protection key
    - `account_default_key_name` string: AccountDefaultKeyName is the name of the DFC key item configured as the default key This is here simply for the response to include the item name in addition to the display ID so the client can properly show this to the user. It will not be saved to the DB, only the AccountDefaultKeyItemID will.
    - `account_file_bytes_used` integer: AccountFileBytesUsed tracks active + pending file-item plain bytes for quota enforcement.
    - `ai_insights` AiInsightsSetting
      - `enable` boolean
    - `ai_quorum` AiQuorumSetting: It is the outermost of the three gates a quorum needs (account, then the item's own toggle, then more than one model configured on the gateway). Off means every item evaluates against the Default model alone, whatever the items and gateways below it are configured with - so an operator can stop quorum account-wide in one action if a provider starts failing, without unpicking per-item configuration.
      - `enable` boolean
    - `allow_auto_fill` boolean
    - `allow_passkeys` boolean
    - `allowed_client_types` AllowedClientType
      - `client_types` string[]
      - `lock` boolean
    - `allowed_clients_ips` AllowedIpSettings
      - `cidr_whitelist` string
      - `lock` boolean
    - `allowed_gateways_ips` AllowedIpSettings
      - `cidr_whitelist` string
      - `lock` boolean
    - `auth_usage_event` UsageEventSetting
      - `enable` boolean
      - `enable_time` string, date-time
      - `interval_by_days` integer
    - `certificate_expiration_events` CertificateExpirationEventsSettings
      - `enable` boolean
      - `expirations_list` CertificateExpirationEvent[]: ExpirationEventsList is the default expiration events for the account
        - `seconds_before` integer
    - `data_protection_section` DataProtectionSection: We need the fields to be pointers as we use the same struct for partial updates as well
      - `enable_classic_key_protection` boolean
    - `default_auth_method` DefaultAuthMethodSettings
      - `default_access_id` string
      - `default_auth_method_type` string
    - `default_home_page` DefaultHomePage
      - `route` string
    - `dynamic_secret_max_ttl` DynamicSecretMaxTtl
      - `enable` boolean
      - `max_ttl_by_minutes` integer
    - `email_customization` EmailCustomization
      - `account_information_fields` EmailCustomizationAccountInformation: EmailCustomizationAccountInformation stores the optional account info fields that can be rendered in customer-facing emails.
        - `account_id` boolean
        - `alias_name` boolean
        - `company_name` boolean
        - `tenant_name` boolean
      - `account_information_values` EmailCustomizationAccountInformationValues
        - `account_id` string
        - `alias_name` string
        - `company_name` string
        - `tenant_name` string
      - `footer_html` string
      - `sender_name` string
      - `show_background_image` boolean
      - `subject` string
    - `enable_request_for_access` boolean
    - `enable_search_history` boolean
    - `event_forwarder_allowed_email_domains` string[]: EventForwarderAllowedEmailDomains lists extra recipient domains for email event forwarders. The signup email domain is always allowed as well. Account-settings updates leave this field unchanged.
    - `hide_personal_folder` boolean
    - `hide_secret_reveal_copy` boolean
    - `hide_static_password` boolean
    - `invalid_characters` string: InvalidCharacters is the invalid characters for items/targets/roles/auths/notifier_forwarder naming convention
    - `item_locking` ItemLockingSetting
      - `enable` boolean
      - `max_lock_ttl_mins` integer
    - `item_usage_event` UsageEventSetting
      - `enable` boolean
      - `enable_time` string, date-time
      - `interval_by_days` integer
    - `lock_default_key` boolean: LockDefaultKey determines whether the configured default key can be updated by end-users on a per-request basis true - all requests use the configured default key false - every request can determine its protection key (default) nil - change nothing (every request can determine its protection key (default)) This parameter is only relevant if AccountDefaultKeyItemID is not empty
    - `password_expiration_info` PasswordExpirationInfo
      - `days_before_expire` integer
      - `days_before_notification` integer
      - `days_until_expire` integer: r/o calculated parameter
      - `enable` boolean
    - `password_policy` PasswordPolicyInfo
      - `password_length` integer
      - `use_capital_letters` boolean
      - `use_lower_letters` boolean
      - `use_numbers` boolean
      - `use_special_characters` boolean
    - `password_score` PasswordScoreSetting
      - `enabled` boolean
    - `personal_folder_global_mapping` PersonalFolderGlobalMappingSettings
      - `enable` boolean
      - `unique_identifier_claim` string
    - `protect_items_by_default` boolean
    - `rotation_secret_max_interval` RotationSecretMaxInterval
      - `enable` boolean
      - `max_interval_by_days` integer
    - `sharing_policy` SharingPolicyInfo
      - `allowed_email_domains` string[]: AllowedEmailDomains limits email sharing to these domains. By default all domains are allowed.
      - `default_share_link_ttl` integer
      - `enable` boolean
  - `object_version_settings` AccountObjectVersionSettingsOutput
    - `default-versioning` boolean
    - `force_new_versions` boolean
    - `items` ObjectVersionSettingsOutput[]
      - `item-type` string: VersionSettingsObjectType defines object types for account version settings
      - `max-versions` string
  - `phone` string
  - `secret_management` SmInfo
    - `sla` string
    - `tier` string: Tier represents a level of extensibility the account will have, defined by various limits for different resources of Akeyless e.g - A StarterTier may have a limit of 3 Client resources and 50 Secret resources
  - `secure_remote_access` SraInfo
    - `sla` string
    - `tier` string: Tier represents a level of extensibility the account will have, defined by various limits for different resources of Akeyless e.g - A StarterTier may have a limit of 3 Client resources and 50 Secret resources
    - `user_type` string
  - `system_access_creds_settings` SystemAccessCredsSettings: SystemAccessCredsSettings describes system access credential settings for account by minutes
    - `jwt_ttl_default` integer
    - `jwt_ttl_maximum` integer
    - `jwt_ttl_minimum` integer

## Other responses

- `default`: errorResponse wraps any error to return it as a JSON object with one "error" field.

---

[API](https://skmtc.dev/akeyless/apis/account-settings.md) - [All operations](https://skmtc.dev/akeyless/apis/account-settings/llms.txt) - [OpenAPI document](https://skmtc.dev/akeyless/apis/account-settings/revisions/6beb28d274ac?raw)