-
apiman(options)
-
Initializes the apiman client.
Parameters:
| Name |
Type |
Description |
options |
object
|
Request options.
Properties
| Name |
Type |
Description |
baseUrl |
string
|
The Base url, e.g. http://localhost:8080 |
username |
string
|
The Apiman admin username. |
password |
string
|
The Apiman admin password. |
|
-
availablePlugins()
-
Returns all available plugins.
Returns:
A promise that will resolve with available plugins.
-
Type
-
Promise
-
currentUserAPIOrganizations()
-
Returns all the organizations with APIs for the current user.
Returns:
A promise that will resolve with organizations.
-
Type
-
Promise
-
currentUserAPIs()
-
Returns all of the APIs the current user has permission to edit.
Returns:
A promise that will resolve with current user APIs.
-
Type
-
Promise
-
currentUserClientOrganizations()
-
Returns all the organizations with clients for the current user
has permission to edit clients.
Returns:
A promise that will resolve with organizations.
-
Type
-
Promise
-
currentUserClients()
-
Returnsall the clients for the current user
has permission to edit clients.
Returns:
A promise that will resolve with current user clients.
-
Type
-
Promise
-
currentUserInfo()
-
Returns information about the current authenticated user.
Returns:
A promise that will resolve with the current user information.
-
Type
-
Promise
-
currentUserPlanOrganizations()
-
Returns all the organizations for which the current user
has permission to edit plans.
Returns:
A promise that will resolve with the list of organizations.
-
Type
-
Promise
-
currentUserUpdate(email, fullName)
-
Updates information about the current authenticated user.
Parameters:
| Name |
Type |
Description |
email |
string
|
User's email. |
fullName |
string
|
User's full name. |
Returns:
A promise that will resolve with 204 No Content if the update is successful.
-
Type
-
Promise
-
exportData()
-
Exports the data from the API Manager as JSON. All data in the API Manager,
including global/admin information, will be exported.
Returns:
A promise that will resolve with the exported JSON data.
-
Type
-
Promise
-
gateway(id)
-
Returns information about the Gateway.
Parameters:
| Name |
Type |
Description |
id |
string
|
The ID of the Gateway. |
Returns:
A promise that will resolve with gateway.
-
Type
-
Promise
-
gatewayAdd(gatewayRepresentation)
-
This function is used to create a new Gateway.
Parameters:
| Name |
Type |
Description |
gatewayRepresentation |
object
|
An object representing the gateway. |
Returns:
A promise that will resolve with the new gateway created.
-
Type
-
Promise
-
gatewayDelete(id)
-
This function is used to remove a Gateway.
Parameters:
| Name |
Type |
Description |
id |
string
|
The ID of the Gateway. |
Returns:
A promise that will resolve with 204 No Content if the delete is successful.
-
Type
-
Promise
-
gateways()
-
Returns all the Gateways that have been configured.
Returns:
A promise that will resolve with gateways.
-
Type
-
Promise
-
importData(filePath)
-
Imports the backup settings into the API Manager.
Parameters:
| Name |
Type |
Description |
filePath |
string
|
The full path of settings file. |
Returns:
A promise that will resolve with the output messages of the imported configurations.
-
Type
-
Promise
-
organization(id)
-
Returns information about the organization.
Parameters:
| Name |
Type |
Description |
id |
string
|
The ID of the organization. |
Returns:
A promise that will resolve with organization.
-
Type
-
Promise
-
organizationAdd(name, description)
-
This function is used to create a new Organization.
Parameters:
| Name |
Type |
Description |
name |
string
|
Organization's name. |
description |
string
|
Organizations's description. |
Returns:
A promise that will resolve with the new organization created.
-
Type
-
Promise
-
organizationDelete(id)
-
This function is used to remove a Organization.
Parameters:
| Name |
Type |
Description |
id |
string
|
The ID of the Organization. |
Returns:
A promise that will resolve with 204 No Content if the delete is successful.
-
Type
-
Promise
-
permissions()
-
Returns all of the permissions assigned to the current authenticated user.
Returns:
A promise that will resolve with permissions.
-
Type
-
Promise
-
permissionsUser(id)
-
Returns all permissions of specific user.
Parameters:
| Name |
Type |
Description |
id |
string
|
The ID of the user. |
Returns:
A promise that will resolve with user permissions.
-
Type
-
Promise
-
plugin(id)
-
Returns information about the Plugin.
Parameters:
| Name |
Type |
Description |
id |
string
|
The ID of the Plugin. |
Returns:
A promise that will resolve with plugin.
-
Type
-
Promise
-
pluginAdd(pluginRepresentation)
-
This function is used to create a new Plugin.
Parameters:
| Name |
Type |
Description |
pluginRepresentation |
object
|
An object representing the plugin. |
Returns:
A promise that will resolve with the new plugin created.
-
Type
-
Promise
-
pluginDelete(id)
-
This function is used to remove a Plugin.
Parameters:
| Name |
Type |
Description |
id |
string
|
The ID of the Plugin. |
Returns:
A promise that will resolve with 204 No Content if the delete is successful.
-
Type
-
Promise
-
plugins()
-
Returns all plugins that have been added to the system.
Returns:
A promise that will resolve with plugins.
-
Type
-
Promise
-
policyDefinition(id)
-
Returns information about the policy definition.
Parameters:
| Name |
Type |
Description |
id |
string
|
The ID of the policy definition. |
Returns:
A promise that will resolve with policy definition.
-
Type
-
Promise
-
policyDefinitionDelete(id)
-
This function is used to remove a policy definition.
Parameters:
| Name |
Type |
Description |
id |
string
|
The ID of the policy definition. |
Returns:
A promise that will resolve with 204 No Content if the delete is successful.
-
Type
-
Promise
-
policyDefinitions()
-
Returns all the policy definitions currently defined in apiman.
Returns:
A promise that will resolve with policy definitions.
-
Type
-
Promise
-
role(id)
-
Returns information about the role.
Parameters:
| Name |
Type |
Description |
id |
string
|
The ID of the role. |
Returns:
A promise that will resolve with role.
-
Type
-
Promise
-
roleDelete(id)
-
This function is used to remove a Role.
Parameters:
| Name |
Type |
Description |
id |
string
|
The ID of the Role. |
Returns:
A promise that will resolve with 204 No Content if the delete is successful.
-
Type
-
Promise
-
roles()
-
Returns all the roles currently defined in apiman.
Returns:
A promise that will resolve with roles.
-
Type
-
Promise
-
status()
-
Returns the status of the apiman system.
This is useful to use when testing a client's connection
to the apiman API Manager REST services.
Returns:
A promise that will resolve with the status information.
-
Type
-
Promise
-
user(id)
-
Returns information about the user.
Parameters:
| Name |
Type |
Description |
id |
string
|
The ID of the user. |
Returns:
A promise that will resolve with user.
-
Type
-
Promise
-
userAPIs(userId)
-
Returns all of the User's APIs.
Parameters:
| Name |
Type |
Description |
userId |
string
|
User's id. |
Returns:
A promise that will resolve with user APIs.
-
Type
-
Promise
-
userClients(userId)
-
Returns all of the User's clients.
Parameters:
| Name |
Type |
Description |
userId |
string
|
User's id. |
Returns:
A promise that will resolve with user clients.
-
Type
-
Promise
-
userOrganizations(userId)
-
Returns all of the User's organizations.
Parameters:
| Name |
Type |
Description |
userId |
string
|
User's id. |
Returns:
A promise that will resolve with user organizations.
-
Type
-
Promise
-
userUpdate(userId, email, fullName)
-
Updates information about the user.
Parameters:
| Name |
Type |
Description |
userId |
string
|
User's id. |
email |
string
|
User's email. |
fullName |
string
|
User's full name. |
Returns:
A promise that will resolve with 204 No Content if the update is successful.
-
Type
-
Promise