API Manager configuration
none
| Field Name |
Type |
Since Version |
Description |
portalName |
String |
|
The name of the API Manager. |
portalHostname |
String |
|
The network hostname or IP Address of the API Manager which will be used in email links. |
apiPortalName |
String |
|
The name of the API Portal |
apiPortalHostname |
String |
|
The network hostname or IP Address of the API Portal which will be used in email links. |
isApiPortalConfigured |
Boolean |
|
Indicates if the API Portal is configured. |
registrationEnabled |
Boolean |
|
Enables/disables user registration for the API Manager |
resetPasswordEnabled |
Boolean |
|
Enables/disables spport for resetting user passwords for the API Manager |
minimumPasswordLength |
Int |
|
The minimum password length. |
autoApproveUserRegistration |
Boolean |
|
Enables/disables auto-approve for user registration whereby API Administrator or Organization Administrator approval is not required. |
systemOAuthScopesEnabled |
Boolean |
|
Enables/disables the ability to add System scopes to an Application. These scopes represent Gateway OAuth resources that are not covered by APIs. |
autoApproveApplications |
Boolean |
|
Enables/disables auto-application approval whereby users do not need API Administrator or Organization Administrator approval. |
delegateUserAdministration |
Boolean |
|
Enables/disables user administration to the Organization Administrators. |
delegateApplicationAdministration |
Boolean |
|
Enables/disables application administration to the Organization Administrators. |
apiDefaultVirtualHost |
String |
|
The network host and port that serves as the default virtual host from which API Manager registered API will be accessible through. |
emailFrom |
String |
|
The 'from' address used in emails. |
emailBounceAddress |
String |
|
An email address where undeliverable emails will be bounced to. |
promoteApiViaPolicy |
Boolean |
|
Enables/disables API promotion via policy. |
baseOAuth |
Boolean |
|
none |
externalUserName |
String |
|
External user name |
externalUserDescription |
String |
|
External user description |
externalUserPhone |
String |
|
External user phone |
externalUserEmail |
String |
|
External user email |
externalUserOrganization |
String |
|
External user organization name |
externalUserRole |
String |
|
External user role |
externalUserEnabled |
String |
|
External user enabled |
sessionIdleTimeout |
Long |
|
Idle session timeout in milliseconds |
isTrial |
Boolean |
|
Is trial enabled |
defaultTrialDuration |
Int |
|
Default trial duration in days |
loginNameRegex |
String |
|
Login name validation regex |
{
"portalName" : "Axway API Manager",
"portalHostname" : "apimanager.axway.com",
"apiPortalName" : "Axway API Portal",
"apiPortalHostname" : "apiportal.axway.com",
"isApiPortalConfigured" : true,
"registrationEnabled" : true,
"resetPasswordEnabled" : true,
"minimumPasswordLength" : 6,
"autoApproveUserRegistration" : true,
"systemOAuthScopesEnabled" : false,
"autoApproveApplications" : true,
"delegateUserAdministration" : true,
"delegateApplicationAdministration" : true,
"apiDefaultVirtualHost" : "apimanager.axway.com:443",
"emailFrom" : "no-reply@axway.com",
"emailBounceAddress" : "apiadmin@axway.com",
"promoteApiViaPolicy" : true,
"baseOAuth" : false,
"externalUserName" : "${userinfo.name}",
"externalUserDescription" : "${userinfo.description}",
"externalUserPhone" : "${userinfo.phone}",
"externalUserEmail" : "${userinfo.email}",
"externalUserOrganization" : "${userinfo.organization}",
"externalUserRole" : "${userinfo.role}",
"externalUserEnabled" : "${userinfo.enabled}",
"sessionIdleTimeout" : 360000,
"isTrial" : false,
"defaultTrialDuration" : 30,
"loginNameRegex" : "[^;,\\/?#<>&!]{1,}"
}