Jump to

• Request
• Response

Register a target database group for Data Safe onboarding

post

https://EM_HOST:8080/em/api/databases/dataSafeOnboardings/actions/registerTargetDatabaseGroup

Submits the Data Safe registration procedure for the provided EM group and OCI settings.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Request payload for Data Safe registration inputs.

Show Source

• dataSafeConnectorId(required): string
  OCID of the Data Safe on-prem connector.
• dbSysNamedCredentialName: string
  Optional named credential for SYSDBA access.
• dbTargetGroupName(required): string
  EM database group name to onboard.
• ociCompartmentId(required): string
  OCI compartment OCID for Data Safe resources.
• ociCredentialName(required): string
  EM credential name for OCI authentication.
• region(required): string
  OCI region identifier.

{
    "description":"Request payload for Data Safe registration inputs.",
    "type":"object",
    "required":[
        "dbTargetGroupName",
        "dataSafeConnectorId",
        "ociCredentialName",
        "ociCompartmentId",
        "region"
    ],
    "properties":{
        "dbTargetGroupName":{
            "type":"string",
            "description":"EM database group name to onboard."
        },
        "dataSafeConnectorId":{
            "type":"string",
            "description":"OCID of the Data Safe on-prem connector."
        },
        "ociCredentialName":{
            "type":"string",
            "description":"EM credential name for OCI authentication."
        },
        "ociCompartmentId":{
            "type":"string",
            "description":"OCI compartment OCID for Data Safe resources."
        },
        "region":{
            "type":"string",
            "description":"OCI region identifier."
        },
        "dbSysNamedCredentialName":{
            "type":"string",
            "description":"Optional named credential for SYSDBA access."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

202 Response

Registration procedure submitted successfully.

Headers

• Location:
  URL to poll for the submitted Data Safe onboarding status.

Body ()

Root Schema : DataSafeOnboardingSubmission

Type: object

Response returned after the Data Safe registration procedure is submitted.

Show Source

• message(required): string
  Human-readable submission result.
• procedureName(required): string
  Submitted procedure name.
• submissionId(required): string
  Procedure submission identifier returned by Enterprise Manager.
• timeSubmitted(required): string (date-time)
  Submission timestamp.

{
    "description":"Response returned after the Data Safe registration procedure is submitted.",
    "type":"object",
    "required":[
        "message",
        "procedureName",
        "submissionId",
        "timeSubmitted"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"Human-readable submission result."
        },
        "procedureName":{
            "type":"string",
            "description":"Submitted procedure name."
        },
        "submissionId":{
            "type":"string",
            "description":"Procedure submission identifier returned by Enterprise Manager."
        },
        "timeSubmitted":{
            "type":"string",
            "format":"date-time",
            "description":"Submission timestamp."
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

401 Response

Unauthorized

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

403 Response

Forbidden

Body ()

Root Schema : MissingPrivErrorResponse

Type: object

Response sent back as an Error in case required privileges are missing

Show Source

• missingPrivileges: array missingPrivileges
  Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object

{
    "type":"object",
    "properties":{
        "missingPrivileges":{
            "type":"array",
            "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
            "items":{
                "$ref":"#/components/schemas/MissingPrivilegeSummary"
            }
        }
    },
    "description":"Response sent back as an Error in case required privileges are missing",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ]
}

Match All

Response sent back as an Error in case required privileges are missing

Show Source

• object ErrorResponse
  Response sent back in the case of an Error

{
    "type":"object",
    "properties":{
        "missingPrivileges":{
            "type":"array",
            "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
            "items":{
                "$ref":"#/components/schemas/MissingPrivilegeSummary"
            }
        }
    },
    "description":"Response sent back as an Error in case required privileges are missing",
    "allOf":[
        {
            "$ref":"#/components/schemas/ErrorResponse"
        }
    ]
}

Nested Schema : missingPrivileges

Type: array

Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object

Show Source

• Array of: object MissingPrivilegeSummary
  It represents a Privilege which is missing on a Resource to view or manage it.

{
    "type":"array",
    "description":"Privileges which are missing due to that the Error is occurred. This will have privilege internal name and display name only in the Privilege object",
    "items":{
        "$ref":"#/components/schemas/MissingPrivilegeSummary"
    }
}

Nested Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

Nested Schema : MissingPrivilegeSummary

Type: object

It represents a Privilege which is missing on a Resource to view or manage it.

Show Source

• displayName: string
  Display Name of Privilege

  Example: Manage
• name: string
  Name of Privilege

  Example: MANAGE_JOB

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of Privilege",
            "example":"MANAGE_JOB"
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of Privilege",
            "example":"Manage"
        }
    },
    "description":"It represents a Privilege which is missing on a Resource to view or manage it."
}

409 Response

Duplicate Resource

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

500 Response

Internal Server Error

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

503 Response

Service Unavailable

Body ()

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

• code(required): string
  The status code of the error
• message(required): string
  A descriptive error message

{
    "required":[
        "code",
        "message"
    ],
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"The status code of the error"
        },
        "message":{
            "type":"string",
            "description":"A descriptive error message"
        }
    },
    "description":"Response sent back in the case of an Error"
}

Back to Top