Discover Header Fields
post
/iam/governance/applicationmanagement/api/v1/applications/headers
Discover the header fields in Flat File.
Request
Supported Media Types
- application/json
Query Parameters
-
filelocation(optional): string
Location of flat file from which headers have to be discovered
Details of the application for which header fields need to be discovered
Root Schema : Application
Type:
Show Source
object
-
advanceConfig:
array advanceConfigurations
-
applicationDisplayName(optional):
string
-
applicationName:
string
-
authoritative(optional):
boolean
Default Value:
false
-
baseApplicationName(optional):
string
-
basicConfig(optional):
array basicConfigurations
-
catalogAttribute(optional):
array catalogAttributes
-
connectorDeploymentPath(optional):
string
-
connectorDisplayName:
string
-
connectorVersion:
string
-
deploymentMode(optional):
string
Allowed Values:
[ "Local", "Remote" ]
-
description(optional):
string
-
disconnected(optional):
boolean
Default Value:
false
-
objectClass:
array objectClass
-
organization:
array organizations
-
ownerUserName(optional):
string
-
parentApplicationName(optional):
string
-
status(optional):
string
Allowed Values:
[ "ENABLED", "DISABLED", "ACTIVE", "DELETED" ]
Nested Schema : ProvisioningConfig
Type:
Show Source
object
-
accountDiscriminator(optional):
string
-
accountName(optional):
string
-
allowMultiple(optional):
boolean
Default Value:
false
-
capability(optional):
array capabilities
-
caseSensitive(optional):
boolean
Default Value:
false
-
failedTaskAssignConfig(optional):
object FailedTaskAssignConfig
-
failedTaskRetryConfig(optional):
object FailedTaskRetryConfig
-
transformationScript(optional):
string
-
validationScript(optional):
string
Nested Schema : SchemaAttribute
Type:
Show Source
object
-
advanceFlags(optional):
string
-
dataType(optional):
string
Allowed Values:
[ "Byte", "Double", "Int", "String", "Short", "Long", "Date", "Boolean", "ByteArray" ]
-
defaultValue(optional):
string
-
dependentAttribute(optional):
string
-
displayName(optional):
string
-
encrypted(optional):
boolean
Default Value:
false
-
entitlement(optional):
boolean
Default Value:
false
-
fieldType(optional):
string
-
identityAttribute(optional):
string
-
keyField(optional):
boolean
Default Value:
false
-
keyFieldCaseInsensitive(optional):
boolean
Default Value:
false
-
length(optional):
integer(int32)
-
listOfValues(optional):
string
-
name(optional):
string
-
provideOldValueOnUpdate(optional):
boolean
Default Value:
false
-
provisionable(optional):
boolean
Default Value:
false
-
reconcileable(optional):
boolean
Default Value:
false
-
reconStagingName(optional):
string
-
required(optional):
boolean
Default Value:
false
-
udColName(optional):
string
Nested Schema : ActionScript
Type:
Show Source
object
-
language(optional):
string
-
script(optional):
string
-
target(optional):
string
Allowed Values:
[ "Connector", "Resource" ]
-
triggerTime(optional):
string
Allowed Values:
[ "Before", "After" ]
Nested Schema : CorrelationRuleElement
Type:
Show Source
object
-
caseSensitive(optional):
boolean
Default Value:
false
-
elementOperator(optional):
string
Allowed Values:
[ "Equals", "Contains", "Starts_With", "Ends_With" ]
-
targetAttribute(optional):
string
-
transformName(optional):
string
-
transformParams(optional):
array transformParams
-
userAttribute(optional):
string
Nested Schema : ReconJobDetail
Type:
Show Source
object
-
jobName(optional):
string
-
mode(optional):
string
Allowed Values:
[ "Full", "Incremental", "Delete", "Entitlement", "Flat File Full", "Flat File Diff Sync", "Flat File Delete Sync", "Flat File Entitlement", "Flat File Delete" ]
-
parameter(optional):
array parametersList
Nested Schema : ReconJobParameter
Type:
Show Source
object
-
dataType(optional):
string
Allowed Values:
[ "String", "Number", "Boolean", "ITResource" ]
-
encrypted(optional):
boolean
Default Value:
false
-
helpText(optional):
string
-
name(optional):
string
-
required(optional):
boolean
Default Value:
false
-
value(optional):
string
Nested Schema : SituationResponse
Type:
Show Source
object
-
response(optional):
string
Allowed Values:
[ "link", "none", "createUser", "createOrganization", "assignToAdminWithLeastLoad", "assignToAuthWithLeastLoad", "assignToAuthWithHighestPriority", "assignToGroup", "assignToUser" ]
-
situation(optional):
string
Allowed Values:
[ "noMatch", "singleMatch", "multipleMatch", "oneProcessMatch", "multipleProcessMatch" ]
Nested Schema : Organization
Type:
Show Source
object
-
heirarchy(optional):
boolean
Default Value:
false
-
name(optional):
string
-
type(optional):
string
Response
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : items
Type:
object
Examples
cURL Example
This example demonstrates the ability to discover the header fields in Flat File. The information shown here is against a pseudo system and serves as a prototype.
curl -X POST http://pseudo.com/iam/governance/applicationmanagement/api/v1/applications/headers -H 'content-type: application/json' -d @flatfile.json
Request Body Example
{"applicationName":"Test Flat File","applicationDisplayName":"Test Flat File","connectorDisplayName":"Flat File Connector","connectorVersion":"11.1.1.6.0","connectorDeploymentPath":"/scratch/sagambhi/devtools/Middleware/idm/server/ConnectorDefaultDirectory/FlatFile-11.1.1.6.0","flatFile":true,"basicConfigurations":{"basicConfig":[{"name":"Connector Server Name","value":"","required":false}]},"advanceConfigurations":{"advanceConfig":[{"name":"Connector Name","value":"org.identityconnectors.flatfile.FlatFileConnector","required":false},{"name":"Bundle Name","value":"org.identityconnectors.flatfile","required":false},{"name":"Bundle Version","value":"1.0.1115","required":false},{"name":"User Configuration Lookup","value":"","required":false},{"name":"textQualifier","value":"\"","helpText":"Flat File Text Qualifier","dataType":"char","required":false},{"name":"fieldDelimiter","value":",","helpText":"Flat File Field Delimiter","dataType":"String","required":false},{"name":"subFieldDelimiter","value":"#","helpText":"Flat File Sub Field Delimiter","dataType":"String","required":false},{"name":"multiValueDelimiter","value":";","helpText":"Flat File Multi Value Data Delimiter","dataType":"String","required":false},{"name":"status Enable Mapping","value":"Enabled","required":false},{"name":"status Disable Mapping","value":"Disabled","required":false},{"name":"System Date Format","value":"ddMMyy","required":false},{"name":"flatFileLocation","value":"/scratch/sagambhi/repoo/ffdata/users.csv","required":false}]},"objectClass":[{"name":"User","provisioningConfig":{"capabilities":{"capability":[{"actionName":"manual fullfilement","enabled":false}]}},"reconConfig":{"reconJobDetails":{"jobDetail":[{"jobName":"ff1 Test Flat File FF Full Recon Job","mode":"Flat File Full","parametersList":{"parameter":[{"name":"FlatFile Instance Name","value":"ff1","helpText":"Application Name","dataType":"String"},{"name":"Flat File directory","value":"","helpText":"Flat File directory","dataType":"String"}]}},{"jobName":"ff1 Test Account Flat File FF Full Recon Job","mode":"Flat File Full","parametersList":{"parameter":[{"name":"FlatFile Instance Name","value":"ff1","helpText":"Application Name","dataType":"String"},{"name":"Flat File directory","value":"/net/host/scratch/yykumar/devtools/Middleware/idm/server/ConnectorDefaultDirectory/FlatFile-11.1.1.6.0/mats_data/account","helpText":"Flat File directory","dataType":"String"}]}},{"jobName":"ff1 Test Flat File FF Group Lookup Recon Job","mode":"Flat File Entitlement","parametersList":{"parameter":[{"name":"FlatFile Instance Name","value":"ff1","helpText":"Application Name","dataType":"String"},{"name":"Flat File directory","value":"/scratch/FF_DEMO_DATA/groups","helpText":"Flat File directory","dataType":"String"},{"name":"Lookup Name","value":"Lookup.FF.Groups","helpText":"Lookup Name","dataType":"String"},{"name":"Code Key Attribute","value":"__NAME__","helpText":"Code Key attribute","dataType":"String"},{"name":"Decode Attribute","value":"__NAME__","helpText":"DeCode attribute","dataType":"String"},{"name":"Is Entitlement","value":"true","helpText":"Is Entitlement","dataType":"String"},{"name":"Target Application Instance Name","value":"","helpText":"Target Application Instance Name","dataType":"String"}]}}]},"identityCorrelationRule":{"ruleOperator":"AND","ruleElement":[{"targetAttribute":"__NAME__","userAttribute":"User Login","elementOperator":"Equals","transformName":"NONE"}]},"situationResponses":{"situationResponse":[{"situation":"No Matches Found","response":"None"},{"situation":"One Entity Match Found","response":"Establish Link"},{"situation":"One Process Match Found","response":"Establish Link"}]},"isSimpleCorelationRule":"simple","complexCorrealtionRule":""},"form":{"form":[]}}],"catalogAttributes":{"catalogAttribute":[{"name":"Category","required":false},{"name":"User Defined Tags","required":false},{"name":"Requestable","value":"true","required":false},{"name":"Approver User","required":false},{"name":"Approver Role","required":false},{"name":"Fulfilment User","required":false},{"name":"Fulfilment Role","required":false},{"name":"Certifiable","value":"false","required":false},{"name":"Certifier User","required":false},{"name":"Certifier Role","required":false},{"name":"Audit Objective","required":false},{"name":"Auditable","value":"false","required":false},{"name":"Risk Level","required":false}]},"organizations":{"organization":[]},"status":"ACTIVE"}
Response Body Example
{ "Item":[ { "type":"string", "value":"__PARENTCN__" }, { "type":"string", "value":"UID" }, { "type":"string", "value":"OIM Employee Type" }, { "type":"string", "value":"sAMAccountName" }, { "type":"string", "value":"status" }, { "type":"string", "value":"mail" }, { "type":"string", "value":"UserId" }, { "type":"string", "value":"sn" }, { "type":"string", "value":"Manager Id" }, { "type":"string", "value":"OIM User Type" } ] }