Sm_AgentApi_Attribute_t
この構造体は、レスポンス属性に関する情報を定義します。
casso126jjp
この構造体は、レスポンス属性に関する情報を定義します。
構文
この構造体の形式は以下のとおりです。
typedef struct Sm_AgentApi_Attribute_s{longnAttributeId;longnAttributeTTL;longnAttributeFlags;charlpszAttributeOid[SM_AGENTAPI_SIZE_OID];longnAttributeLen;char*lpszAttributeValue;} Sm_AgentApi_Attribute_t;
[Parameters]
この構造体には以下のパラメータがあります。
- nAttributeIdレスポンス属性の ID。
- nAttributeTTLレスポンス属性の存続期間(TTL)の値(秒)。属性は TTL 値の期間中キャッシュに保持されます。
- nAttributeFlagsレスポンス属性フラグ。このフラグは、以下のセッション ストア 関数で使用されます。
- Sm_AgentApi_DelSessionVariables()
- Sm_AgentApi_GetSessionVariables()
- Sm_AgentApi_SetSessionVariables()
- lpszAttributeOidレスポンス属性オブジェクト識別子。
- nAttributeLenレスポンス属性の長さ。
- lpszAttributeValueレスポンス属性の Null 終端属性値。
注釈
以下の既知の認証属性は、Sm_AgentApi_Login() によって返され、Sm_AgentApi_Attribute_t 構造体の nAttributeId フィールドで参照されます。
- SM_AGENTAPI_ATTR_AUTH_DIR_OIDユーザが認証されたディレクトリの Siteminder オブジェクト ID。これは、CA Single Sign-onユーザ ディレクトリに割り当てられた内部オブジェクト ID です。
- SM_AGENTAPI_ATTR_AUTH_DIR_NAMEユーザが認証されたディレクトリのCA Single Sign-on「name」指定。これは、CA Single Sign-onの[ユーザ ディレクトリ]ダイアログ ボックスで指定されたディレクトリ名です。
- SM_AGENTAPI_ATTR_AUTH_DIR_SERVERユーザが認証されたディレクトリのCA Single Sign-on「server」指定。これは、CA Single Sign-onの[ユーザ ディレクトリ]ダイアログ ボックスで指定されたディレクトリ サーバです。
- SM_AGENTAPI_ATTR_AUTH_DIR_NAMESPACEユーザが認証されたディレクトリのCA Single Sign-on「namespace」指定。これは、CA Single Sign-onの[ユーザ ディレクトリ]ダイアログ ボックスで指定されたディレクトリ ネームスペース(LDAP:、ODBC:、WinNT:、AD:)です。
- SM_AGENTAPI_ATTR_USERMSG認証の結果としてユーザに示されたテキスト。認証方式によっては、認証リクエスト時のテキストや認証に失敗した理由が表示されます。この属性に対する値は、SmAuthenticate() のlpszUserMsgパラメータによって提供できます。
- SM_AGENTAPI_ATTR_USERDNCA Single Sign-onによって認識されているユーザの識別名。この属性は、シングル サインオン操作でも使用されます。
- SM_AGENTAPI_ATTR_USERUNIVERSALIDユーザ ディレクトリに設定されているユーザ ユニバーサル ID。
- SM_AGENTAPI_ATTR_IDENTITYSPECユーザの識別チケットです。CA Single Sign-onは、ユーザ追跡機能が有効化されている場合にこれを返します。
以下の既知の属性がシングル サインオン操作で使用され、Sm_AgentApi_Attribute_t 構造体の nAttributeId フィールドで参照されます。
- SM_AGENTAPI_ATTR_USERDNユーザの識別名。
- SM_AGENTAPI_ATTR_SESSIONSPECログイン コールから返されたセッション仕様。
- SM_AGENTAPI_ATTR_SESSIONIDログイン コールから返されたセッション ID。
- SM_AGENTAPI_ATTR_USERNAMEユーザの名前。
- SM_AGENTAPI_ATTR_CLIENTIP保護されているリソースに対してユーザがリクエストを開始したマシンの IP アドレス。
- SM_AGENTAPI_ATTR_DEVICENAMEトークンをデコードしているエージェントの名前です。
- SM_AGENTAPI_ATTR_IDLESESSIONTIMEOUTセッションの最大アイドル時間。
- SM_AGENTAPI_ATTR_MAXSESSIONTIMEOUTユーザがタイムアウト期間内にリフレッシュまたは再ログインしない場合、セッションは終了します。
- SM_AGENTAPI_ATTR_STARTSESSIONTIMEセッションが成功した後、ログインが開始された時刻。
- SM_AGENTAPI_ATTR_LASTSESSIONTIME(エージェントまたは CreateSSOToken または DecryptSSOToken を使用してエージェント API で)、Cookie の SMSESSION トークンが最後に更新された時間。
- SM_AGENTAPI_ATTR_SSOZONESSO ゾーン名を指定します。これは、Sm_AgentApi_CreateSSOToken メソッドをコールする場合に提供します。ゾーン名を指定しない場合、デフォルトは "SM" です。この値は、Sm_AgentApi_DecodeSSOToken メソッドによって返される属性リストで読み取ることができます。
以下の既知の管理属性は、Sm_AgentApi_DoManagement() によって返され、Sm_AgentApi_Attribute_t 構造体の nAttributeId フィールドで参照されます。
- SM_AGENTAPI_AFFILIATE_KEY_UPDATEアフィリエイト エージェントの名前を更新するようにエージェントに指示します。
- SM_AGENTAPI_AGENT_KEY_UPDATE_NEXT「next」エージェント キーを更新するようにエージェントに指示します。値には、バイナリ データの 24 バイトが含まれます。
- SM_AGENTAPI_AGENT_KEY_UPDATE_LAST「last」エージェント キーを更新するようにエージェントに指示します。値には、バイナリ データの 24 バイトが含まれます。
- SM_AGENTAPI_AGENT_KEY_UPDATE_CURRENT「current」エージェント キーを更新するようにエージェントに指示します。値には、バイナリ データの 24 バイトが含まれます。
- SM_AGENTAPI_AGENT_KEY_UPDATE_PERSISTENTスタティック(永続)エージェント キーを更新するようにエージェントに指示します。値には、バイナリ データの 24 バイトが含まれます。
- SM_AGENTAPI_CACHE_FLUSH_ALLキャッシュ内のすべての情報をクリアするようにエージェントに指示します。
- SM_AGENTAPI_CACHE_FLUSH_ALL_USERSキャッシュに保存されたすべてのユーザ情報をクリアするようにエージェントに指示します。
- SM_AGENTAPI_CACHE_FLUSH_THIS_USER指定されたユーザに関連するすべてのキャッシュ情報をクリアするようにエージェントに指示します。値には、<user dir oid> / <user dn> が含まれます。
- SM_AGENTAPI_CACHE_FLUSH_ALL_REALMSキャッシュに保存されたすべてのリソース情報をクリアするようにエージェントに指示します。
- SM_AGENTAPI_CACHE_FLUSH_THIS_REALM指定されたレルムに関連するすべてのリソース情報をクリアするようにエージェントに指示します。値は、レルム OID です。