Discover Header Fields

post

/iam/governance/applicationmanagement/api/v1/applications/headers

Discover the header fields in Flat File.

Request

Supported Media Types
Query Parameters
Body ()
Details of the application for which header fields need to be discovered
Root Schema : Application
Type: object
Show Source
Nested Schema : advanceConfigurations
Type: array
Show Source
Nested Schema : basicConfigurations
Type: array
Show Source
Nested Schema : catalogAttributes
Type: array
Show Source
Nested Schema : objectClass
Type: array
Show Source
Nested Schema : organizations
Type: array
Show Source
Nested Schema : Attribute
Type: object
Show Source
Nested Schema : BasicAttribute
Type: object
Show Source
Nested Schema : ObjectClass
Type: object
Show Source
Nested Schema : Form
Type: object
Show Source
Nested Schema : objectClassConfigurations
Type: array
Show Source
Nested Schema : ProvisioningConfig
Type: object
Show Source
Nested Schema : ReconConfig
Type: object
Show Source
Nested Schema : form
Type: array
Show Source
Nested Schema : schemaAttributes
Type: array
Show Source
Nested Schema : SchemaAttribute
Type: object
Show Source
Nested Schema : capabilities
Type: array
Show Source
Nested Schema : FailedTaskAssignConfig
Type: object
Show Source
Nested Schema : FailedTaskRetryConfig
Type: object
Show Source
Nested Schema : Capability
Type: object
Show Source
Nested Schema : actionScripts
Type: array
Show Source
Nested Schema : ActionScript
Type: object
Show Source
Nested Schema : CorrelationRule
Type: object
Show Source
Nested Schema : reconJobDetails
Type: array
Show Source
Nested Schema : situationResponses
Type: array
Show Source
Nested Schema : childIdentityCorrelationRule
Type: array
Show Source
Nested Schema : ruleElements
Type: array
Show Source
Nested Schema : CorrelationRuleElement
Type: object
Show Source
Nested Schema : transformParams
Type: array
Show Source
Nested Schema : TransformParams
Type: object
Show Source
Nested Schema : ReconJobDetail
Type: object
Show Source
Nested Schema : parametersList
Type: array
Show Source
Nested Schema : ReconJobParameter
Type: object
Show Source
Nested Schema : SituationResponse
Type: object
Show Source
  • Allowed Values: [ "link", "none", "createUser", "createOrganization", "assignToAdminWithLeastLoad", "assignToAuthWithLeastLoad", "assignToAuthWithHighestPriority", "assignToGroup", "assignToUser" ]
  • Allowed Values: [ "noMatch", "singleMatch", "multipleMatch", "oneProcessMatch", "multipleProcessMatch" ]
Nested Schema : Organization
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : List
Type: object
Show Source
Nested Schema : Item
Type: array
Show Source
Nested Schema : items
Type: object
Back to Top

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"
      }
   ]
}
Back to Top