kernel-api-docs/chkprmit-xwbsec.html at master · hardhats/kernel-api-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
<HTML>
  <HEAD>
<!--VA Office of Information and Technology (OIT)-->
<!--Oakland OIFO-->
<!-- START: META DATA -->
    <meta http-equiv="Content-Type"
	      content="text/html; charset=iso-8859-1">
    <meta name="language"
	      content="en">
    <meta name="creator"
	      content="Department of Veterans Affairs (VA), Office of Information and Technology (OIT), VistA Infrastructure (VI)">
    <meta name="subject"
	      content="RPC Broker APIs: CHKPRMIT^XWBSEC">
    <meta name="keywords"
	      content="VistA Infrastructure,VI,Infrastructure,Infrastructure and Security Services,Information Infrastructure Service,OIT,OI&T,ISS,IIS,VISTA,rpc broker,broker,rpc,programmer,developer,programmer manual,developer guide,apis,application programming interface,application,programming,interface,entry point,CHKPRMIT^XWBSEC,CHKPRMIT,XWBSEC,context,supported">
    <meta name="description"
	      content="RPC Broker APIs: CHKPRMIT^XWBSEC">
    <meta name="datecreated"
	      content="20010101">
    <meta name="datereviewed"
	      content="20180808">
    <meta name="type"
	      content="Homepage">
<!-- END: META DATA -->
    <title>RPC Broker APIs: CHKPRMIT^XWBSEC</title>
    <LINK REL="StyleSheet"
          TYPE="text/css"
          HREF="common/developer.css">
  </HEAD>
  <BODY>
    <header>
<!--Start Title Banner (image)-->
    <TABLE BORDER="0"
	       WIDTH="100%"
	       CELLSPACING="3"
	       CELLPADDING="3"
	       SUMMARY="This table is for formatting purposes only">
	  <TR>
	    <TD VALIGN="top"
	        ALIGN="left">
		  <IMG SRC="images/broker_heading_APIs.gif"
			   ALT="RPC Broker 1.1 APIs Banner"
			   BORDER="0">
		  <BR>
		  <IMG SRC="images/oitbanner.gif"
			   ALT="Office of Information and Technology (OIT) Banner"
			   BORDER="0">
	    </TD>
	  </TR>
    </TABLE>
	<A HREF="#navskip">
	<IMG SRC="images/clr_pxl.gif"
		 ALT="[skip navigation]"
		 WIDTH="25"
		 HEIGHT="1"
		 BORDER="0"></A>
<!--End Title Banner (image)-->
    </header>
<!-- Start Content -->
    <H3><A NAME="navskip">CHKPRMIT^XWBSEC()</A>: Check Permissions</H3>
	<P><B>Reference Type:</B> Controlled Subscription, <B>Category:</B> Signon/Security,
	<B>ICR#:</B> 4053</P>
	<H4><A NAME="description">Description</A></H4>
	<P>The CHKPRMIT^XWBSEC API checks to see if the remote procedure is permitted to run. It checks for:</P>
	<ul>
	  <li>
	    User-held security keys
	    <br>
	    <br>
	  </li>
	  <li>
	    User context (context option)
	    <br>
	    <br>
	  </li>
	  <li>
	    Out-of-order settings
	    <br>
	    <br>
	  </li>
	  <li>
	    RPC version
	  </li>
	</ul>
	<p>If the user is an Application Proxy, it checks to see if Application Proxy access to the remote procedure is permitted.</p>
	<p>Some remote procedures are allowed in any context:</p>
	<ul>
	  <li valign="top"
	      align="left">
	    XUS BSE TOKEN
	    <br>
	    <br>
	  </li>
	  <li valign="top"
	      align="left">
	    XUS CVC
	    <br>
	    <br>
	  </li>
	  <li valign="top"
	      align="left">
	    XUS GET USER INFO
	    <br>
	    <br>
	  </li>
	  <li valign="top"
	      align="left">
	    XUS GET TOKEN
	    <br>
	    <br>
	  </li>
	  <li valign="top"
	      align="left">
	    XUS IAM BIND USER
	    <br>
	    <br>
	  </li>
	  <li valign="top"
	      align="left">
	    XUS KAAJEE GET USER INFO
	    <br>
	    <br>
	  </li>
	  <li valign="top"
	      align="left">
	    XUS KAAJEE LOGOUT
	    <br>
	    <br>
	  </li>
	  <li valign="top"
	      align="left">
	    XUS KEY CHECK
	    <br>
	    <br>
	  </li>
	  <li valign="top"
	      align="left">
	    XUS SET VISITOR
	    <br>
	    <br>
	  </li>
	  <li valign="top"
	      align="left">
	    XWB CREATE CONTEXT
	    <br>
	    <br>
	  </li>
	  <li valign="top"
	      align="left">
	    XWB IM HERE
	    <br>
	    <br>
	  </li>
	  <li valign="top"
	      align="left">
	    XWB IS RPC AVAILABLE
	    <br>
	    <br>
	  </li>
	  <li valign="top"
	      align="left">
	    XWB RPC LIST
	  </li>
	</ul>
	<p>All Kernel &#8220;<strong>XUS</strong>&#8221; and RPC Broker &#8220;<strong>XWB</strong>&#8221; remote procedures are allowed in &#8220;XUS SIGNON&#8221; context.</p>
	<H4><A NAME="format">Format</A></H4>
	<PRE>  CHKPRMIT^XWBSEC(xwbrp)</PRE>
	<p>Make sure to perform the following steps before calling this API:</p>
	<ol>
	  <li valign="top"
	      align="left">
	    <strong>NEW</strong> all <em>non</em>-namespaced variables.
	    <br>
	    <br>
	  </li>
	  <li valign="top"
	      align="left">
	    Set all input variables.
	    <br>
	    <br>
	  </li>
	  <li valign="top"
	      align="left">
	    Call the API.
	  </li>
	</ol>
	<H4><A NAME="input_parameters">Input Parameters</A></H4>
	<TABLE BORDER="1"
	       CELLPADDING="5"
	       BGCOLOR="#F1F2F3"
	       BORDERCOLORLIGHT="#F1F2F3"
	       BORDERCOLORDARK="#808080"
	       WIDTH="100%">
	  <TR>
	    <TD VALIGN="TOP"
	        WIDTH="15%">xwbrp:
	    </TD>
		<TD VALIGN="TOP"
		    WIDTH="85%">
		  <P>(required) This is the name of the remote procedure to look up in the REMOTE PROCEDURE
			(#8994) file.</P>
	    </TD>
	  </tr>
	</TABLE>
	<H4><A NAME="output">Output Variables</A></H4>
	<TABLE BORDER="1"
	       CELLPADDING="5"
	       BGCOLOR="#F1F2F3"
	       BORDERCOLORLIGHT="#F1F2F3"
	       BORDERCOLORDARK="#808080"
	       WIDTH="100%">
	  <TR>
		<TD VALIGN="TOP"
		    WIDTH="15%">
		  <B>XWBSEC:</B>
		</TD>
		<TD VALIGN="TOP"
		    WIDTH="85%">
		  <P>Returns:
		    <ul>
		      <li>
		        <strong>&#8220;&#8221;&#8212;</strong>Null in <strong>XWBSEC</strong> environment variable if the remote procedure is permitted to run.
		        <br>
		        <br>
		      </li>
		      <li>
		        <strong>Error Message&#8212;</strong>If the remote procedure is not permitted. If an error is returned, then the
				<strong>XWBSEC</strong> environment variable is set to return the same error message.
		      </li>
		    </ul>
		    </p>
		    <p><strong>NOTE:</strong> <strong>XWBSEC</strong> is an environment variable, so that the information is included in the error trap should a subsequent processing error occur.</p>
	    </TD>
	  </TR>
	</TABLE>
	<P>&nbsp;</P>
<!-- End Content -->
    <footer>
	<HR COLOR="003399">
	<TABLE WIDTH="100%"
	       SUMMARY="This table for layout purposes only"
	       CLASS="white">
	  <TR>
	    <TD ALIGN="CENTER"
	        VALIGN="TOP">
<!--Start Bottom Links-->
          <P ALIGN="CENTER">
          <A HREF="http://www.va.gov/"
	         CLASS="bodylink"
	         TARGET="_top"
	         TITLE="Department of Veterans Affairs Internet Home Page">
	         <ACRONYM TITLE="Department of Veterans Affairs">VA</ACRONYM> (Internet)</A> /

          <A HREF="http://vaww.va.gov/"
             CLASS="bodylink"
             TARGET="_top"
	         TITLE="Department of Veterans Affairs Intranet Home Page">
	         <ACRONYM TITLE="Department of Veterans Affairs">VA</ACRONYM>(Intranet)</A> /

          <A HREF="http://vaww.va.gov/vhaoi/"
             CLASS="bodylink"
             TARGET="_top"
	         TITLE="Office of Information Home Page">
	         <ACRONYM TITLE="Veterans Health Adminstration Office of Health Information (OHI)">VHA OHI</ACRONYM></A> /

          <A HREF="https://vaww.oit.va.gov/"
             CLASS="bodylink"
             TARGET="_top"
	         TITLE="Office of Information and Technology Home Page">
	         <ACRONYM TITLE="Office of Information and Technology (OIT)">OIT</ACRONYM></A> /

          <A HREF="http://vista.med.va.gov/"
             CLASS="bodylink"
             TARGET="_top"
	         TITLE="Product Development (PD) Home Page">
             <ACRONYM TITLE="Product Development">PD</ACRONYM></A> /

          <A HREF="http://vista.med.va.gov/termsofuse.htm"
             CLASS="bodylink"
             TARGET="_top"
     	     TITLE="Product Development (PD) Terms of Use Page">Terms of Use</A> /

          <A HREF="http://www.va.gov/privacy/"
             CLASS="bodylink"
             TARGET="_top"
	         TITLE="Department of Veterans Affairs Privacy Policy">VA Privacy Policy</A> /

          <A HREF="http://www1.va.gov/accessible/"
             CLASS="bodylink"
             TARGET="_top"
	         TITLE="Department of Veterans Affairs Internet Accessibility">Accessibility</A></P>
<!--End Bottom Links-->
<!--Date content was reviewed or updated-->
          <P ALIGN="CENTER">Reviewed/Updated: 08/08/2018
		  <BR>
		  <BR>
		  For questions, comments, or accessibility issues with this website, please contact us by E-Mail:
		  <A HREF="mailto:VHAISFCVTECH@med.va.gov?subject=Web page comments from: /apis/chkprmit-xwbsec.html"
			 TITLE="Send mail to the Webmasters regarding this page"
			 class="bodylink">Webmasters</A></P>
		  <P>&nbsp;</P>
	    </TD>
	  </TR>
    </TABLE>
    </footer>
  </BODY>
</HTML>