Change user status using userdetails
put
/oam/services/rest/access/api/v1/pswdmanagement/UserStatusChanger
User status is changed as per input specifications. The specifications tells whether user is enabled/disable forcedPasswordreset, locked/unlocked. These status of the user can be changed via this API. In this API, the user
details can be passed as a query parameter as userdetails or as part of the request object.
Request
Query Parameters
-
userdetails(optional): string
userdetails object in query parameter.The path parameter takes precedence over query parameter. The query parameter takes the input of the form systemTenant::UserDN::IDSTOREREF::UserID. For example, userdetails=systemTenant::cn=normal,ou=users,dc=ngam,dc=oracle,dc=com::oud::normal.
This is the request object which uniquely identifies the user and changes the status as per the input specification
Root Schema : UserStatusChangeRequest
Type:
Show Source
object-
enabled(optional):
boolean
if user is enabled, set to true. If disabled, set as false
-
forcepwdchange(optional):
boolean
if user is forced to change password in the next login, set to true. Else set to false.
-
unlocked(optional):
boolean
if user is unlocked, set to true. If user is locked, set to false
-
username(optional):
object userdetails
Nested Schema : userdetails
Type:
Show Source
object-
dn(optional):
string
the distinguished name of the user in the identity store
-
idstoreref(optional):
string
idstore that the user belongs to
-
tenantname(optional):
string
tenant name. Its always systemTenant
-
username(optional):
string
the short name of the user
Response
Supported Media Types
- application/json
200 Response
The user status has been changed successfully
401 Response
Unauthorized
404 Response
Requested entity not found
500 Response
Internal Server Error
Examples
This example demonstrates the method of updating a template.
Example of the Request Headers
curl -H "Content-Type: application/json" -X PUT -u username:password ?d put.json https://pseudo.com/iam/governance/applicationmanagement/api/v1/templates
Example of the Request Body
The following example shows the contents of the response body in JSON format.
{
"applicationName": "wZ3D5DMe",
"applicationDisplayName": "adv",
"description": "",
"connectorDisplayName": "Oracle EBS User Management",
"connectorVersion": "11.1.1.5.0",
"connectorDeploymentPath": "/scratch/myfolder/devtools/Middleware/idm/server/ConnectorDefaultDirectory/Oracle_EBS_UM-11.1.1.5.0",
"basicConfigurations": {
"basicConfig": [
{
"name": "Connector Server Name",
"value": "",
"required": false
},
{
"name": "TopologyName",
"value": "None",
"required": false
},
{
"name": "batchSize",
"value": "1000",
"helpText": "<b>Batch Size </b> ,/br> Specify the batch size for fetching the records while Reconciliation",
"dataType": "int",
"required": false
},
{
"name": "contextAppId",
"value": "0",
"helpText": "<b> Context Application Id</b> </ br> Enter the name of the application to which context user belongs.",
"dataType": "String",
"required": false
},
{
"name": "contextRespId",
"value": "0",
"helpText": "<b> Context Responsibility Id</b> </ br>Enter the responsibility assigned to the user in whose context connector operations are performed on the target system",
"dataType": "String",
"required": false
},
{
"name": "contextUserId",
"value": "0",
"helpText": "<b>Context User Id </b> </ br> Enter the user ID of the user in whose context connector operations are performed on the target system.",
"dataType": "String",
"required": false
},
{
"name": "database",
"value": "conDev",
"helpText": "<b> Database</b> </ br>Enter the name of the database on the database server that contains the table.",
"dataType": "String",
"required": false
},
{
"name": "host",
"value": "myhost.pseudo.com",
"helpText": "<b>Host </b> </ br> Enter the name of the host where the database is running.",
"dataType": "String",
"required": false
},
{
"name": "jdbcUrlTemplate",
"value": "jdbc:oracle:thin:@myhost.pseudo.com:<port-number>:conDev",
"helpText": "
<b>JDBC Connection URL </b> </ br>Specify the JDBC Driver Connection URL.Oracle template is jdbc:oracle:thin:@[host]:[port(<port-number>)]:[DB]. < / br> for more info, read the JDBC driver documentation",
"dataType": "String",
"required": true
},
{
"name": "password",
"value": "apps",
"helpText": " <b>User Password </b> </ br> Enter a user account that has permission to access accounts table.",
"dataType": "GuardedString",
"required": true,
"encrypted": true
},
{
"name": "port",
"value": "<port-number>",
"helpText": "<b> TCP Port</b> </ br>Enter the port number the database server is listening on.",
"dataType": "int",
"required": false
},
{
"name": "user",
"value": "apps",
"helpText": "<b> User</b> </ br>Enter the name of the mandatory Database user with permission to account table.",
"dataType": "String",
"required": true
}
]
},
"advanceConfigurations": {
"advanceConfig": [
{
"name": "Connector Name",
"value": "org.identityconnectors.ebs.EBSConnector",
"required": false
},
{
"name": "User Configuration Lookup",
"value": "Lookup.Oracle EBS UM.UM.Configuration",
"required": false
},
{
"name": "Bundle Name",
"value": "org.identityconnectors.ebs",
"required": false
},
{
"name": "Bundle Version",
"value": "1.0.11150",
"required": false
}
]
},
"objectClass": [
{
"name": "USER",
"provisioningConfig": {
"accountName": "",
"validationScript": "",
"transformationScript": "",
"capabilities": {
"capability": [
{
"actionName": "disable",
"enabled": true
},
{
"actionName": "delete",
"enabled": true
},
{
"actionName": "create",
"enabled": true
},
{
"actionName": "enable",
"enabled": true
},
{
"actionName": "update",
"enabled": true
}
]
}
},
"reconConfig": {
"reconJobDetails": {
"jobDetail": [
{
"jobName": "wZ3D5DMe Oracle EBS UM Target Roles Lookup Reconciliation",
"mode": "Entitlement",
"parametersList": {
"parameter": [
{
"name": "Application Name",
"value": "wZ3D5DMe",
"helpText": "Application Name",
"dataType": "String"
},
{
"name": "Lookup Name",
"value": "Lookup.Oracle EBS UM.Roles",
"helpText": "Lookup Name",
"dataType": "String"
},
{
"name": "Object Type",
"value": "__ROLES__",
"helpText": "Object Type",
"dataType": "String"
},
{
"name": "Code Key Attribute",
"value": "Code",
"helpText": "Code Key attribute",
"dataType": "String"
},
{
"name": "Decode Attribute",
"value": "Decode",
"helpText": "Decode attribute",
"dataType": "String"
}
]
}
},
{
"jobName": "wZ3D5DMe Oracle EBS UM Target Responsibilities Lookup Reconciliation",
"mode": "Entitlement",
"parametersList": {
"parameter": [
{
"name": "Application Name",
"value": "wZ3D5DMe",
"helpText": "Application Name",
"dataType": "String"
},
{
"name": "Lookup Name",
"value": "Lookup.Oracle EBS UM.Responsibilities",
"helpText": "Lookup Name",
"dataType": "String"
},
{
"name": "Object Type",
"value": "__RESPONSIBILITIES__",
"helpText": "Object Type",
"dataType": "String"
},
{
"name": "Code Key Attribute",
"value": "Code",
"helpText": "Code Key attribute",
"dataType": "String"
},
{
"name": "Decode Attribute",
"value": "Decode",
"helpText": "Decode Attribute",
"dataType": "String"
}
]
}
},
{
"jobName": "wZ3D5DMe Oracle EBS UM Target Applications Lookup Reconciliation",
"mode": "Entitlement",
"parametersList": {
"parameter": [
{
"name": "Application Name",
"value": "wZ3D5DMe",
"helpText": "Application Name",
"dataType": "String"
},
{
"name": "Lookup Name",
"value": "Lookup.Oracle EBS UM.Applications",
"helpText": "Lookup Name",
"dataType": "String"
},
{
"name": "Object Type",
"value": "__APPLICATIONS__",
"helpText": "Object Type",
"dataType": "String"
},
{
"name": "Code Key Attribute",
"value": "Code",
"helpText": "Code Key attribute",
"dataType": "String"
},
{
"name": "Decode Attribute",
"value": "Decode",
"helpText": "Decode Attribute",
"dataType": "String"
}
]
}
},
{
"jobName": "wZ3D5DMe Oracle EBS UM Target Security Groups Lookup Reconciliation",
"mode": "Entitlement",
"parametersList": {
"parameter": [
{
"name": "Application Name",
"value": "wZ3D5DMe",
"helpText": "Application Name",
"dataType": "String"
},
{
"name": "Lookup Name",
"value": "Lookup.Oracle EBS UM.SecurityGroups",
"helpText": "Lookup Name",
"dataType": "String"
},
{
"name": "Object Type",
"value": "__SECURITY_GROUPS__",
"helpText": "Object Type",
"dataType": "String"
},
{
"name": "Code Key Attribute",
"value": "Code",
"helpText": "Code Key attribute",
"dataType": "String"
},
{
"name": "Decode Attribute",
"value": "Decode",
"helpText": "Decode Attribute",
"dataType": "String"
}
]
}
},
{
"jobName": "wZ3D5DMe Oracle EBS UM Target User Reconciliation",
"mode": "Full",
"parametersList": {
"parameter": [
{
"name": "Application Name",
"value": "wZ3D5DMe",
"helpText": "Application Name",
"dataType": "String"
},
{
"name": "Filter",
"value": "",
"helpText": "Filter",
"dataType": "String"
},
{
"name": "Incremental Recon Attribute",
"value": "",
"helpText": "Incremental Recon Attribute",
"dataType": "String"
},
{
"name": "Object Type",
"value": "User",
"helpText": "Object Type",
"dataType": "String"
},
{
"name": "Latest Token",
"value": "",
"helpText": "Latest Token",
"dataType": "String"
},
{
"name": "Scheduled Task Name",
"value": "wZ3D5DMe Oracle EBS UM Target User Reconciliation",
"helpText": "Scheduled Task Name",
"dataType": "String",
"required": true
}
]
}
},
{
"jobName": "wZ3D5DMe Oracle EBS UM Target Incremental User Reconciliation",
"mode": "Incremental",
"parametersList": {
"parameter": [
{
"name": "Application Name",
"value": "wZ3D5DMe",
"helpText": "Application Name",
"dataType": "String"
},
{
"name": "Sync Token",
"value": "",
"helpText": "Sync Token",
"dataType": "String"
},
{
"name": "Object Type",
"value": "User",
"helpText": "Object Type",
"dataType": "String"
},
{
"name": "Scheduled Task Name",
"value": "wZ3D5DMe Oracle EBS UM Target Incremental User Reconciliation",
"helpText": "Scheduled Task Name",
"dataType": "String",
"required": true
}
]
}
},
{
"jobName": "wZ3D5DMe Oracle EBS UM Target User Delete Reconciliation",
"mode": "Delete",
"parametersList": {
"parameter": [
{
"name": "Application Name",
"value": "wZ3D5DMe",
"helpText": "Application Name",
"dataType": "String"
},
{
"name": "Object Type",
"value": "User",
"helpText": "Object Type",
"dataType": "String",
"required": true
}
]
}
}
]
},
"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"
}
]
},
"validationScript": "",
"transformationScript": ""
},
"form": {
"name": "Oracle EBS UM User",
"backendName": "UD_WZ3D5DME",
"schemaAttributes": {
"schemaAttribute": [
{
"name": "CUSTOMER_ID",
"dataType": "String",
"displayName": "Customer ID",
"length": 256,
"identityAttribute": "",
"keyField": false,
"keyFieldCaseInsensitive": false,
"required": false,
"fieldType": "TextField",
"reconcileable": true,
"provisionable": true,
"accountDiscriminator": false
},
{
"name": "PARTY_LAST_NAME",
"dataType": "String",
"displayName": "Party Last Name",
"length": 150,
"keyField": false,
"keyFieldCaseInsensitive": false,
"fieldType": "TextField",
"reconcileable": true,
"provisionable": true,
"provideOldValueOnUpdate": true
},
{
"name": "DESCRIPTION",
"dataType": "String",
"displayName": "Description",
"length": 240,
"keyField": false,
"keyFieldCaseInsensitive": false,
"fieldType": "TextField",
"reconcileable": true,
"provisionable": true,
"provideOldValueOnUpdate": true
},
{
"name": "EMPLOYEE_ID",
"dataType": "String",
"displayName": "Person Id",
"length": 30,
"keyField": false,
"keyFieldCaseInsensitive": false,
"fieldType": "TextField",
"reconcileable": true,
"provisionable": true,
"provideOldValueOnUpdate": true
},
{
"name": "START_DATE",
"dataType": "Date",
"displayName": "Effective Start Date",
"length": 0,
"keyField": false,
"keyFieldCaseInsensitive": false,
"fieldType": "DateFieldDlg",
"reconcileable": true,
"provisionable": true,
"advanceFlags": "DATE",
"provideOldValueOnUpdate": true
},
{
"name": "__UID__",
"dataType": "String",
"displayName": "User Id",
"length": 100,
"keyField": true,
"keyFieldCaseInsensitive": false,
"fieldType": "DOField",
"reconcileable": true,
"provisionable": true
},
{
"name": "SUPPLIER_NAME",
"dataType": "String",
"displayName": "Supplier Name",
"length": 100,
"keyField": false,
"keyFieldCaseInsensitive": false,
"fieldType": "TextField",
"reconcileable": true,
"provisionable": true,
"provideOldValueOnUpdate": true
},
{
"dataType": "String",
"displayName": "SoDCheckTrackingID",
"length": 50,
"keyField": false,
"keyFieldCaseInsensitive": false,
"fieldType": "DOField",
"provisionable": false,
"advanceFlags": "IGNORE"
},
{
"dataType": "String",
"displayName": "SoDCheckTimestamp",
"length": 50,
"keyField": false,
"keyFieldCaseInsensitive": false,
"fieldType": "DOField",
"provisionable": false,
"advanceFlags": "IGNORE"
},
{
"dataType": "String",
"displayName": "SoDCheckEntitlementViolation",
"length": 4000,
"keyField": false,
"keyFieldCaseInsensitive": false,
"fieldType": "DOField",
"provisionable": false,
"advanceFlags": "IGNORE"
},
{
"name": "FAX",
"dataType": "String",
"displayName": "Fax",
"length": 80,
"keyField": false,
"keyFieldCaseInsensitive": false,
"fieldType": "TextField",
"reconcileable": true,
"provisionable": true,
"provideOldValueOnUpdate": true
},
{
"name": "SUPPLIER_PARTY_ID",
"dataType": "String",
"displayName": "Supplier Party Id",
"length": 100,
"keyField": false,
"keyFieldCaseInsensitive": false,
"fieldType": "DOField",
"reconcileable": true,
"provisionable": true,
"advanceFlags": "WRITEBACK"
},
{
"name": "END_DATE",
"dataType": "Date",
"displayName": "Effective End Date",
"length": 0,
"keyField": false,
"keyFieldCaseInsensitive": false,
"fieldType": "DateFieldDlg",
"reconcileable": true,
"provisionable": true,
"advanceFlags": "DATE",
"provideOldValueOnUpdate": true
},
{
"name": "PASSWORD_EXP_TYPE",
"dataType": "String",
"displayName": "Password Expiration Type",
"length": 30,
"keyField": false,
"keyFieldCaseInsensitive": false,
"fieldType": "LookupField",
"reconcileable": true,
"provisionable": true,
"listOfValues": "Lookup.Oracle EBS UM.PasswordExpTypes",
"provideOldValueOnUpdate": true
},
{
"name": "PARTY_TYPE",
"dataType": "String",
"displayName": "Party Type",
"length": 100,
"keyField": false,
"keyFieldCaseInsensitive": false,
"fieldType": "LookupField",
"reconcileable": true,
"provisionable": true,
"listOfValues": "Lookup.Oracle EBS UM.PartyType",
"provideOldValueOnUpdate": true
},
{
"dataType": "String",
"displayName": "SoDCheckStatus",
"length": 50,
"keyField": false,
"keyFieldCaseInsensitive": false,
"fieldType": "DOField",
"provisionable": false,
"advanceFlags": "IGNORE",
"defaultValue": "SODCheckNotInitiated"
},
{
"name": "PARTY_ID",
"dataType": "String",
"displayName": "Party Id",
"length": 100,
"keyField": false,
"keyFieldCaseInsensitive": false,
"fieldType": "TextField",
"reconcileable": true,
"provisionable": true,
"provideOldValueOnUpdate": true
},
{
"name": "__NAME__",
"dataType": "String",
"displayName": "User Name",
"length": 100,
"keyField": false,
"keyFieldCaseInsensitive": false,
"required": true,
"fieldType": "TextField",
"reconcileable": true,
"provisionable": true,
"provideOldValueOnUpdate": true
},
{
"name": "PARTY_FIRST_NAME",
"dataType": "String",
"displayName": "Party First Name",
"length": 150,
"keyField": false,
"keyFieldCaseInsensitive": false,
"fieldType": "TextField",
"reconcileable": true,
"provisionable": true,
"provideOldValueOnUpdate": true
},
{
"name": "__PASSWORD__",
"dataType": "String",
"displayName": "Password",
"length": 100,
"keyField": false,
"keyFieldCaseInsensitive": false,
"fieldType": "PasswordField",
"provisionable": true,
"encrypted": true,
"provideOldValueOnUpdate": true
},
{
"name": "EMAIL_ADDRESS",
"dataType": "String",
"displayName": "Email",
"length": 240,
"keyField": false,
"keyFieldCaseInsensitive": false,
"fieldType": "TextField",
"reconcileable": true,
"provisionable": true,
"provideOldValueOnUpdate": true
},
{
"name": "USER_GUID",
"dataType": "String",
"displayName": "SSO GUID",
"length": 256,
"keyField": false,
"keyFieldCaseInsensitive": false,
"fieldType": "DOField",
"reconcileable": true,
"provisionable": true,
"provideOldValueOnUpdate": true
},
{
"name": "PASSWORD_LIFESPAN",
"dataType": "Long",
"displayName": "Password Expiration Interval",
"length": 19,
"keyField": false,
"keyFieldCaseInsensitive": false,
"fieldType": "TextField",
"reconcileable": true,
"provisionable": true,
"provideOldValueOnUpdate": true
},
{
"dataType": "String",
"displayName": "SoDCheckResult",
"length": 4000,
"keyField": false,
"keyFieldCaseInsensitive": false,
"fieldType": "DOField",
"provisionable": false,
"advanceFlags": "IGNORE"
},
{
"dataType": "Long",
"displayName": "Server",
"length": 19,
"keyField": true,
"keyFieldCaseInsensitive": false,
"required": true,
"fieldType": "ITResourceLookupField",
"reconcileable": true,
"provisionable": false,
"advanceFlags": "IGNORE"
},
{
"name": "__ENABLE__",
"dataType": "String",
"displayName": "Status",
"length": 256,
"keyField": false,
"keyFieldCaseInsensitive": false,
"fieldType": "TextField",
"reconcileable": true
}
]
},
"form": [
{
"name": "Responsibilities",
"backendName": "UD_RESPON18",
"schemaAttributes": {
"schemaAttribute": [
{
"name": "__RESPONSIBILITY__~__RESPONSIBILITY__~RESP_DESCRIPTION",
"dataType": "String",
"displayName": "Responsibility Description",
"length": 200,
"keyField": false,
"keyFieldCaseInsensitive": false,
"fieldType": "TextField",
"reconcileable": true,
"provisionable": true
},
{
"name": "__RESPONSIBILITY__~__RESPONSIBILITY__~RESP_START_DATE",
"dataType": "Date",
"displayName": "Responsibility Start Date",
"length": 0,
"keyField": false,
"keyFieldCaseInsensitive": false,
"fieldType": "DateFieldDlg",
"reconcileable": true,
"provisionable": true,
"advanceFlags": "DATE"
},
{
"name": "__RESPONSIBILITY__~__RESPONSIBILITY__~RESPONSIBILITY_APP_ID",
"dataType": "String",
"displayName": "Application Name",
"length": 256,
"keyField": false,
"keyFieldCaseInsensitive": false,
"required": true,
"fieldType": "LookupField",
"reconcileable": true,
"provisionable": true,
"advanceFlags": "LOOKUP",
"listOfValues": "Lookup.Oracle EBS UM.Applications"
},
{
"name": "__RESPONSIBILITY__~__RESPONSIBILITY__~RESP_END_DATE",
"dataType": "Date",
"displayName": "Responsibility End Date",
"length": 0,
"keyField": false,
"keyFieldCaseInsensitive": false,
"fieldType": "DateFieldDlg",
"reconcileable": true,
"provisionable": true,
"advanceFlags": "DATE"
},
{
"name": "__RESPONSIBILITY__~__RESPONSIBILITY__~SECURITY_GROUP_ID",
"dataType": "String",
"displayName": "Security Group",
"length": 256,
"keyField": false,
"keyFieldCaseInsensitive": false,
"required": true,
"fieldType": "LookupField",
"reconcileable": true,
"provisionable": true,
"advanceFlags": "LOOKUP",
"listOfValues": "Lookup.Oracle EBS UM.SecurityGroups"
},
{
"name": "__RESPONSIBILITY__~__RESPONSIBILITY__~RESPONSIBILITY_ID",
"dataType": "String",
"displayName": "Responsibility Name",
"length": 256,
"keyField": true,
"keyFieldCaseInsensitive": false,
"required": true,
"fieldType": "LookupField",
"entitlement": true,
"reconcileable": true,
"provisionable": true,
"advanceFlags": "LOOKUP",
"listOfValues": "Lookup.Oracle EBS UM.Responsibilities"
}
]
}
},
{
"name": "Roles",
"backendName": "UD_ROLES18",
"schemaAttributes": {
"schemaAttribute": [
{
"name": "__ROLE__~__ROLE__~EXPIRATION_DATE",
"dataType": "Date",
"displayName": "Role Expiration Date",
"length": 0,
"keyField": false,
"keyFieldCaseInsensitive": false,
"fieldType": "DateFieldDlg",
"reconcileable": true,
"provisionable": true,
"advanceFlags": "DATE"
},
{
"name": "__ROLE__~__ROLE__~ROLE_START_DATE",
"dataType": "Date",
"displayName": "Role Start Date",
"length": 0,
"keyField": false,
"keyFieldCaseInsensitive": false,
"fieldType": "DateFieldDlg",
"reconcileable": true,
"provisionable": true,
"advanceFlags": "DATE"
},
{
"name": "__ROLE__~__ROLE__~ROLE_ID",
"dataType": "String",
"displayName": "Role Name",
"length": 256,
"keyField": true,
"keyFieldCaseInsensitive": false,
"required": true,
"fieldType": "LookupField",
"entitlement": true,
"reconcileable": true,
"provisionable": true,
"advanceFlags": "LOOKUP",
"listOfValues": "Lookup.Oracle EBS UM.Roles"
},
{
"name": "__ROLE__~__ROLE__~ROLE_APP_ID",
"dataType": "String",
"displayName": "Application Name",
"length": 256,
"keyField": false,
"keyFieldCaseInsensitive": false,
"fieldType": "LookupField",
"reconcileable": true,
"provisionable": true,
"advanceFlags": "LOOKUP",
"listOfValues": "Lookup.Oracle EBS UM.Applications"
}
]
}
}
]
}
}
],
"catalogAttributes": {
"catalogAttribute": [
{
"name": "Category",
"value": "ApplicationInstance",
"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": "true",
"required": false
},
{
"name": "Certifier User",
"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"
}