{
    "swagger":"2.0",
    "info":{
        "title":"REST API for Deployment Manager 12c",
        "description":"The Oracle Deployment Manager (DM) API lets your export and import Oracle Identity Manager configuration(s) between environments.",
        "version":"2025.02.28",
        "x-priority":"60",
        "x-summary":"The Oracle Deployment Manager (DM) API lets your export and import Oracle Identity Manager configuration(s) between environments."
    },
    "schemes":[
        "https"
    ],
    "securityDefinitions":{
        "basicAuth":{
            "type":"basic"
        }
    },
    "paths":{
        "/imports":{
            "post":{
                "security":[
                    {
                        "basicAuth":[
                        ]
                    }
                ],
                "summary":"Preview top level entities",
                "description":"Returns list of all entity physical type and names.",
                "consumes":[
                    "application/json",
                    "application/xml"
                ],
                "produces":[
                    "application/json",
                    "application/xml"
                ],
                "parameters":[
                    {
                        "name":"xmlFile",
                        "in":"query",
                        "description":"Name of the XML file.",
                        "required":true,
                        "type":"string"
                    },
                    {
                        "name":"payload",
                        "in":"body",
                        "description":"Exported XML or JSON file.",
                        "required":true,
                        "schema":{
                            "$ref":"#/definitions/import-payload"
                        }
                    }
                ],
                "responses":{
                    "200":{
                        "description":"OK",
                        "schema":{
                            "$ref":"#/definitions/previewentity-response"
                        }
                    }
                },
                "tags":[
                    "Import Configuration"
                ],
                "x-internal-id":"imports-post",
                "x-filename-id":"imports-post"
            },
            "put":{
                "security":[
                    {
                        "basicAuth":[
                        ]
                    }
                ],
                "summary":"Import operation on entities",
                "description":"Import list of entities provided in the input XML or JSON file.",
                "consumes":[
                    "application/json",
                    "application/xml"
                ],
                "produces":[
                    "application/json",
                    "application/xml"
                ],
                "parameters":[
                    {
                        "name":"xmlFile",
                        "in":"query",
                        "description":"Name of the XML file.",
                        "required":true,
                        "type":"string"
                    },
                    {
                        "name":"user",
                        "in":"query",
                        "description":"User value to be replaced in all references. Supported values are keepOriginal and change. Change should be passed as change=<changeValue>.",
                        "required":true,
                        "type":"string"
                    },
                    {
                        "name":"role",
                        "in":"query",
                        "description":"Role value to be replaced in all references. Supported values are keepOriginal and change. Change should be passed as change=<changeValue>.",
                        "required":true,
                        "type":"string"
                    },
                    {
                        "name":"objectExists",
                        "in":"query",
                        "description":"This parameter specifies how objects in target system are handled. Supported values are Skip and Override. Skip specifies that skip the object of input and keep the object of target system. Override specifies that target system object should be overridden or updated with the input object.",
                        "required":true,
                        "type":"string"
                    },
                    {
                        "name":"payload",
                        "in":"body",
                        "description":"Exported XML/JSON file",
                        "required":true,
                        "schema":{
                            "$ref":"#/definitions/import-payload"
                        }
                    }
                ],
                "responses":{
                    "200":{
                        "description":"OK"
                    }
                },
                "tags":[
                    "Import Configuration"
                ],
                "x-internal-id":"imports-put",
                "x-filename-id":"imports-put"
            }
        },
        "/exports/types":{
            "get":{
                "security":[
                    {
                        "basicAuth":[
                        ]
                    }
                ],
                "summary":"Get list of all types of entities",
                "description":"Returns list of all entity types that are allowed to be exported or imported by Deployment Manager.",
                "consumes":[
                    "application/json",
                    "application/xml"
                ],
                "produces":[
                    "application/json",
                    "application/xml"
                ],
                "responses":{
                    "200":{
                        "description":"OK",
                        "schema":{
                            "$ref":"#/definitions/types-response"
                        }
                    }
                },
                "tags":[
                    "Export Configuration"
                ],
                "x-internal-id":"exports-types-get",
                "x-filename-id":"exports-types-get"
            }
        },
        "/exports":{
            "get":{
                "security":[
                    {
                        "basicAuth":[
                        ]
                    }
                ],
                "summary":"Search operation on entities",
                "description":"Returns list of entities that match the search operation.",
                "consumes":[
                    "application/json",
                    "application/xml"
                ],
                "produces":[
                    "application/json",
                    "application/xml"
                ],
                "parameters":[
                    {
                        "name":"entityType",
                        "in":"query",
                        "description":"Entity type for which search operation needs to be performed. For global search operation its value should be * .",
                        "required":true,
                        "type":"string"
                    },
                    {
                        "name":"searchPattern",
                        "in":"query",
                        "description":"Search pattern based on which entity will be searched.",
                        "required":true,
                        "type":"string"
                    }
                ],
                "responses":{
                    "200":{
                        "description":"OK",
                        "schema":{
                            "$ref":"#/definitions/searchentity-response"
                        }
                    }
                },
                "tags":[
                    "Export Configuration"
                ],
                "x-internal-id":"exports-get",
                "x-filename-id":"exports-get"
            },
            "post":{
                "security":[
                    {
                        "basicAuth":[
                        ]
                    }
                ],
                "summary":"Export operation on entities",
                "description":"Export list of entities based on entity type and entity name.",
                "consumes":[
                    "application/json",
                    "application/xml"
                ],
                "produces":[
                    "application/json",
                    "application/xml"
                ],
                "parameters":[
                    {
                        "name":"description",
                        "in":"query",
                        "description":"A short description to identify the export components.",
                        "required":true,
                        "type":"string"
                    },
                    {
                        "name":"dependencies",
                        "in":"query",
                        "description":"Supported values are yes and /no. Yes indicates export entities along with all dependencies and children. No indicates only export entities without any dependency and children.",
                        "required":true,
                        "type":"string"
                    },
                    {
                        "name":"payload",
                        "in":"body",
                        "description":"The request body defines the list of entities to be exported.",
                        "required":true,
                        "schema":{
                            "$ref":"#/definitions/export-postpayload"
                        }
                    }
                ],
                "responses":{
                    "200":{
                        "description":"OK",
                        "schema":{
                            "$ref":"#/definitions/exportentity-response"
                        }
                    }
                },
                "tags":[
                    "Export Configuration"
                ],
                "x-internal-id":"exports-post",
                "x-filename-id":"exports-post"
            }
        }
    },
    "definitions":{
        "previewentity-response":{
            "type":"array",
            "description":"The request was successfully completed. The response body includes information about the entities.",
            "items":{
                "$ref":"#/definitions/previewentity-array"
            }
        },
        "previewentity-array":{
            "properties":{
                "entityType":{
                    "type":"string",
                    "description":"Type of the entity that matches the preview operation."
                },
                "entityTypeDisplay":{
                    "type":"string",
                    "description":"Specify the display name of entity type which is locale dependent."
                },
                "entityName":{
                    "type":"string",
                    "description":"Name of the entity that matches the preview operation."
                },
                "message":{
                    "type":"string",
                    "description":"The text message of preview operation that can be displayed on the interface, if any."
                }
            }
        },
        "import-payload":{
            "properties":{
                "xl-ddm-data":{
                    "type":"object",
                    "description":"Contains the exported XML or JSON file."
                }
            }
        },
        "searchentity-response":{
            "type":"array",
            "description":"The request was successfully completed. The response body includes information about the entities.",
            "items":{
                "$ref":"#/definitions/searchentity-array"
            }
        },
        "searchentity-array":{
            "properties":{
                "entityType":{
                    "type":"string",
                    "description":"Type of the entity that matches the search operation."
                },
                "entityTypeDisplay":{
                    "type":"string",
                    "description":"Specify the display name of entity type which is locale dependent."
                },
                "entityName":{
                    "type":"string",
                    "description":"Name of the entity that matches the search operation."
                },
                "message":{
                    "type":"string",
                    "description":"The text message of search operation that can be displayed on the interface, if any."
                }
            }
        },
        "types-response":{
            "type":"array",
            "description":"The request was successfully completed. The response body includes information about the entities.",
            "items":{
                "$ref":"#/definitions/types-array"
            }
        },
        "types-array":{
            "properties":{
                "entityType":{
                    "type":"string",
                    "description":"Specify type of the entity."
                },
                "entityTypeDisplay":{
                    "type":"string",
                    "description":"Specify the display name of entity type which is locale dependent."
                }
            }
        },
        "export-postpayload":{
            "properties":{
                "entity":{
                    "type":"array",
                    "description":"The request body defines the list of entities to be exported.",
                    "items":{
                        "$ref":"#/definitions/export-postpayload-array"
                    }
                }
            }
        },
        "export-postpayload-array":{
            "description":"Defines the entity type and entity name of entities.",
            "properties":{
                "entityType":{
                    "type":"string",
                    "description":"Defines the type of the entity."
                },
                "entityName":{
                    "type":"string",
                    "description":"Defines the name of the entity."
                }
            }
        },
        "exportentity-response":{
            "properties":{
                "xl-ddm-data":{
                    "type":"object",
                    "description":"Contains the entity type objects that is exported."
                }
            }
        }
    },
    "tags":[
        {
            "name":"Export Configuration",
            "description":"Export the configuration(s) from Oracle Identity Manager.",
            "x-priority":"60"
        },
        {
            "name":"Import Configuration",
            "description":"Import the configuration(s) into Oracle Identity Manager."
        }
    ]
}