Configuring api-manager.xml
- Former user (Deleted)
- Former user (Deleted)
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: $CARBON_HOME\repository\conf
- Purpose: Store all API Manager functionality related configurations.
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 | Â |
Sample Implementations
 <DataSourceName>Â
| XML Syntax | Â |
|---|---|
| Description | Â |
| Type | Â |
| Default Value | Â |
| Fixed Values | Â |
| Mandatory/Optional | Â |
Â
Sample Implementations
<Database>
| XML Syntax | Â |
|---|---|
| Description | Â |
| Type | Â |
| Default Value | Â |
| Fixed Values | Â |
| Mandatory/Optional | Â |
Sub Elements
| Sub Element | XML Syntax | Description | Type | Default Value | Fixed Values | Mandatory/Optional |
|---|---|---|---|---|---|---|
| <URL> | Â | Â | Â | Â | Â | Â |
| <Username> | Â | Â | Â | Â | Â | Â |
<Password> | Â | Â | Â | Â | Â | Â |
<Driver> | Â | Â | Â | Â | Â | Â |
Â
Sample Implementations
 <AuthManager>Â
| XML Syntax | Â |
|---|---|
| Description | Â |
| Type | Â |
| Default Value | Â |
| Fixed Values | Â |
| Mandatory/Optional | Â |
Sub Elements
| Sub Element | XML Syntax | Description | Type | Default Value | Fixed Values | Mandatory/Optional |
|---|---|---|---|---|---|---|
| <ServerURL> | Â | Â | Â | Â | Â | Â |
| <Username> | Â | Â | Â | Â | Â | Â |
<Password> | Â | Â | Â | Â | Â | Â |
Â
Sample Implementations
<APIConsumerAuthentication>Â
| XML Syntax | Â |
|---|---|
| Description | Â |
| Type | Â |
| Default Value | Â |
| Fixed Values | Â |
| Mandatory/Optional | Â |
Sub Elements
| Sub Element | XML Syntax | Description | Type | Default Value | Fixed Values | Mandatory/Optional |
|---|---|---|---|---|---|---|
| <SecurityContextHeader> | Â | Â | Â | Â | Â | Â |
| <ClaimsRetrieverImplClass> | Â | Â | Â | Â | Â | Â |
<ConsumerDialectURI> | Â | Â | Â | Â | Â | Â |
| <SignatureAlgorithm> | Â | Â | Â | Â | Â | Â |
| <EnableTokenGeneration> | Â | Â | Â | Â | Â | Â |
Sample Implementations
<APIGateway>
| XML Syntax | Â |
|---|---|
| Description | Â |
| Type | Â |
| Default Value | Â |
| Fixed Values | Â |
| Mandatory/Optional | Â |
Sub Elements
| Sub Element | XML Syntax | Description | Type | Default Value | Fixed Values | Mandatory/Optional |
|---|---|---|---|---|---|---|
| <ServerURL> | Â | Â | Â | Â | Â | Â |
| <Username> | Â | Â | Â | Â | Â | Â |
<Password> | Â | Â | Â | Â | Â | Â |
| <APIEndpointURL> | Â | Â | Â | Â | Â | Â |
| <EnableGatewayKeyCache> | Â | Â | Â | Â | Â | Â |
Â
Sample Implementations
<APIUsageTracking>Â
| XML Syntax | Â |
|---|---|
| Description | Â |
| Type | Â |
| Default Value | Â |
| Fixed Values | Â |
| Mandatory/Optional | Â |
Sub Elements
| Sub Element | XML Syntax | Description | Type | Default Value | Fixed Values | Mandatory/Optional |
|---|---|---|---|---|---|---|
| <Enabled> | Â | Â | Â | Â | Â | Â |
| <PublisherClass> | Â | Â | Â | Â | Â | Â |
<ThriftPort> | Â | Â | Â | Â | Â | Â |
| <BAMServerURL> | Â | Â | Â | Â | Â | Â |
| <BAMUsername> | Â | Â | Â | Â | Â | Â |
| <BAMPassword> | Â | Â | Â | Â | Â | Â |
<DataSourceName> | Â | Â | Â | Â | Â | Â |
Â
Sample Implementations
<APIKeyManager>Â
| XML Syntax | Â |
|---|---|
| Description | Â |
| Type | Â |
| Default Value | Â |
| Fixed Values | Â |
| Mandatory/Optional | Â |
Sub Elements
| Sub Element | XML Syntax | Description | Type | Default Value | Fixed Values | Mandatory/Optional |
|---|---|---|---|---|---|---|
| <ServerURL> | Â | Â | Â | Â | Â | Â |
| <Username> | Â | Â | Â | Â | Â | Â |
<Password> | Â | Â | Â | Â | Â | Â |
| <EnableJWTCache> | Â | Â | Â | Â | Â | Â |
| <EnableKeyMgtValidationInfoCache> | Â | Â | Â | Â | Â | Â |
| <KeyValidatorClientType> | Â | Â | Â | Â | Â | Â |
<ThriftClientPort> | Â | Â | Â | Â | Â | Â |
| <ThriftClientConnectionTimeOut> | Â | Â | Â | Â | Â | Â |
| <ThriftServerPort> | Â | Â | Â | Â | Â | Â |
| <RemoveUserNameToJWTForApplicationToken> | Â | Â | Â | Â | Â | Â |
Â
Sample Implementations
<TierManagement>Â
| XML Syntax | Â |
|---|---|
| Description | Â |
| Type | Â |
| Default Value | Â |
| Fixed Values | Â |
| Mandatory/Optional | Â |
Sub Elements
| Sub Element | XML Syntax | Description | Type | Default Value | Fixed Values | Mandatory/Optional |
|---|---|---|---|---|---|---|
| <EnableUnlimitedTier> | Â | Â | Â | Â | Â | Â |
Â
Sample Implementations
<SelfSignUp>Â
| XML Syntax | Â |
|---|---|
| Description | Â |
| Type | Â |
| Default Value | Â |
| Fixed Values | Â |
| Mandatory/Optional | Â |
Sub Elements
| Sub Element | XML Syntax | Description | Type | Default Value | Fixed Values | Mandatory/Optional |
|---|---|---|---|---|---|---|
| <Enabled> | Â | Â | Â | Â | Â | Â |
| <SubscriberRoleName> | Â | Â | Â | Â | Â | Â |
<CreateSubscriberRole> | Â | Â | Â | Â | Â | Â |
Â
Sample Implementations
<APIStore>Â
| XML Syntax | Â |
|---|---|
| Description | Â |
| Type | Â |
| Default Value | Â |
| Fixed Values | Â |
| Mandatory/Optional | Â |
Sub Elements
| Sub Element | XML Syntax | Description | Type | Default Value | Fixed Values | Mandatory/Optional |
|---|---|---|---|---|---|---|
| <DisplayMultipleVersions> | Â | Â | Â | Â | Â | Â |
| <DisplayAllAPIs> | Â | Â | Â | Â | Â | Â |
<DisplayComments> | Â | Â | Â | Â | Â | Â |
| <DisplayRatings> | Â | Â | Â | Â | Â | Â |
Â
Sample Implementations
<StatusObservers>Â
| XML Syntax | Â |
|---|---|
| Description | Â |
| Type | Â |
| Default Value | Â |
| Fixed Values | Â |
| Mandatory/Optional | Â |
Sub Elements
| Sub Element | XML Syntax | Description | Type | Default Value | Fixed Values | Mandatory/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