How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Oracle Onboarding API

The onboarding API from Oracle — 11 operation(s) for onboarding.

Oracle Onboarding API is one of 378 APIs that Oracle publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Onboarding. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 14 operations across 11 paths, and defines 20 schemas. It is described by OpenAPI 3.2.0, at version 20220901.

Requests are made against 2 base URLs: http://127.0.0.1/20220901, https://127.0.0.1/20220901.

14 operations 11 paths 20 schemas 1 DELETE4 GET8 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
20220901
Base URL
https://{host}:{port}/ords/
Resource Areas
1

Paths & Operations 14

Across 11 paths, the API surfaces 14 operations — 1 DELETE, 4 GET, 8 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

onboarding 14
GET
/profiles
Gets a list of all Profiles in a compartment
ListProfiles 20 params → 200400401404429500default
POST
/profiles
Creates a new Profile
CreateProfile 2 params body → 200400401404409429500default
DELETE
/profiles/{profileId}
Delete a provisioned Profile
DeleteProfile 3 params → 204400401404412429500default
GET
/profiles/{profileId}
Get Profile
GetProfile 2 params → 200400401404429500default
PUT
/profiles/{profileId}
Update the profile with the given id
UpdateProfile 3 params body → 200400401404412429500default
POST
/profiles/{profileId}/actions/attachLifecycleStage
Attaches lifecycle stage to a profile
AttachLifecycleStageToProfile 4 params body → 200400401404409412429500
POST
/profiles/{profileId}/actions/attachManagedInstanceGroup
Attaches managed instance group to a profile
AttachManagedInstanceGroupToProfile 4 params body → 200400401404409412429500
POST
/profiles/{profileId}/actions/attachManagementStation
Attaches management station to a profile
AttachManagementStationToProfile 4 params body → 200400401404409412429500
POST
/profiles/{profileId}/actions/attachSoftwareSources
Attaches software sources to a profile
AttachSoftwareSourcesToProfile 4 params body → 200400401404409412429500
POST
/profiles/{profileId}/actions/changeCompartment
Change the profile compartment.
ChangeProfileCompartment 5 params → 204400401404409412429500
POST
/profiles/{profileId}/actions/detachManagementStation
Detaches management station from a profile
DetachManagementStationFromProfile 4 params body → 200400401404409412429500
POST
/profiles/{profileId}/actions/detachSoftwareSources
Detaches software sources from a profile
DetachSoftwareSourcesFromProfile 4 params body → 200400401404409412429500
GET
/profiles/{profileId}/availableSoftwareSources
Gets a list of all software sources available for the profile. These only include software sources that are not already added to the profile, but can be added.
ListProfileAvailableSoftwareSources 9 params → 200400401404429500default
GET
/profiles/{profileId}/version/{profileVersion}
Get Profile Version
GetProfileVersion 3 params → 200400401404429500default

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are ProfileVersion (20 properties), Profile (19 properties), ProfileSummary (17 properties), CreateProfileDetails (9 properties). Each schema is shown below with its type and property counts.

Profile
object
Object that defines the registration profile.
19 properties 6 required
LifecycleStageDetails
object
Provides identifying information for the specified lifecycle stage.
2 properties 1 required
ProfileSummary
object
Provides summary information for a registration profile.
17 properties 2 required
ProfileCollection
object
The set of registration profiles returned for the [ListProfiles](/en/osmh/latest/Profile/ListProfiles) operation.
1 property 1 required
LifecycleEnvironmentDetails
object
Provides identifying information for the specified lifecycle environment.
2 properties 1 required
AvailableSoftwareSourceSummary
object
Provides summary information about an available software source. An available software source can be added to a managed instance. After a software source is ad…
5 properties 4 required
ManagedInstanceGroupDetails
object
Provides identifying information for the specified managed instance group.
2 properties 1 required
AvailableSoftwareSourceCollection
object
The set of available software sources returned for the [ListManagedInstanceAvailableSoftwareSources](/en/osmh/latest/ManagedInstance/ListManagedInstanceAvailab…
1 property 1 required
AttachManagementStationToProfileDetails
object
Provides the information used to attach a management station to a profile.
1 property 1 required
UpdateProfileDetails
object
Provides the information used to update a registration profile.
5 properties
AttachManagedInstanceGroupToProfileDetails
object
Provides the information used to attach a managed instance group to a profile.
1 property 1 required
AttachSoftwareSourcesToProfileDetails
object
Provides the information used to attach software sources to a profile.
1 property 1 required
CreateProfileDetails
object
Provides the information used to create a new registration profile.
9 properties 3 required
Error
object
Provides the information for an error.
2 properties 2 required
SoftwareSourceDetails
object
Provides identifying information for the specified software source.
5 properties 1 required
ProfileVersion
object
Represents a specific version of a registration profile.
20 properties 6 required
AttachLifecycleStageToProfileDetails
object
Provides the information used to attach a lifecycle stage to a profile.
1 property 1 required
DetachSoftwareSourcesFromProfileDetails
object
Provides the information used to detach software sources from a profile.
1 property 1 required
DetachManagementStationFromProfileDetails
object
Provides the information used to detach a management station from a profile.
1 property 1 required
ChangeProfileCompartmentDetails
object
Provides the information used to move a profile to another compartment.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oracle-onboarding-api-openapi.yml Raw ↑

Other APIs Oracle publishes across the network.

Oracle Database REST APIs
Oracle Integration Cloud API
Oracle Fusion Cloud Applications API
Oracle Fusion Cloud Financials REST API
Oracle Fusion Cloud HCM REST API
Oracle Fusion Cloud CX Sales and Service REST API
Oracle Fusion Cloud SCM REST API
Oracle Fusion Cloud Procurement REST API
Oracle Content Management API
OCI Generative AI API
OCI AI Vision API
OCI AI Language API
Where this information came from

This is an independent, third-party profile of Oracle Onboarding API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.