configure

Modify system configurations.

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

put/configurations

Headers

X-Request-Idstring

An unique ID for the request

Request body

auth_modestring

The auth mode of current system, such as "db_auth", "ldap_auth", "oidc_auth"

primary_auth_modeboolean nullable

The flag to indicate whether the current auth mode should consider as a primary one.

ldap_base_dnstring

The Base DN for LDAP binding.

ldap_filterstring

The filter for LDAP search

ldap_group_base_dnstring

The base DN to search LDAP group.

ldap_group_admin_dnstring

Specify the ldap group which have the same privilege with Harbor admin

ldap_group_attribute_namestring

The attribute which is used as identity of the LDAP group, default is cn.'

ldap_group_search_filterstring

The filter to search the ldap group

ldap_group_search_scopeinteger

The scope to search ldap group. ''0-LDAP_SCOPE_BASE, 1-LDAP_SCOPE_ONELEVEL, 2-LDAP_SCOPE_SUBTREE''

ldap_group_attach_parallelboolean

Attach LDAP user group information in parallel, the parallel worker count is 5

ldap_scopeinteger

The scope to search ldap users,'0-LDAP_SCOPE_BASE, 1-LDAP_SCOPE_ONELEVEL, 2-LDAP_SCOPE_SUBTREE'

ldap_search_dnstring

The DN of the user to do the search.

ldap_search_passwordstring

The password of the ldap search dn

ldap_timeoutinteger

Timeout in seconds for connection to LDAP server

ldap_uidstring

The attribute which is used as identity for the LDAP binding, such as "CN" or "SAMAccountname"

ldap_urlstring

The URL of LDAP server

ldap_verify_certboolean

Whether verify your OIDC server certificate, disable it if your OIDC server is hosted via self-hosted certificate.

ldap_group_membership_attributestring

The user attribute to identify the group membership

project_creation_restrictionstring

Indicate who can create projects, it could be ''adminonly'' or ''everyone''.

read_onlyboolean

The flag to indicate whether Harbor is in readonly mode.

self_registrationboolean

Whether the Harbor instance supports self-registration. If it''s set to false, admin need to add user to the instance.

token_expirationinteger

The expiration time of the token for internal Registry, in minutes.

uaa_client_idstring

The client id of UAA

uaa_client_secretstring

The client secret of the UAA

uaa_endpointstring

The endpoint of the UAA

uaa_verify_certboolean

Verify the certificate in UAA server

http_authproxy_endpointstring

The endpoint of the HTTP auth

http_authproxy_tokenreview_endpointstring

The token review endpoint

http_authproxy_admin_groupsstring

The group which has the harbor admin privileges

http_authproxy_admin_usernamesstring

The username which has the harbor admin privileges

http_authproxy_verify_certboolean

Verify the HTTP auth provider's certificate

http_authproxy_skip_searchboolean

Search user before onboard

http_authproxy_server_certificatestring

The certificate of the HTTP auth provider

oidc_namestring

The OIDC provider name

oidc_endpointstring

The endpoint of the OIDC provider

oidc_client_idstring

The client ID of the OIDC provider

oidc_client_secretstring

The OIDC provider secret

oidc_groups_claimstring

The attribute claims the group name

oidc_admin_groupstring

The OIDC group which has the harbor admin privileges

oidc_group_filterstring

The OIDC group filter which filters out the group name doesn't match the regular expression

oidc_scopestring

The scope of the OIDC provider

oidc_user_claimstring

The attribute claims the username

oidc_verify_certboolean

Verify the OIDC provider's certificate'

oidc_auto_onboardboolean

Auto onboard the OIDC user

oidc_extra_redirect_parmsstring

Extra parameters to add when redirect request to OIDC provider

oidc_logoutboolean

Logout OIDC user session

robot_token_durationinteger

The robot account token duration in days

robot_name_prefixstring

The rebot account name prefix

notification_enableboolean

Enable notification

quota_per_project_enableboolean

Enable quota per project

storage_per_projectinteger

The storage quota per project

audit_log_forward_endpointstring

The audit log forward endpoint

skip_audit_log_databaseboolean

Skip audit log database

session_timeoutinteger

The session timeout for harbor, in minutes.

scanner_skip_update_pulltimeboolean

Whether or not to skip update pull time for scanner

banner_messagestring

The banner message for the UI.It is the stringified result of the banner message object

disabled_audit_log_event_typesstring

the list to disable log audit event types.

Response

Modify system configurations successfully.

Changes

No recorded changes to this endpoint across all 1 revision of this API.