NSSSRemoveSecret

Removes the specified secret from SecretStore.

Syntax

    #include <nssscl.h> 
     
    SS_EXTERN_LIBCALL(int) NWSSRemoveSecret 
    (
       SSS_Context_T     callerContext, 
       SS_OBJECT_DN_T   *targetObject, 
       unisgned long     ssFlags, 
       SS_SECRET_ID_T   *secretID, 
       SS_EXT_T         *ext
    );

Parameters

callerContext
(IN) Specifies an optional structure that can be initialized by calling NSSSGetServiceInformation prior to use here. The flags field of the structure can take on the following values to indicate the type of context used.NSSS_NCP_CTX_F—Directory Service API context indicator flagNSSS_LDAP_CTX_F—LDAP context indicator flag <reserved>
targetObject
(IN) Points to an optional RDN (relative distinguished name or "short name") of the target object that contains the user's secrets. You should have at least READ/WRITE privileges over the target object.
ssFlags
(IN) Specifies a set of flags for initializing secrets.

Value

Description

NSSS_ALL_STRINGS_UNICODE_F

Indicates that all applicable char strings such as targetObject, secretID etc., are already in Unicode and the API does not need to perform conversion from local code page to Unicode. This flag instructs the API not to convert the return char strings to local code page as well. This is a feature of SSO client v1.1 and will not work on the older versions.

NSSS_SET_TREE_NAME_F

Sets the tree name.

NSSS_DESTROY_CONTEXT_F

Internally destroys the DS context passed in. This flag can be used on the last call to SecretStore to destroy the context that was used.
secretID
(IN) Points to a unique secret identifier chosen by the application that should be supplied to locate the application secret values in the user's SecretStore to be removed.
ext
(OUT) If present, returns a set of applicable future extensions for the secrets.

Return Values

These are common return values (for more information, see Section 4.0, Return Values):

Value

Description

NSSS_SUCCESS

The operation succeeded.

NSSS_E_SYSTEM_FAILURE

Some internal operation failed due to some failure such as memory allocation.

NSSS_E_CORRUPTED_STORE

This indicates data corruption in SecretStore.

NSSS_E_NICI_FAILURE

NICI failure detected.

NSSS_E_INVALID_SECRET_ID

Secret ID is not in the SecretStore.

NSSS_E_ACCESS_DENIED

eDirectory denied access to an object or attribute related to the SecretStore.

NSSS_E_STORE_NOT_FOUND

Client does not have a SecretStore or the Schema is not extended to begin with.

NSSS_E_NDS_INTERNAL_FAILURE

Some eDirectory operation has failed internally.

NSSS_E_INCOMPATIBLE_VERSION

Client SecretStore is not compatible with server SecretStore.

NSSS_E_INVALID_TARGET_OBJECT

Target object is not the type designated for SecretStore attachment.

Remarks

The NSSSRemoveSecret call removes an identified secret from the SecretStore for the user. If the secret happens to be the last secret in the user's SecretStore the SecretStore is removed completely.

NOTE:This function formerly was called NSSSRemoveSecretID.

See Also