ibm-information-center/dist/eclipse/plugins/i5OS.ic.apis_5.4.0.1/ictxauthcontextinfo.htm

224 lines
8.5 KiB
HTML
Raw Normal View History

2024-04-02 14:02:31 +00:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML>
<HEAD>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="Copyright" content="Copyright (c) 2006 by IBM Corporation">
<TITLE>ictxAuthContextInfo - Authentication Context Information Parameter</TITLE>
<!-- Begin Header Records ========================================= -->
<!-- All rights reserved. Licensed Materials Property of IBM -->
<!-- US Government Users Restricted Rights -->
<!-- Use, duplication or disclosure restricted by -->
<!-- GSA ADP Schedule Contract with IBM Corp. -->
<!-- Change History: -->
<!-- YYMMDD USERID Change description -->
<!-- Edited by Kersten Jan 02 -->
<!-- Created by Therese Dalton on 17 July 2001 -->
<!--File edited for Tidy July 2001 -->
<!-- End Header Records -->
<link rel="stylesheet" type="text/css" href="../rzahg/ic.css">
</HEAD>
<BODY>
<a name="Top_Of_Page"></a>
<!--Java sync-link-->
<script type="text/javascript" language="Javascript" src="../rzahg/synch.js">
</script>
<!-- ============================================================== -->
<!-- -->
<!-- -->
<!-- ============================================================== -->
<H2>ictxAuthContextInfo--Authentication Context Information Parameter</H2>
<!-- ============================================================== -->
<!-- -->
<!-- D E S C R I P T I O N -->
<!-- -->
<!-- ============================================================== -->
<P>This contains information about the authentication context that will
be built or delegated.
See <a href="#eserver_notes">eServer Implementation
Notes</a> for details on platform-specific details.
For details on supported formats and required fields, please refer
to the documentation for the specific authentication context type.
Supported context types are:
<UL>
<LI>
<STRONG>ICTX_AUTH_CTX_TYPE1</STRONG>&nbsp;&nbsp;
<P>For details, see <A
href="ictxauthctxtype1.htm">
Authentication Context Type 1</A>.<BR>
</LI>
</UL>
<P>The layout for ictxAuthContextInfo follows:</P>
<PRE>
typedef struct ictxAuthContextInfo
{
enum ictxAuthContextInfoFormat format;
union
{
ictxAuthContextInfoFormat0_t format0;
ictxAuthContextInfoFormat1_t format1;
} contextInfo;
} ictxAuthContextInfo_t;
</PRE>
<P>
<BR>
<!-- ============================================================== -->
<!-- -->
<!-- F I E L D D E S C R I P T I O N S -->
<!-- -->
<!-- ============================================================== -->
<H3>
<A name=Header_41>Field Descriptions</A>
</H3>
<DL>
<!-- ============================================================== -->
<!-- format -->
<!-- ============================================================== -->
<DT>
<STRONG>format</STRONG>&nbsp;&nbsp;
<DD>Valid values for the format are:
<PRE>
enum ictxAuthContextInfoFormat {
ICTX_AUTHCTX_INFO_FORMAT_0,
ICTX_AUTHCTX_INFO_FORMAT_1
};
</PRE>
<P>When format is ICTX_AUTHCTX_INFO_FORMAT_0 (0), the <em>contextInfo</em> field
must contain an ictxAuthContextInfoFormat0_t structure.<BR>
<PRE>
typedef struct ictxAuthContextInfoFormat0
{
ictxAuthInfo_t * authData; /* Authentication data */
ictxAppInfo_t * sender; /* Sending application information
*/
ictxAppInfo_t * receiver; /* Intended receiving application
*/
ictxPremappedInfo_t * premappedUser; /* Premapped user information
*/
} ictxAuthContextInfoFormat0_t;
</PRE>
<P>When format is ICTX_AUTHCTX_INFO_FORMAT_1 (1), the <em>contextInfo</em> field
must contain an ictxAuthContextInfoFormat1_t structure.<BR>
<PRE>
typedef struct ictxAuthContextInfoFormat1
{
ictxAppInfo_t * sender; /* Sending application information
*/
ictxAppInfo_t * receiver; /* Intended receiving application
*/
ictxPremappedInfo_t * premappedUser; /* Premapped user information
*/
} ictxAuthContextInfoFormat1_t;
</PRE>
<!-- ============================================================== -->
<!-- authData -->
<!-- ============================================================== -->
<DT>
<STRONG>authData</STRONG>&nbsp;&nbsp;(Input)
<DD>The authenticated user information. This information will be
stored in the identity context.
For the format of the structure, see <A
href="ictxauthenticationinfo.htm">
ictxAuthenticationInfo--Authentication Context Authentication Info</A>.<BR>
<BR>
<!-- ============================================================== -->
<!-- sender -->
<!-- ============================================================== -->
<DT>
<STRONG>sender</STRONG>&nbsp;&nbsp;(Input)
<DD>The information that represents the application that is
requesting the building or delegating of the authentication context.
For the format of the structure, see <A
href="ictxapplicationinfo.htm">
ictxApplicationInfo--Authentication Context Application Info</A>.
<BR>
<BR>
<!-- ============================================================== -->
<!-- receiver -->
<!-- ============================================================== -->
<DT>
<STRONG>receiver</STRONG>&nbsp;&nbsp;(Input)
<DD>The information that represents the application that is the
intended target of the authentication context.
For the format of the structure, see <A
href="ictxapplicationinfo.htm">
ictxApplicationInfo--Authentication Context Application Info</A>.
<BR>
<BR>
<!-- ============================================================== -->
<!-- premappedUser -->
<!-- ============================================================== -->
<DT>
<STRONG>premappedUser</STRONG>&nbsp;&nbsp;(Input)
<DD>If mapping was done by the sending application,
then this contains information about the mapped usre..
For the format of the structure, see <A
href="ictxpremappedinfo.htm">
ictxPremappedInfo--Authentication Context Premapped User Info Parameter</A>.
<BR>
<BR>
</DL>
<BR>
<!-- ============================================================== -->
<!-- -->
<!-- E S E R V E R N O T E S -->
<!-- -->
<!-- ============================================================== -->
<h3>
<a name="eserver_notes">eServer Implementation Notes</a>
</h3>
<ol>
<li>
<strong>AIX implementation details:</strong>
<ul>
<li>
None.
</li>
</ul>
</li>
<li>
<strong>Linux implementation details:</strong>
<ul>
<li>
None.
</li>
</ul>
</li>
<li>
<strong>i5/OS implementation details:</strong><br>
<ul>
<li>
None.
</li>
</ul>
</li>
<li>
<strong>Windows implementation details:</strong>
<ul>
<li>
None.
</li>
</ul>
</li>
<li>
<strong>z/OS implementation notes:</strong><br>
<ul>
<li>
None.
</li>
</ul>
</li>
</ol>
<!-- ============================================================== -->
<!-- The End -->
<!-- ============================================================== -->
</BODY>
</HTML>