This implementation does nothing.

This implementation does nothing.

This implementation does nothing.

This implementation does nothing.

This implementation does nothing.

This implementation does nothing.

]]> A list of audit configurations. There can only be one. get () The audit configuration. dependencies () The dependency resource that will resolve dependencies update (com.l7tech.gateway.api.AuditConfigurationMO) A reference to the updated AuditConfiguration. resource template () The template AuditConfiguration. getRelatedLinks (com.l7tech.gateway.api.AuditConfigurationMO) getLink (com.l7tech.gateway.api.AuditConfigurationMO) getUrl (com.l7tech.objectmodel.EntityHeader) com.l7tech.external.assertions.gatewaymanagement.server.rest.resource.impl.PublishedServiceResource setFactory (com.l7tech.external.assertions.gatewaymanagement.server.rest.factories.impl.ServiceAPIResourceFactory) setTransformer (com.l7tech.external.assertions.gatewaymanagement.server.rest.transformers.impl.PublishedServiceTransformer) versions (java.lang.String) The policyVersion resource for handling policy version requests. id jakarta.ws.rs.PathParam value id create (com.l7tech.gateway.api.ServiceMO, java.lang.String) A reference to the newly created service resource comment jakarta.ws.rs.QueryParam value versionComment get (java.lang.String) The service. id jakarta.ws.rs.PathParam value id list (java.lang.String, java.lang.String, java.util.List<java.lang.String>, java.util.List<java.lang.String>, java.lang.Boolean, java.lang.Boolean, java.util.List<com.l7tech.objectmodel.Goid>, java.util.List<com.l7tech.objectmodel.Goid>) Returns a list of servicees. Can optionally sort the resulting list in ascending or descending order. Other params given will be used as search values.

Examples:

/restman/1.0/services?name=MyService

Returns service with name "MyService".

If a parameter is not a valid search value a bad request error will be returned.

Examples:

/restman/1.0/assertionSecurityZones?name=com.l7tech.external.assertions.jdbcquery.JdbcQueryAssertion

Returns assertion security zone of the Jdbc Query Assertion. The name of the assertion security zone is the fully qualified name of the assertion.

/restman/1.0/assertionSecurityZones?securityZone.id=0e028eafc5c66c3af755a2e470734948

Returns assertion security zones that have security zone ID "0e028eafc5c66c3af755a2e470734948"

If a parameter is not a valid search value a bad request error will be returned.

• Upload a SKAR file using a POST request.
• Set the encoding to multipart/form-data.
• Set the file upload form-field name as file. The uploaded file has to be signed (*.sskar format).
• Add other form-field name and value as needed.
  • entityIdReplace. Optional. To map one entity ID (from the SKAR) to an existing gateway entity ID to resolve entity conflict. Format [find_id]::[replace_with_id].
    • The Solution Kit Manager will replace the entity ID to the left of the double colon (::) with the entity ID to the right. E.g. set entityIdReplace to f1649a0664f1ebb6235ac238a6f71a6d::66461b24787941053fc65a626546e4bd.
    • Multiple values accepted (values from multiple fields with the same form-field name are treated as a list of values).
    • Mapping must be overridable from the solution kit author (e.g. mapping with srcId=[find_id] has SK_AllowMappingOverride = true). An error occurs when attempting to replace an non-overridable mapping.
  • solutionKitSelect: Optional. To select which solution kit in the uploaded SKAR will be installed and what instance modifier will be applied to the installed instance.
    • The value format of solutionKitSelect is [ID]::[IM], where "::" is a deliminator, [ID] is the GUID of the installed solution kit, and [IM] is the instance modifier applied to the installed instance. If [IM] is not specified, or the value of [IM] is empty, then the default instance modifier (empty value) is used.
    • If no solutionKitSelect provided, all solution kit(s) in the upload SKAR will be installed.
    • Multiple solutionKitSelect allowed: to specify multiple solution kits to install.
    • Note: the value of each instance modifier should not include "::", since "::" is a reserved delimiter.
  • solutionKitSelectByName: Since 1.0.6. Optional. To select which solution kit by name (instead of solutionKitSelect, which is by ID). The value format of solutionKitSelectByName is [name]::[IM], see solutionKitSelect for details.
  • instanceModifier. Optional. To specify an instance modifier applied to all installed solution kits. By default, if this form field is not specified or its value is empty, then this instance modifier uses a default value (empty value).
    • Applying instanceModifier is a quick way to apply a same instance modifier to a list of solution kits that have a same instance modifier. However, this instance modifier is only applied in the following two scenarios:
    • (1) No any solutionKitSelect specified (i.e., all solution kit(s) in the SKAR will be installed.)
    • (2) Some solutionKitSelect specified, but without [IM] specified.
    • Note: the value of each instance modifier should not include "::", since "::" is a reserved delimiter.
  • Passing values to the Custom Callback. Optional. All form-fields not listed above will be passed to the Custom Callback.

Here's a cURL example (note the use of the --insecure option for development only):

To Upgrade

• Specify a query parameter 'id' for a previous installed Solution Kit GUID in the request URL. The ID can be either a parent solution kit's GUID or a non-parent solution kit's GUID.
  For example:https://127.0.0.1:8443/restman/1.0/solutionKitManagers?id=33b16742-d62d-4095-8f8d-4db707e9ad52
• instanceModifier. Optional. To specify an existing instance modifier used to combine with the id query parameter to identify a unique solution kit for upgrade. The value format of instanceModifier is [Current Instance Modifier]. If this parameter is not specified, a default instance modifier will be used (default value: empty string or null).
• solutionKitSelect: Optional. To select which child solution kits in the uploaded SKAR will be selected for upgrade. The value format of solutionKitSelect is [ID].
• solutionKitSelectByName: Optional. To select by name (instead of solutionKitSelect, which is by ID). The value format of solutionKitSelectByName is [name].

Here's a cURL example (note the use of the --insecure option for development only):

• Use the type (1), if deleting a single non-parent solution kit.
• Use the type (2), if deleting all child solution kits with the specified instance modifier.
• Use the type (3), if deleting all child solution kits without an instance modifier.
• Use the type (4), if deleting some of child solution kits specified by an instance modifier [IM]. Omit "::[IM]" part of the request to delete some child solution kits without an instance modifier.

If a parameter is not a valid search value a bad request error will be returned.

The following actions are supported: list components, restman get migration bundle XML, wsman dry run install, wsman install and custom. For restman bundle, get migration bundle. For wsman bundle, execute dry run and install.

List components

List component id(s) available for this installer bundle. This is the default if no action parameter is provided.

Input HTTP parameter: set action to list

Output: List of component id(s), ";" separated. For example:

1c2a2874-df8d-4e1d-b8b0-099b576407e1;ba525763-6e55-4748-9376-76055247c8b1;f69c7d15-4999-4761-ab26-d29d58c0dd57;b082274b-f00e-4fbf-bbb7-395a95ca2a35;a07924c0-0265-42ea-90f1-2428e31ae5ae;
 

Restman get migration bundle

Get the restman migration bundle XML for the given component(s).

Input HTTP parameters:

• Set action to restman_get
• Set component_ids to a ";" separated list of component ids. Or set to all to specify all available installer components. This is equivalent to all component id(s) from the list action.
• Optionally set version_modifier - optional version modifier
• Optionally set folder_goid - optional install folder (if not set, defaults to root folder)

Output: The restman migration bundle XML for each component. For example:

<l7:Bundle xmlns:l7="http://ns.l7tech.com/2010/04/gateway-management">
     <l7:References>
         <l7:Item>
          ...
         </l7:Mapping>
     </l7:Mappings>
 </l7:Bundle>
 

Wsman dry run install

Execute wsman dry run install for given component(s).

Input HTTP parameters:

• Set action to wsman_dry_run
• Set component_ids to a ";" separated list of component ids. Or set to all to specify all available installer components. This is equivalent to all component id(s) from the list action.
• Optionally set version_modifier - optional version modifier
• Optionally map JDBC connection name to new name
  • Set jdbc_connection.<component_id>.name with existing name in bundle (e.g. OAuth)
  • Set jdbc_connection.<component_id>.new_name with a new desired name (e.g. OAuth Dev)

Output: The conflicts for each component. For example:

ComponentId: 1c2a2874-df8d-4e1d-b8b0-099b576407e1
 ServiceConflict: /auth/oauth/v1/token;/auth/oauth/v1/authorize/website;/oauth/v1/client;/protected/resource;/auth/oauth/v1/authorize;/auth/oauth/v1/request;/auth/oauth/v1/*
 PolicyConflict: OAuth 1.0 Context Variables;Require OAuth 1.0 Token;getClientSignature;Authenticate OAuth 1.0 Parameter;Token Lifetime Context Variables;GenerateOAuthToken;OAuth Client Token Store Context Variables
 CertificateConflict:
 JdbcConnectionsThatDontExist:
 MissingAssertions:
 EncapsulatedAssertionConflict:
 ...
 

It's recommended to not continue with installation if any conflicts are detected. Continuing the installation with detected conflicts may result in partial installation of components. Components with detected conflicts will not be installed. As a result, references to conflicted components may incorrectly reference the previous version of the component already on the Gateway (if one exists).

Wsman install

Execute wsman install for given component(s).

Input HTTP parameters:

• Set action to wsman_install
• Set component_ids to a ";" separated list of component ids. Or set to all to specify all available installer components. This is equivalent to all component id(s) from the list action.
• Optionally set version_modifier - optional version modifier
• Optionally set folder_goid - optional install folder (if not set, defaults to root folder)
• Optionally map JDBC connection name to new name
  • Set jdbc_connection.<component_id>.name with existing name in bundle (e.g. OAuth)
  • Set jdbc_connection.<component_id>.new_name with a new desired name (e.g. OAuth Dev)

Output: List of installed component id(s), ";" separated. For example:

1c2a2874-df8d-4e1d-b8b0-099b576407e1;ba525763-6e55-4748-9376-76055247c8b1;f69c7d15-4999-4761-ab26-d29d58c0dd57;b082274b-f00e-4fbf-bbb7-395a95ca2a35;a07924c0-0265-42ea-90f1-2428e31ae5ae
 

Custom

An installer can implement custom action, custom wsman dry run and install logic. For example the OAuth installer implements its own custom action to get a database schema. It also executes custom logic to integrate API Portal for wsman dry run and install.

Input: Set HTTP parameter action to custom in order to choose a custom action. And set HTTP parameter(s) required for the custom installer.

Examples:

/restman/1.0/roles?name=MyRole

Returns role with name "MyRole".

If a parameter is not a valid search value a bad request error will be returned.

Examples:

/restman/1.0/folders?name=MyFolder

Returns folder with name "MyFolder".

If a parameter is not a valid search value a bad request error will be returned.

Examples:

/restman/1.0/listenPorts?name=MyListenPort

Returns listen port with name "MyListenPort".

If a parameter is not a valid search value a bad request error will be returned.

Examples:

/restman/1.0/securityZones?name=MySecurityZone

Returns security zone with name "MySecurityZone".

If a parameter is not a valid search value a bad request error will be returned.

Examples:

/restman/1.0/activeConnectors?name=MyEncass

Returns encapsulated assertion with name "MyEncass".

If a parameter is not a valid search value a bad request error will be returned.

Examples:

/restman/1.0/customKeyValues?key=MyKey

Returns custom key value with key "MyKey".

If a parameter is not a valid search value a bad request error will be returned.

Examples:

/restman/1.0/activeConnectors?name=MySFTPPollingListener

Returns active connector with name "MySFTPPollingListener".

/restman/1.0/activeConnectors?type=SFTP&name=MySFTPPollingListener&name=MyOtherSFTPPollingListener

Returns active connector of SFTP type with name either "MySFTPPollingListener" or "MyOtherSFTPPollingListener"

If a parameter is not a valid search value a bad request error will be returned.

Examples:

/restman/1.0/jmsDestinations?name=MyJMSDestination

Returns JMS destination with name "MyJMSDestination".

If a parameter is not a valid search value a bad request error will be returned.

Examples:

/restman/1.0/serviceAliases?service.id=26df9b0abc4dd6780fd9da5929cde13e

Returns service aliases for service with ID "26df9b0abc4dd6780fd9da5929cde13e".

If a parameter is not a valid search value a bad request error will be returned.

Examples:

/restman/interfaceTags?name=MyInterface

Returns interface with name = "MyInterface"

/restman/interfaceTags?name=MyInterface&name=MyInterfaceProd

Returns interfaces with name either "MyInterface" or "MyInterfaceProd"

If a parameter is not a valid search value a bad request error will be returned.

If a parameter is not a valid search value a bad request error will be returned.

Examples:

/restman/1.0/emailListeners?name=MyEmailListener

Returns email listener with name "MyEmailListener".

/restman/1.0/emailListeners?serverTypes=IMAP

Returns email listeners of IMAP type

If a parameter is not a valid search value a bad request error will be returned.

Examples:

/restman/1.0/trustedCertificates?name=MyCertificate

Returns certificates with name "MyCertificate".

If a parameter is not a valid search value a bad request error will be returned.

Examples:

/restman/1.0/policies?name=MyPolicy

Returns policy with name "MyPolicy".

If a parameter is not a valid search value a bad request error will be returned.

Example request:

 <l7:ServerModuleFile xmlns:l7="http://ns.l7tech.com/2010/04/gateway-management">
     <l7:Name>module name</l7:Name>
     .......
     <l7:Properties>
         <l7:Property key="moduleAssertions">
              <l7:StringValue>TestAssertion1,TestAssertion2</l7:StringValue>
         </l7:Property>
         <l7:Property key="moduleFileName">
              <l7:StringValue>testAssertion.jar</l7:StringValue>
         </l7:Property>
         <l7:Property key="moduleSize">
              <l7:StringValue>38191</l7:StringValue>
         </l7:Property>
     </l7:Properties>
 </l7:ServerModuleFile>
 

When ServerModuleFile functionality is disabled this method will fail with FORBIDDEN (403).

This responds with a reference to the newly created ServerModuleFile.

When ServerModuleFile functionality is disabled this method will fail with FORBIDDEN (403).

Examples:

/restman/1.0/serverModuleFiles?name=MyServerModuleFile

Returns ServerModuleFile with name "MyServerModuleFile".

If a parameter is not a valid search value a bad request error will be returned.