---
title: "Modify system configurations."
method: PUT
path: "/configurations"
tags: ["configure"]
---

# Modify system configurations.

`PUT /configurations`

This endpoint is for modifying system configurations that only provides for admin user.

## Headers

- `X-Request-Id` string

## Request body

- Configurations
  - `auth_mode` string — The auth mode of current system, such as "db_auth", "ldap_auth", "oidc_auth"
  - `primary_auth_mode` boolean, nullable — The flag to indicate whether the current auth mode should consider as a primary one.
  - `ldap_base_dn` string — The Base DN for LDAP binding.
  - `ldap_filter` string — The filter for LDAP search
  - `ldap_group_base_dn` string — The base DN to search LDAP group.
  - `ldap_group_admin_dn` string — Specify the ldap group which have the same privilege with Harbor admin
  - `ldap_group_attribute_name` string — The attribute which is used as identity of the LDAP group, default is cn.'
  - `ldap_group_search_filter` string — The filter to search the ldap group
  - `ldap_group_search_scope` integer — The scope to search ldap group. ''0-LDAP_SCOPE_BASE, 1-LDAP_SCOPE_ONELEVEL, 2-LDAP_SCOPE_SUBTREE''
  - `ldap_group_attach_parallel` boolean — Attach LDAP user group information in parallel, the parallel worker count is 5
  - `ldap_scope` integer — The scope to search ldap users,'0-LDAP_SCOPE_BASE, 1-LDAP_SCOPE_ONELEVEL, 2-LDAP_SCOPE_SUBTREE'
  - `ldap_search_dn` string — The DN of the user to do the search.
  - `ldap_search_password` string — The password of the ldap search dn
  - `ldap_timeout` integer — Timeout in seconds for connection to LDAP server
  - `ldap_uid` string — The attribute which is used as identity for the LDAP binding, such as "CN" or "SAMAccountname"
  - `ldap_url` string — The URL of LDAP server
  - `ldap_verify_cert` boolean — Whether verify your OIDC server certificate, disable it if your OIDC server is hosted via self-hosted certificate.
  - `ldap_group_membership_attribute` string — The user attribute to identify the group membership
  - `project_creation_restriction` string — Indicate who can create projects, it could be ''adminonly'' or ''everyone''.
  - `read_only` boolean — The flag to indicate whether Harbor is in readonly mode.
  - `self_registration` boolean — Whether the Harbor instance supports self-registration. If it''s set to false, admin need to add user to the instance.
  - `token_expiration` integer — The expiration time of the token for internal Registry, in minutes.
  - `uaa_client_id` string — The client id of UAA
  - `uaa_client_secret` string — The client secret of the UAA
  - `uaa_endpoint` string — The endpoint of the UAA
  - `uaa_verify_cert` boolean — Verify the certificate in UAA server
  - `http_authproxy_endpoint` string — The endpoint of the HTTP auth
  - `http_authproxy_tokenreview_endpoint` string — The token review endpoint
  - `http_authproxy_admin_groups` string — The group which has the harbor admin privileges
  - `http_authproxy_admin_usernames` string — The username which has the harbor admin privileges
  - `http_authproxy_verify_cert` boolean — Verify the HTTP auth provider's certificate
  - `http_authproxy_skip_search` boolean — Search user before onboard
  - `http_authproxy_server_certificate` string — The certificate of the HTTP auth provider
  - `oidc_name` string — The OIDC provider name
  - `oidc_endpoint` string — The endpoint of the OIDC provider
  - `oidc_client_id` string — The client ID of the OIDC provider
  - `oidc_client_secret` string — The OIDC provider secret
  - `oidc_groups_claim` string — The attribute claims the group name
  - `oidc_admin_group` string — The OIDC group which has the harbor admin privileges
  - `oidc_group_filter` string — The OIDC group filter which filters out the group name doesn't match the regular expression
  - `oidc_scope` string — The scope of the OIDC provider
  - `oidc_user_claim` string — The attribute claims the username
  - `oidc_verify_cert` boolean — Verify the OIDC provider's certificate'
  - `oidc_auto_onboard` boolean — Auto onboard the OIDC user
  - `oidc_extra_redirect_parms` string — Extra parameters to add when redirect request to OIDC provider
  - `oidc_logout` boolean — Logout OIDC user session
  - `robot_token_duration` integer — The robot account token duration in days
  - `robot_name_prefix` string — The rebot account name prefix
  - `notification_enable` boolean — Enable notification
  - `quota_per_project_enable` boolean — Enable quota per project
  - `storage_per_project` integer — The storage quota per project
  - `audit_log_forward_endpoint` string — The audit log forward endpoint
  - `skip_audit_log_database` boolean — Skip audit log database
  - `session_timeout` integer — The session timeout for harbor, in minutes.
  - `scanner_skip_update_pulltime` boolean — Whether or not to skip update pull time for scanner
  - `banner_message` string — The banner message for the UI.It is the stringified result of the banner message object
  - `disabled_audit_log_event_types` string — the list to disable log audit event types.

## Response `200`

Modify system configurations successfully.

## Other responses

- `401` — User need to log in first.
- `403` — User does not have permission of admin role.
- `500` — Unexpected internal errors.

---

[API](https://skmtc.dev/cerit/apis/harbor-api.md) · [All operations](https://skmtc.dev/cerit/apis/harbor-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/cerit/harbor-api/revisions/62d78801f8df/schema)