Sm_AgentApi_Attribute_t

この構造体は、レスポンス属性に関する情報を定義します。
casso127jpjp
この構造体は、レスポンス属性に関する情報を定義します。
構文
この構造体の形式は以下のとおりです。
typedef struct Sm_AgentApi_Attribute_s
{
   long 
nAttributeId
;
   long 
nAttributeTTL
;
   long 
nAttributeFlags
;
   char 
lpszAttributeOid
[SM_AGENTAPI_SIZE_OID];
   long 
nAttributeLen
;
   char* 
lpszAttributeValue
;
} Sm_AgentApi_Attribute_t;
[Parameters]
この構造体には以下のパラメータがあります。
  • nAttributeId
    レスポンス属性の ID。
  • nAttributeTTL
    レスポンス属性の存続期間(TTL)の値(秒)。属性は TTL 値の期間中キャッシュに保持されます。
  • nAttributeFlags
    レスポンス属性フラグ。このフラグは、以下のセッション ストア 関数で使用されます。
    • Sm_AgentApi_DelSessionVariables()
    • Sm_AgentApi_GetSessionVariables()
    • Sm_AgentApi_SetSessionVariables()
    詳細については、これらの関数の ppRespAttributes パラメータを参照してください。
  • 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_USERDN
    CA 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_SSOZONE
    SSO ゾーン名を指定します。これは、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 です。