> ## Documentation Index
> Fetch the complete documentation index at: https://docs.flexagon.com/llms.txt
> Use this file to discover all available pages before exploring further.

# FlexDeploy - Oracle API Platform Plugin Guide

> A plugin for managing APIs and other components in Oracle API Platform. Java 7 or 8 must be used on the endpoint Key Features Automated provisioning o

A plugin for managing APIs and other components in Oracle API Platform.

* Java 7 or 8 must be used on the endpoint

# Key Features

* Automated provisioning of gateways and gateway nodes

* Update your API state as you deploy across gateways

* Apply API grants as you import new and existing APIs

* Easily roll back changes or build from previous API iterations

* Ensure you have the same iteration of your API deploying across gateways

# FlexDeploy Project Recommendations

<table><colgroup><col /><col /><col /><col /><col /></colgroup><tbody><tr><th>**API Component**</th><th>**Build Workflow**</th><th>**Deploy Workflow**</th><th>**Project Setup**</th><th>**General Notes**</th></tr><tr><td>API</td><td>ExportAPI</td><td>ImportAPI (using smart import)DeployAPI(use the output iteration from the import step)</td><td>One project per API.</td><td><ul><li>Group in a release along with whatever back-end code is needed.</li><li>Recommend saving the API iterations as workflow outputs for visibility. </li><li>Use a groovy expression to update the API status on Deployment based on the FD\_ENVIRONMENT\_CODE</li></ul></td></tr><tr><td>Gateway/Nodes</td><td>Export gateway and node json files</td><td>ImportGatewayInstallNode</td><td>Nothing real specific here.  One project that manages all the gateways/nodes should suffice. </td><td><ul><li>Json configuration files for the nodes and gateways should utilize FD variables for environment specifics</li><li>Default behavior for installNode joins it to an existing logical server (this can be overridden).</li></ul></td></tr></tbody></table>

# Plugin Operations

* [deployAPI](https://docs.flexagon.com/flexdeploy-11-1-documentation/flexdeploy-plugin-guides/flexdeploy-oracle-api-platform-plugin-guide/deployapi.md)
* [executeNodeAction](https://docs.flexagon.com/flexdeploy-11-1-documentation/flexdeploy-plugin-guides/flexdeploy-oracle-api-platform-plugin-guide/executenodeaction.md)
* [exportAPI](https://docs.flexagon.com/flexdeploy-11-1-documentation/flexdeploy-plugin-guides/flexdeploy-oracle-api-platform-plugin-guide/exportapi.md)
* [importAPI](https://docs.flexagon.com/flexdeploy-11-1-documentation/flexdeploy-plugin-guides/flexdeploy-oracle-api-platform-plugin-guide/importapi.md)
* [importGateway](https://docs.flexagon.com/flexdeploy-11-1-documentation/flexdeploy-plugin-guides/flexdeploy-oracle-api-platform-plugin-guide/importgateway.md)
* [installNode](https://docs.flexagon.com/flexdeploy-11-1-documentation/flexdeploy-plugin-guides/flexdeploy-oracle-api-platform-plugin-guide/installnode.md)
* [Appendix - Oracle API Platform](https://docs.flexagon.com/flexdeploy-11-1-documentation/flexdeploy-plugin-guides/flexdeploy-oracle-api-platform-plugin-guide/appendix-oracle-api-platform.md)
* [updateAPIPublication](https://docs.flexagon.com/flexdeploy-11-1-documentation/flexdeploy-plugin-guides/flexdeploy-oracle-api-platform-plugin-guide/updateapipublication.md)

# Permissions and Security

It is suggested that the user account configured on the API Platform cloud account have the 'Manage' grant on all API platform objects. This is not necessarily required depending upon the functionality that will be utilized. 

> [!NOTE]
>
> ### Manage Group
>
> Generally speaking, there is probably a user group that already has the Manage grants, ManageAPIGrant, ManagePlanGrant etc on the API platform objects. Configuring the account for a user already in this group should be sufficient.

# Cloud Account and where to find the properties

> [!NOTE]
>
> ### Cloud Account
>
> All plugin operations require the **FDOAP\_CLOUD\_ACCOUNT\_CODE** Target property to be set.  See [Configuring Cloud Accounts](https://docs.flexagon.com/flexdeploy-11-1-documentation/flexdeploy-users-guide/integrations/cloud-account-and-provider.md) for more info.  The following properties are required for the Oracle API Platform Cloud Account

<table><colgroup><col /><col /><col /><col /></colgroup><tbody><tr><th>**Property Name**</th><th>**Property Code**</th><th>**Required**</th><th>**Description**</th></tr><tr><td>Oracle API Platform Url</td><td>`FDOAP_API_URL`</td><td>Yes</td><td>Base Url for the API Platform</td></tr><tr><td>Oracle Identity Url</td><td>`FDOAP_IDENTITY_URL`</td><td>Yes</td><td>Base Url for Oracle Identity</td></tr><tr><td>Oracle API Username</td><td>`FDOAP_USERNAME`</td><td>Yes</td><td>Username for authentication</td></tr><tr><td>Oracle API Password</td><td>`FDOAP_PASSWORD`</td><td>Yes</td><td>Password for authentication</td></tr><tr><td>Oracle API Audience</td><td>`FDOAP_AUDIENCE`</td><td>Yes</td><td>Primary Audience for the API Platform</td></tr><tr><td>Oracle API Scope</td><td>`FDOAP_SCOPE`</td><td>Yes</td><td>Scope for making API calls</td></tr><tr><td>Oracle API Client Id</td><td>`FDOAP_CLIENT_ID`</td><td>Yes</td><td>Client Id for the API Platform Application</td></tr><tr><td>Oracle API Client Secret</td><td>`FDOAP_CLIENT_SECRET`</td><td>Yes</td><td>Client Secret for the API Platform Application</td></tr></tbody></table>

![Image](https://mintcdn.com/flexagon-llc-ce77a95c/NkeZh5D-Nf8j_WaD/images/fd111/12590938747.png?fit=max\&auto=format\&n=NkeZh5D-Nf8j_WaD\&q=85\&s=06bd6910d206b219a255309449ee0dc9)

From the MyServices dashboard.. click 'Users' and then 'Identity Console'

![Image](https://mintcdn.com/flexagon-llc-ce77a95c/NkeZh5D-Nf8j_WaD/images/fd111/12590938744.png?fit=max\&auto=format\&n=NkeZh5D-Nf8j_WaD\&q=85\&s=824d5063bfdba51cfa2275d7fb4cab0a)

![Image](https://mintcdn.com/flexagon-llc-ce77a95c/NkeZh5D-Nf8j_WaD/images/fd111/12590938750.png?fit=max\&auto=format\&n=NkeZh5D-Nf8j_WaD\&q=85\&s=1bf4a95eb39631ae440199263bec8599)