| NAME |
XUS IAM ADD USER |
| TAG |
IAMAU |
| ROUTINE |
XUESSO3 |
| RETURN VALUE TYPE |
ARRAY |
| AVAILABILITY |
SUBSCRIPTION |
| VERSION |
1 |
| APP PROXY ALLOWED |
No |
| DESCRIPTION |
RPC ICR #6290 - API ICR #none
This restricted RPC is used exclusively by the Identity and Access
Management (IAM) Provisioning application to add a user to the VistA NEW
PERSON file (#200).
The XUSPF200 Security Key is required to add a user without an SSN (file
#200 special privileges).
|
| INPUT PARAMETER |
-
- NAME
- PARAMETER TYPE: LITERAL
- MAXIMUM DATA LENGTH: 35
- REQUIRED: YES
- SEQUENCE NUMBER: 1
- DESCRIPTION:
NAME field (#.01) in the NEW PERSON file (#200) to match the SubjectID in
the user's SAML Token.
-
- SECID
- PARAMETER TYPE: LITERAL
- MAXIMUM DATA LENGTH: 30
- REQUIRED: YES
- SEQUENCE NUMBER: 2
- DESCRIPTION:
SECID field (#205.1) in the NEW PERSON file (#200) to match the SecID in
the user's SAML Token.
-
- EMAIL
- PARAMETER TYPE: LITERAL
- MAXIMUM DATA LENGTH: 50
- REQUIRED: NO
- SEQUENCE NUMBER: 3
- DESCRIPTION:
EMAIL field (#.151) in the NEW PERSON file (#200).
-
- ADUPN
- PARAMETER TYPE: LITERAL
- MAXIMUM DATA LENGTH: 50
- REQUIRED: NO
- SEQUENCE NUMBER: 4
- DESCRIPTION:
AD UPN field (#205.5) in the NEW PERSON file (#200) to match user's Active
Directory UPN.
-
- SSN
- PARAMETER TYPE: LITERAL
- MAXIMUM DATA LENGTH: 9
- REQUIRED: NO
- SEQUENCE NUMBER: 5
- DESCRIPTION:
SSN field (#9) in the NEW PERSON file (#200) to match the user's Social
Security Number or Taxpayer Identification Number. While not required to
provision a VistA user, not populating this field with a valid SSN could
prevent access to some applications and data in VistA.
-
- DOB
- PARAMETER TYPE: LITERAL
- MAXIMUM DATA LENGTH: 20
- REQUIRED: NO
- SEQUENCE NUMBER: 6
- DESCRIPTION:
DOB field (#5) in the NEW PERSON file (#200) to match the user's Date of
Birth.
-
- STATION
- PARAMETER TYPE: LITERAL
- MAXIMUM DATA LENGTH: 20
- REQUIRED: NO
- SEQUENCE NUMBER: 7
- DESCRIPTION:
DIVISION field (#.01) of the DIVISION multiple (#16) in the NEW PERSON
file (#200). The name of a Division that this user may sign on to. The
Division should be an active treating facility.
-
- AUTHCODE
- PARAMETER TYPE: LITERAL
- MAXIMUM DATA LENGTH: 80
- REQUIRED: YES
- SEQUENCE NUMBER: 8
- DESCRIPTION:
Security Phrase for IAM Provisioning Application.
|
| RETURN PARAMETER DESCRIPTION |
Fail R(0) = "-1^Number of Errors"
R(1) through R(n) = "Error Message"
Success R(0) = "DUZ^STATION"
|
