Sm_AgentApi_DecodeSSOToken()

シングル サインオン トークンをデコードし、その属性のサブセットを返します。オプションで、トークンの最終アクセスのタイムスタンプを更新し、次に新しいトークンで SMSESSION Cookie を更新できます。
casso127jpjp
シングル サインオン トークンをデコードし、その属性のサブセットを返します。オプションで、トークンの最終アクセスのタイムスタンプを更新し、次に新しいトークンで SMSESSION Cookie を更新できます。
構文
int SM_EXTERN Sm_AgentApi_DecodeSSOToken (
   const void*                  
pHandle
,
   const char*                  
lpszSSOToken
,
   long*                        
nTokenVersion
,
   long*                        
pThirdPartyToken
,
   long*                        
pNumAttributes
,
   Sm_AgentApi_Attribute_t**    
ppTokenAttributes
,
   long                         
nUpdateToken
,
   long*                        
pNumUpdatedSSOTokenLength
,
   char*                        
lpszUpdatedSSOToken
);
パラメータ
I/O
説明
pHandle
I
Sm_AgentApi_Init() の
ppHandle
パラメータで返されるエージェント API セッション ハンドル。
lpszSSOToken
I
デコードされるトークンが含まれる Null 終端文字配列。カスタム エージェントは、以下の場所のいずれかでトークンを検索します。
  • カスタム エージェントによってトークンが作成されている場合、トークンは、Sm_AgentApi_CreateSSOToken() コールからの出力パラメータ
    lpszSSOToken
    で返されます。カスタム エージェントは、Cookie の内容を抽出し、このパラメータに割り当てる役割を持ちます。
  • 標準 Web エージェントがトークンを生成すると、そのトークンは SMSESSION Cookie 内にあります。
nTokenVersion
O
トークンのバージョン。
pThirdParty
Token
O
値がゼロ以外の場合、トークンが元々カスタム(サードパーティ)エージェントによって作成されたものであり、標準 Web エージェントによってまだ更新されていないことを示します。
pNumAttributes
O
トークンから取得した属性の数。属性は、
ppTokenAttributes
パラメータで指定されます。
ppToken
Attributes
O
トークンから抽出された属性。有効な値は以下のとおりです。
SM_AGENTAPI_ATTR_USERDN
SM_AGENTAPI_ATTR_SESSIONSPEC
SM_AGENTAPI_ATTR_SESSIONID
SM_AGENTAPI_ATTR_USERNAME
SM_AGENTAPI_ATTR_CLIENTIP
SM_AGENTAPI_ATTR_DEVICENAME
SM_AGENTAPI_ATTR_IDLESESSIONTIMEOUT
SM_AGENTAPI_ATTR_MAXSESSIONTIMEOUT
SM_AGENTAPI_ATTR_STARTSESSIONTIME
SM_AGENTAPI_ATTR_LASTSESSIONTIME
SM_AGENTAPI_ATTR_SSOZONE
SM_AGENTAPI_ATTR_SESSION_DOMAIN
nUpdateToken
I
値がゼロ以外の場合、更新されたトークンがリクエストされていることを示します。更新されたトークンは、
lpszUpdatedSSOToken
に書き込まれます。
属性 SM_AGENTAPI_ATTR_LASTSESSIONTIME を更新する場合は、
nUpdateToken
フラグをゼロ以外に設定してください。
pNumUpdatedSSO
TokenLength
I、O
トークンを受信するための
lpszUpdatedSSOToken
バッファの長さ。SSO_TOKEN_MAX_SIZE パラメータは最大サイズを定義します。 このパラメータは、SmAgentAPI.h で定義されます。Null 終端文字のためのスペースも含まれます。
出力時、このパラメータは、Null 終端文字の文字も含めて、返されたトークンの実際の長さに設定されます。
lpszUpdated
SSOToken
O
この関数から返された更新済みトークン。このトークンを SMSESSION Cookie に書き込んでください。
nUpdateToken
がゼロ以外の値に設定されている場合にのみ、トークンが返されます。
 
戻り値
  • SM_AGENTAPI_SUCCESS。操作は成功しました。
  • SM_AGENTAPI_FAILURE。トークンはデコードされませんでした。
  • SM_AGENTAPI_NOCONNECTION。初期化できませんでした。
注釈
この関数は、シングル サインオン トークンを入力として受け取り、トークン属性のサブセットを返します。
トークンの最終アクセスのタイムスタンプを更新できます。更新する場合には、
nUpdateToken
パラメータにゼロ以外の値を割り当ててください。更新されたタイム スタンプが含まれるトークンが
lpszUpdatedSSOToken
で返されます。更新済みのトークンを SMSESSION Cookie に書き込んでください。
この関数は、属性リスト用にメモリを割り当てます。このメモリを解放するには、Sm_AgentApi_FreeAttributes() をコールします。
シングル サインオン トークンを作成するには、Sm_AgentApi_CreateSSOToken() をコールします。