am_sso_set_property()

Sets a property and its value in the SSOToken associated with the specified single sign-on token handle.

Details

The single sign-on token handle for this SSOToken was obtained before this call and thus will not include the new property. You must call am_sso_validate_token() to update the handle.

Syntax

#include "am_sso.h"
AM_EXPORT am_status_t
am_sso_set_property(am_sso_token_handle_t sso_token_handle,
                    const char *name,
                    const char *value);

Parameters

This function takes the following parameters:

sso_token_handle

Pointer to a am_sso_token_handle_t type.

name

Pointer to the name of the property.

---

Caution –

If the specified property is protected by OpenSSO Enterprise, am_sso_set_property() will return success, but the value given will not be set.

---

value

Pointer to the value for the specified property.

Returns

This function returns one of the following values of the am_status_t enumeration (defined in the <am_types.h> header file):

AM_SUCCESS

If the property was successfully set.

AM_INVALID_ARGUMENT

If the sso_token_handle is invalid.

AM_FAILURE

If any other error occurred.