Fact
- PhenixID Identity Provisioning 5.0.0 or later
- Customer ID from IST
- API Key for the export from IST
Situation
This document will describe the action that can be used to run an export in IST and write the content in the response to a file. The file can then be used in our ordinary file handling actions and data sources.Solution
Download and install the action package
Download the zip file: ISTExportActionPackage.zip For instruction of how to install the action package, read PSD1149.Configure the action
The action will export information from IST and write the information to a file. The call to the IST web service will only be made once, no matter how many session objects that are present in the policy. The parameters for the IST Export action:|
Parameter |
Description |
|
API Key |
[Mandatory] The API Key provided by IST. Supports GLOBAL parameters. |
|
Customer Id |
[Mandatory] The customer ID provided by IST. Supports GLOBAL parameters. |
|
Web Service URL |
[Mandatory] The URl to the web service. Example: https://se-export.ist.com/se-export/rest/v1/export/. Supports GLOBAL parameters. |
|
Max Seconds to Wait for Response |
[Optional] The maximum amount of time, in seconds, to wait for the response. Default: 300. Supports GLOBAL parameters. |
|
Directory to Add a File Into |
[Optional] The directory to add a file into. Leave blank for system tmp directory. Supports GLOBAL parameters and SESSION attributes, but will only use attributes from the first session object. |
|
File Name |
[Optional] The name of the file including file extension. Leave blank to add random, unique name. Supports GLOBAL parameters and SESSION attributes, but will only use attributes from the first session object. |
|
Random File Name Extension |
[Optional] Create a random, unique file name with this file extension. Will be used if no other file name is specified. Default: .txt |
|
Session Attribute Storing File Name/Path |
[Optional] The attribute which stores the file name including path. |
|
Character Set |
[Optional] The file output character set, Example: UTF-8, ISO-8859-1 etc. Use UTF-8-NO-BOM to not write bom at the beginning of the file. Default is system charset. |
Example values
|
Parameter |
Value |
|
API Key |
FGHF5FDVKYYVBGDDRRTHGFRSSE543DHHNGDGHGFTUYH= |
|
Customer Id |
AB01234 |
|
Web Service URL |
https://se-export.ist.com/se-export/rest/v1/export/ |
|
Max Seconds to Wait for Response |
120 |
|
Directory to Add a File Into |
C:/IST-exports |
|
File Name |
ist-export-SESSION(todayDate).xml |
|
Random File Name Extension |
.xml |
|
Session Attribute Storing File Name/Path |
ist-export-filename |
|
Character Set |
ISO-8859-1 |
DISCLAIMER
Information provided in this document is for your information only. PhenixID makes no explicit or implied claims to the validity of this information. Any trademarks referenced in this document are the property of their respective owners.The origin of this information may be internal or external to PhenixID. PhenixID makes all reasonable efforts to verify this information.
PhenixID - support.phenixid.se