This documentation is for WSO2 API Manager 1.5.0 View documentation for the latest release.
Configuring api-manager.xml - API Manager 1.5.0 - WSO2 Documentation
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 14 Current »

Users can change the default API Manager functionality related configurations by editing <PRODUCT_HOME>/repository/conf/api-manager.xml file using the information given below.

XML elements

XML elementDescriptionData typeDefault valueFixed valuesMandatory/OptionalSample
<DataSourceName/>JNDI name of the datasource to be used by the API publisher, API store and API key manager. This datasource should be defined in the master-datasources.xml file in conf/datasources directory.StringN/AN/A 
<DataSourceName>jdbc/WSO2AM_DB</DataSourceName>
<GatewayType/>This parameter is used when adding api management capability to other products like GReg, AS, DSS etc.String   <GatewayType>Synapse</GatewayType>
<Database/>

Database configuration used by API publisher, API store and API key manager. When these components are deployed separately, each of them should have separate database configurations pointing to the same physical database.

StringN/AN/A 
<Database>
     <URL>jdbc:h2:repository/database/WSO2AM_DB</URL>
     <Username>wso2carbon</Username>    
     <Password>wso2carbon</Password>
     <Driver>org.h2.Driver</Driver
</Database>
      <URL/>JDBC connection string for the databaseStringN/AN/A  
     <Username/>JDBC username for the databaseStringN/AN/A  
     <Password/>JDBC password for the databaseStringN/AN/A  
     <Driver>JDBC driver for the databaseStringN/AN/A  
<AuthManager/>

Authentication manager configuration for API publisher and API store. This is a required configuration for both web applications as their user authentication logic relies on this.

   

 

 

<AuthManager>
  <ServerURL>https://${carbon.local.ip}:${mgt.transport.https.port}/services/</ServerURL>
  <Username>admin</Username>
  <Password>admin</Password>
</AuthManager>
     <ServerURL/>Server URL of the Authentication service     
     <Username/>Admin username for the Authentication manager     
     <Password>Admin password for the Authentication manager     
       
       


 Click on an element to view its details.

  • <APIManager>
  •        <DataSourceName>
  •        <Database>
  •                <URL>
  •                <Username>
  •                <Password>
  •                <Driver>
  •        <AuthManager>

  •                <ServerURL>

  •                <Username>

  •                <Password>

  •        <APIConsumerAuthentication>

  •                <SecurityContextHeader>

  •                <ClaimsRetrieverImplClass>

  •                <ConsumerDialectURI>

  •                <SignatureAlgorithm>

  •                <EnableTokenGeneration>
  •        <APIGateway>
    • <Environments>
      • <Environment type="hybrid">
        • <ServerURL>
        • <Username>

        • <Password>

        • <GatewayEndpoint>
    • <EnableGatewayKeyCache>
    • <ClientDomainHeader>
  •        <APIUsageTracking>

  •                <Enabled>

  •                <PublisherClass>

  •                <ThriftPort>

  •                <BAMServerURL>

  •                <BAMUsername>

  •                <BAMPassword>

  •                <DataSourceName>

  •       <APIKeyManager>

  •                <ServerURL>

  •                <Username>

  •                <Password>

  •                <EnableJWTCache>

  •               <EnableKeyMgtValidationInfoCache>

  •               <KeyValidatorClientType>

  •               <ThriftClientPort>

  •               <ThriftClientConnectionTimeOut>

  •               <ThriftServerPort>

  •               <RemoveUserNameToJWTForApplicationToken>

  •       <TierManagement>

  •               <EnableUnlimitedTier>

  •       <SelfSignUp>

  •               <Enabled>

  •               <SubscriberRoleName>

  •               <CreateSubscriberRole>

  •       <APIStore>

  •               <DisplayMultipleVersions>

  •               <DisplayAllAPIs>

  •               <DisplayComments>

  •               <DisplayRatings>

  •       <StatusObservers>

  •               <Observer>

 


<Database>

XML Syntax 
Description 
Type 
Default Value 
Fixed Values 
Mandatory/Optional 
Sub Elements
Sub ElementXML SyntaxDescriptionTypeDefault ValueFixed ValuesMandatory/Optional
<URL>      
<Username>      

<Password>

      

<Driver>

      
 
Sample Implementations

Back to Top ^


 <AuthManager> 

XML Syntax 
Description 
Type 
Default Value 
Fixed Values 
Mandatory/Optional 
Sub Elements
Sub ElementXML SyntaxDescriptionTypeDefault ValueFixed ValuesMandatory/Optional
<ServerURL>      
<Username>      

<Password>

      
 
Sample Implementations

Back to Top ^


<APIConsumerAuthentication> 

XML Syntax 
Description 
Type 
Default Value 
Fixed Values 
Mandatory/Optional 
Sub Elements
Sub ElementXML SyntaxDescriptionTypeDefault ValueFixed ValuesMandatory/Optional
<SecurityContextHeader>      
<ClaimsRetrieverImplClass>      

<ConsumerDialectURI>

      
<SignatureAlgorithm>      
<EnableTokenGeneration>      
Sample Implementations

Back to Top ^


<APIGateway>

XML Syntax<APIGateway>
DescriptionStores Information Related to the API Gateway(s) to which an API will be published to
Type 
Default Value 
Fixed Values 
Mandatory/OptionalMandatory
Sub Elements
Sub ElementXML SyntaxDescriptionTypeDefault ValueFixed ValuesMandatory/Optional
<Environments><Environments>Lists all configured API Gateway environments   Mandatory
<Environment><Environment type="hybrid | production | sandbox">Defines the environment details of a Gateway   At least 1 environment mandatory
<Name><Name>The name of the given Gateway Environment Production and Sandbox Mandatory
<ServerURL><ServerURL>Specifies the server management url of the API Gateway   Mandatory
<Username><Username>Specifies the administrative username of the API Gateway admin Mandatory

<Password>

<Password>Specifies the administrative password of the API Gateway admin Mandatory
<GatewayEndpoint><GatewayEndpoint>Specifies the gateway url to be exposed for calling clients   Mandatory
<EnableGatewayKeyCache><EnableGatewayKeyCache>Enables/Disables key (token) caching at the Gateway false  
<ClientDomainHeader><ClientDomainHeader>

Header name is configurable. When an API invocation is restricted to authorized domains, the request must send the domain name as the value of this element. So that the API Gateway can identify it as an authorized request and allow access to the APIs. Also see Application Access Tokens.

 referer  
 
Sample Implementations

 

<APIGateway>
   <Environments>
      <Environment type="hybrid">
         <Name>Production and Sandbox</Name>
         <ServerURL>https://10.100.1.100:9443/services/</ServerURL>
         <Username>admin</Username>
         <Password>admin</Password>
         <GatewayEndpoint>http://10.100.1.100:8280,https://10.100.1.100:8243</GatewayEndpoint>
      </Environment>
      <Environment type="production">
         <Name>Production</Name>
         <ServerURL>https://10.100.1.101:9443/services/</ServerURL>
         <Username>admin</Username>
         <Password>admin</Password>
         <GatewayEndpoint>http://10.100.1.101:8280,https://10.100.1.101:8243</GatewayEndpoint>
      </Environment>
      <Environment type="sandbox">
         <Name>Sandbox</Name>
         <ServerURL>https://10.100.1.102:9443/services/</ServerURL>
         <Username>admin</Username>
         <Password>admin</Password>
         <GatewayEndpoint>http://10.100.1.102:8280,https://10.100.1.102:8243</GatewayEndpoint>
      </Environment>
      </Environments>
     <EnableGatewayKeyCache>false</EnableGatewayKeyCache>
     <ClientDomainHeader>referer</ClientDomainHeader>
</APIGateway>

Back to Top ^


<APIUsageTracking> 

XML Syntax 
Description 
Type 
Default Value 
Fixed Values 
Mandatory/Optional 
Sub Elements
Sub ElementXML SyntaxDescriptionTypeDefault ValueFixed ValuesMandatory/Optional
<Enabled>      
<PublisherClass>      

<ThriftPort>

      
<BAMServerURL>      
<BAMUsername>      
<BAMPassword>      

<DataSourceName>

      
 
Sample Implementations

Back to Top ^


<APIKeyManager> 

XML Syntax 
Description 
Type 
Default Value 
Fixed Values 
Mandatory/Optional 
Sub Elements
Sub ElementXML SyntaxDescriptionTypeDefault ValueFixed ValuesMandatory/Optional
<ServerURL>      
<Username>      

<Password>

      
<EnableJWTCache>      
<EnableKeyMgtValidationInfoCache>      
<KeyValidatorClientType>      

<ThriftClientPort>

      
<ThriftClientConnectionTimeOut>      
<ThriftServerPort>      
<RemoveUserNameToJWTForApplicationToken>      
 
Sample Implementations

Back to Top ^


<TierManagement> 

XML Syntax 
Description 
Type 
Default Value 
Fixed Values 
Mandatory/Optional 
Sub Elements
Sub ElementXML SyntaxDescriptionTypeDefault ValueFixed ValuesMandatory/Optional
<EnableUnlimitedTier>      
 
Sample Implementations

Back to Top ^


<SelfSignUp> 

XML Syntax 
Description 
Type 
Default Value 
Fixed Values 
Mandatory/Optional 
Sub Elements
Sub ElementXML SyntaxDescriptionTypeDefault ValueFixed ValuesMandatory/Optional
<Enabled>      
<SubscriberRoleName>      

<CreateSubscriberRole>

      
 
Sample Implementations

Back to Top ^


<APIStore> 

XML Syntax 
Description 
Type 
Default Value 
Fixed Values 
Mandatory/Optional 
Sub Elements
Sub ElementXML SyntaxDescriptionTypeDefault ValueFixed ValuesMandatory/Optional
<DisplayMultipleVersions>      
<DisplayAllAPIs>      

<DisplayComments>

      
<DisplayRatings>      
 
Sample Implementations

Back to Top ^


<StatusObservers> 

XML Syntax 
Description 
Type 
Default Value 
Fixed Values 
Mandatory/Optional 
Sub Elements
Sub ElementXML SyntaxDescriptionTypeDefault ValueFixed ValuesMandatory/Optional
<Observer>      
 
Sample Implementations

<ExtensionHandlerPosition>

When an API is invoked, a list of handlers gets engaged to its execution flow. The Extension Handler by default is the last handler in the execution flow. This attribute enables configuring its position. 

Supported values: top, bottom

Defaults to: bottom

Back to Top ^


  • No labels