LSA_UPDATE_PRIMARY_CREDENTIALS callback function (ntsecpkg.h)

Article
02/22/2024

Provides a mechanism for one security package to notify other packages that the credentials for a logon session have changed.

Syntax

LSA_UPDATE_PRIMARY_CREDENTIALS LsaUpdatePrimaryCredentials;

NTSTATUS LsaUpdatePrimaryCredentials(
  [in]           PSECPKG_PRIMARY_CRED PrimaryCredentials,
  [in, optional] PSECPKG_SUPPLEMENTAL_CRED_ARRAY Credentials
)
{...}

Parameters

[in] PrimaryCredentials

Pointer to a SECPKG_PRIMARY_CRED structure containing the primary credentials.

[in, optional] Credentials

Optional. Pointer to a SECPKG_SUPPLEMENTAL_CRED_ARRAY structure containing the supplemental credentials.

Return value

If the function succeeds, the return value is STATUS_SUCCESS.

If the function fails, the return value is an NTSTATUS code indicating the reason it failed.

Remarks

To notify packages about the changed credentials, the Local Security Authority (LSA) calls the SpAcceptCredentials function implementation in each package.

A pointer to the UpdateCredentials function is available in the LSA_SECPKG_FUNCTION_TABLE structure received by the SpInitialize function.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	ntsecpkg.h