Gets application details by name
get
/iam/governance/applicationmanagement/api/v1/applications/{appid}
Get application details by name
Request
Path Parameters
-
appid(required): string
Application name whose details need to be found
Response
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : Application
Type:
Show Source
object-
advanceConfig(required):
array advanceConfigurations
-
applicationDisplayName:
string
-
applicationName(required):
string
-
authoritative:
boolean
Default Value:
false -
baseApplicationName:
string
-
basicConfig:
array basicConfigurations
-
catalogAttribute:
array catalogAttributes
-
connectorDeploymentPath:
string
-
connectorDisplayName(required):
string
-
connectorVersion(required):
string
-
deploymentMode:
string
Allowed Values:
[ "Local", "Remote" ] -
description:
string
-
disconnected:
boolean
Default Value:
false -
objectClass(required):
array objectClass
-
organization(required):
array organizations
-
ownerUserName:
string
-
parentApplicationName:
string
-
status:
string
Allowed Values:
[ "ENABLED", "DISABLED", "ACTIVE", "DELETED" ]
Nested Schema : Attribute
Type:
Show Source
object-
category:
string
-
dataType:
string
-
displayName:
string
-
encrypted:
boolean
Default Value:
false -
helpText:
string
-
name:
string
-
required:
boolean
Default Value:
false -
value:
string
Nested Schema : BasicAttribute
Type:
Show Source
object-
category:
string
-
dataType:
string
-
displayName:
string
-
encrypted:
boolean
Default Value:
false -
helpText:
string
-
name:
string
-
required:
boolean
Default Value:
false -
value:
string
Nested Schema : Form
Type:
Show Source
object-
backendName:
string
-
form:
array form
-
name:
string
-
schemaAttribute:
array schemaAttributes
-
useBulk:
boolean
Default Value:
false
Nested Schema : ProvisioningConfig
Type:
Show Source
object-
accountDiscriminator:
string
-
accountName:
string
-
allowMultiple:
boolean
Default Value:
false -
capability:
array capabilities
-
caseSensitive:
boolean
Default Value:
false -
failedTaskAssignConfig:
object FailedTaskAssignConfig
-
failedTaskRetryConfig:
object FailedTaskRetryConfig
-
transformationScript:
string
-
validationScript:
string
Nested Schema : SchemaAttribute
Type:
Show Source
object-
advanceFlags:
string
-
dataType:
string
Allowed Values:
[ "Byte", "Double", "Int", "String", "Short", "Long", "Date", "Boolean", "ByteArray" ] -
defaultValue:
string
-
dependentAttribute:
string
-
displayName:
string
-
encrypted:
boolean
Default Value:
false -
entitlement:
boolean
Default Value:
false -
fieldType:
string
-
identityAttribute:
string
-
keyField:
boolean
Default Value:
false -
keyFieldCaseInsensitive:
boolean
Default Value:
false -
length:
integer(int32)
-
listOfValues:
string
-
name:
string
-
provideOldValueOnUpdate:
boolean
Default Value:
false -
provisionable:
boolean
Default Value:
false -
reconcileable:
boolean
Default Value:
false -
reconStagingName:
string
-
required:
boolean
Default Value:
false -
udColName:
string
Nested Schema : ActionScript
Type:
Show Source
object-
language:
string
-
script:
string
-
target:
string
Allowed Values:
[ "Connector", "Resource" ] -
triggerTime:
string
Allowed Values:
[ "Before", "After" ]
Nested Schema : CorrelationRuleElement
Type:
Show Source
object-
caseSensitive:
boolean
Default Value:
false -
elementOperator:
string
Allowed Values:
[ "Equals", "Contains", "Starts_With", "Ends_With" ] -
targetAttribute:
string
-
transformName:
string
-
transformParams:
array transformParams
-
userAttribute:
string
Nested Schema : ReconJobDetail
Type:
Show Source
object-
jobName:
string
-
mode:
string
Allowed Values:
[ "Full", "Incremental", "Delete", "Entitlement" ] -
parameter:
array parametersList
Nested Schema : ReconJobParameter
Type:
Show Source
object-
dataType:
string
Allowed Values:
[ "String", "Number", "Boolean", "ITResource" ] -
encrypted:
boolean
Default Value:
false -
helpText:
string
-
name:
string
-
required:
boolean
Default Value:
false -
value:
string
Nested Schema : SituationResponse
Type:
Show Source
object-
response:
string
Allowed Values:
[ "link", "none", "createUser", "createOrganization", "assignToAdminWithLeastLoad", "assignToAuthWithLeastLoad", "assignToAuthWithHighestPriority", "assignToGroup", "assignToUser" ] -
situation:
string
Allowed Values:
[ "noMatch", "singleMatch", "multipleMatch", "oneProcessMatch", "multipleProcessMatch" ]
Nested Schema : Organization
Type:
Show Source
object-
heirarchy:
boolean
Default Value:
false -
name:
string
-
type:
string
Examples
This example demonstrates the method of getting an application details. The information shown here is against a pseudo system and serves as a prototype.
cURL Example
curl -H "Content-Type: application/json" -X GET -u username:password https://pseudo.com/iam/governance/applicationmanagement/api/v1/applications/Sampleapp
Example of Response Body
The following example shows the contents of the response body in JSON format. In this example, Sampleapp is the name of the application.
{
"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_SAMPLEAP",
"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"
}