Unknown macro: {next_previous_links}
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 13 Next »

Note

This page is still under construction.

Users can change the default API Manager-specific configurations by editing api-manager.xml file using the information given below.

File Details

  • File Name: api-manager.xml
  • Location: $AM_HOME\repository\conf
  • Purpose:

XML Elements

 Click on a main element to view its details along with specifics on its sub elements.

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

  •        <AuthManager>

  •                <ServerURL>

  •                <Username>

  •                <Password>

  •        <APIConsumerAuthentication>

  •                <SecurityContextHeader>

  •                <ClaimsRetrieverImplClass>

  •                <ConsumerDialectURI>

  •                <SignatureAlgorithm>

  •                <EnableTokenGeneration>
  •        <APIGateway>

  •                <ServerURL>

  •                <Username>

  •                <Password>

  •                <APIEndpointURL>
  •                <EnableGatewayKeyCache>

  •        <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>

<APIManager>

XML Syntax 
Description 
Type 
Default Value 
Fixed Values 
Mandatory/Optional 
Samples 

Back to Top ^

 <DataSourceName> 

XML Syntax 
Description 
Type 
Default Value 
Fixed Values 
Mandatory/Optional 
Samples 

Back to Top ^

<Database>

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

<Password>

      

<Driver>

      
Samples

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>

      
Samples

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>      
Samples

Back to Top ^

<APIGateway>

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

<Password>

      
<APIEndpointURL>      
<EnableGatewayKeyCache>      
Samples

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>

      
Samples

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>      
Samples

Back to Top ^

<TierManagement> 

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

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>

      
Samples

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>      
Samples

Back to Top ^

<StatusObservers> 

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

Back to Top ^


  • No labels
Unknown macro: {next_previous_links2}