Skip to main content
Version: 4.x

ALTER AUTHENTICATION INTEGRATION

ALTER AUTHENTICATION INTEGRATION modifies the properties or comment of an existing authentication integration.

Note:

Supported since VeloDB Enterprise 4.1.4.

Syntax​

ALTER AUTHENTICATION INTEGRATION <integration_name>
SET PROPERTIES (
'<property_key>' = '<property_value>'
[, '<property_key>' = '<property_value>' ...]
);

ALTER AUTHENTICATION INTEGRATION <integration_name>
UNSET PROPERTIES (
'<property_key>'
[, '<property_key>' ...]
);

ALTER AUTHENTICATION INTEGRATION <integration_name>
SET COMMENT '<comment>';

Required parameters​

ParameterDescription
<integration_name>Name of the integration to modify.

Modification clauses​

ClauseDescription
SET PROPERTIES (...)Adds or overwrites one or more properties.
UNSET PROPERTIES (...)Removes one or more properties.
SET COMMENT '<comment>'Updates the integration comment.

Access control requirements​

The user executing this statement must have the following privilege, either directly or through a role:

PrivilegeObjectDescription
ADMIN_PRIVUser or roleRequired to perform this operation.

Usage notes​

  • The target integration must exist.
  • SET PROPERTIES and UNSET PROPERTIES must contain at least one property.
  • You cannot modify or remove the type property.
  • After a property update, the authentication plugin is reloaded with the latest configuration the next time the integration is used.

Examples​

Update OIDC properties:

ALTER AUTHENTICATION INTEGRATION corp_oidc
SET PROPERTIES (
'oidc.allowed_audiences' = 'doris,grafana',
'oidc.clock_skew_seconds' = '120'
);

Remove properties that are no longer needed:

ALTER AUTHENTICATION INTEGRATION corp_oidc
UNSET PROPERTIES (
'oidc.extra_claims',
'oidc.allowed_algorithms'
);

Update the comment:

ALTER AUTHENTICATION INTEGRATION corp_oidc
SET COMMENT 'Updated corporate OIDC configuration';