Sm_AgentApi_CreateSSOToken()
標準 Web エージェントおよびカスタム エージェントが共有可能な、セッションおよび他の情報の暗号化済みトークンを作成します。この共有情報によって、カスタム エージェントはシングル サインオン環境で標準 Web エージェントと共に動作できます。
casso126jjp
標準 Web エージェントおよびカスタム エージェントが共有可能な、セッションおよび他の情報の暗号化済みトークンを作成します。この共有情報によって、カスタム エージェントはシングル サインオン環境で標準 Web エージェントと共に動作できます。
構文
int SM_EXTERN Sm_AgentApi_CreateSSOToken (const void* pHandle,Sm_AgentApi_Session_t* pSession,long nNumAttributes,Sm_AgentApi_Attribute_t* pTokenAttributes,long* pNumSSOTokenLength,char* lpszSSOToken);
パラメータ | I/O | 説明 |
pHandle
| I | Sm_AgentApi_Init() の ppHandle パラメータで返されるエージェント API セッション ハンドル。 |
pSession
| I | Sm_AgentApi_Login() コールによって返されるセッション情報。 |
nNum Attributes
| I | トークンに含める属性の数。属性は pTokenAttributes パラメータで指定されます。 |
pToken Attributes
| I | SSO トークンに含めるユーザ属性。有効な値は以下のとおりです。
この関数に適用される Sm_AgentApi_Attribute_t 構造体のフィールドは以下のとおりです。
|
pNumSSOToken Length
| I,O | トークンを受信するために渡された lpszSSOToken バッファの長さ。最大サイズは、SmAgentAPI.h で定義される SSO_TOKEN_MAX_SIZE によって指定されます。Null 終端文字のためのスペースも含まれます。出力時、このパラメータは、Null 終端文字の文字も含めて、返されたトークンの実際の長さに設定されます。 |
lpszSSOToken
| O | この関数から返されたトークン。このトークンを SMSESSION Cookie に書き込んでください。 |
戻り値
- SM_AGENTAPI_SUCCESS - 操作は成功しました。
- SM_AGENTAPI_FAILURE - トークンは作成されませんでした。
- SM_AGENTAPI_NOCONNECTION - 初期化は行われませんでした。
注釈
この関数は、
pTokenAttributes
パラメータで指定されたユーザ属性情報を、Sm_AgentApi_Login() コールから返されたセッションおよび他の属性情報に関連付けます。結果として得られるトークン内の情報は、標準の Web エージェントとカスタム エージェントの間で共有することができ、2 つのエージェント間のシングル サインオン操作が可能になります。 このコールはメモリを割り当てません。トークン情報をデコードするには、Sm_AgentApi_DecodeSSOToken() をコールします。