Creates a new Application
post
/iam/governance/applicationmanagement/api/v1/applications
Create a new Application in OIM
Request
Supported Media Types
- application/json
Application details for new application to be created
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" ]
-
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
Default Response
successful operation
Examples
This example demonstrates the ability for creating a sample disconnected application. The information shown here is against a pseudo system and serves as a prototype.
cURL Example
curl -H "Content-Type: application/json" -H "X-Requested-By: <anyvalue>" -X POST -u username:password -d @post.json https://pseudo.com/iam/governance/applicationmanagement/api/v1/applications/
Example of POST Request Body
The following example shows the contents of the request body in JSON format.
{ "applicationName": "Sampleapp", "applicationDisplayName": "Sampleapp", "description": "Sampleapp Description", "connectorDisplayName": "", "disconnected": true, "advanceConfigurations": { "advanceConfig": [] }, "objectClass": [ { "name": "User", "provisioningConfig": { "accountName": "Account Login" }, "reconConfig": { "reconJobDetails": { "jobDetail": [] }, "identityCorrelationRule": { "ruleOperator": "AND", "ruleElement": [ { "targetAttribute": "Account Login", "userAttribute": "User Login", "elementOperator": "Equals" } ] }, "situationResponses": { "situationResponse": [ { "situation": "No Matches Found", "response": "None" }, { "situation": "One Entity Match Found", "response": "Establish Link" }, { "situation": "One Process Match Found", "response": "Establish Link" } ] } }, "form": { "name": "Details", "backendName": "UD_YGGG", "schemaAttributes": { "schemaAttribute": [ { "dataType": "Long", "displayName": "ITResource", "length": 19, "keyField": true, "keyFieldCaseInsensitive": false, "fieldType": "ITResourceLookupField", "reconcileable": true }, { "dataType": "String", "displayName": "Account Login", "length": 256, "keyField": false, "keyFieldCaseInsensitive": false, "fieldType": "TextField", "reconcileable": true }, { "dataType": "String", "displayName": "Password", "length": 125, "keyField": false, "keyFieldCaseInsensitive": false, "fieldType": "PasswordField", "reconcileable": true, "encrypted": true }, { "dataType": "String", "displayName": "Display", "length": 256, "keyField": true, "keyFieldCaseInsensitive": false, "fieldType": "TextField", "reconcileable": true } ] } } } ], "catalogAttributes": { "catalogAttribute": [ { "name": "Category", "value": "ApplicationInstance", "required": false }, { "name": "User Defined Tags", "required": false }, { "name": "Requestable", "value": "true", "required": false }, { "name": "Approver User", "value": "XELSYSADM", "required": false }, { "name": "Approver Role", "required": false }, { "name": "Fulfilment User", "value": "XELSYSADM", "required": false }, { "name": "Fulfilment Role", "required": false }, { "name": "Certifiable", "value": "true", "required": false }, { "name": "Certifier User", "value": "XELSYSADM", "required": false }, { "name": "Certifier Role", "required": false }, { "name": "Audit Objective", "required": false }, { "name": "Auditable", "value": "true", "required": false }, { "name": "Risk Level", "value": "3", "required": false } ] }, "organizations": { "organization": [ { "name": "Top", "heirarchy": true, "type": "System" } ] }, "status": "ACTIVE" }
Example of POST Response Body
The following example shows the contents of the response body.
Application Created