github.com/safedep/dry@v0.0.0-20241016050132-a15651f0548b/apiguard/tykgen/docs/ApiDefinition.md (about)

     1  # ApiDefinition
     2  
     3  ## Properties
     4  Name | Type | Description | Notes
     5  ------------ | ------------- | ------------- | -------------
     6  **Tags** | **[]string** |  | [optional] [default to null]
     7  **CORS** | [***ApiDefinitionCors**](APIDefinition_CORS.md) |  | [optional] [default to null]
     8  **Active** | **bool** |  | [optional] [default to null]
     9  **AllowedIps** | **[]string** |  | [optional] [default to null]
    10  **ApiId** | **string** |  | [optional] [default to null]
    11  **Auth** | [***Auth**](Auth.md) |  | [optional] [default to null]
    12  **AuthProvider** | [***AuthProviderMeta**](AuthProviderMeta.md) |  | [optional] [default to null]
    13  **BaseIdentityProvidedBy** | **string** |  | [optional] [default to null]
    14  **BasicAuth** | [***ApiDefinitionBasicAuth**](APIDefinition_basic_auth.md) |  | [optional] [default to null]
    15  **BlacklistedIps** | **[]string** |  | [optional] [default to null]
    16  **CacheOptions** | [***CacheOptions**](CacheOptions.md) |  | [optional] [default to null]
    17  **Certificates** | **[]string** |  | [optional] [default to null]
    18  **ClientCertificates** | **[]string** |  | [optional] [default to null]
    19  **ConfigData** | [**map[string]interface{}**](interface{}.md) |  | [optional] [default to null]
    20  **CustomMiddleware** | [***MiddlewareSection**](MiddlewareSection.md) |  | [optional] [default to null]
    21  **CustomMiddlewareBundle** | **string** |  | [optional] [default to null]
    22  **Definition** | [***ApiDefinitionDefinition**](APIDefinition_definition.md) |  | [optional] [default to null]
    23  **DisableQuota** | **bool** |  | [optional] [default to null]
    24  **DisableRateLimit** | **bool** |  | [optional] [default to null]
    25  **DoNotTrack** | **bool** |  | [optional] [default to null]
    26  **Domain** | **string** |  | [optional] [default to null]
    27  **DontSetQuotaOnCreate** | **bool** |  | [optional] [default to null]
    28  **EnableBatchRequestSupport** | **bool** |  | [optional] [default to null]
    29  **EnableContextVars** | **bool** |  | [optional] [default to null]
    30  **EnableCoprocessAuth** | **bool** |  | [optional] [default to null]
    31  **EnableIpBlacklisting** | **bool** |  | [optional] [default to null]
    32  **EnableIpWhitelisting** | **bool** |  | [optional] [default to null]
    33  **EnableJwt** | **bool** |  | [optional] [default to null]
    34  **EnableSignatureChecking** | **bool** |  | [optional] [default to null]
    35  **EventHandlers** | [***EventHandlerMetaConfig**](EventHandlerMetaConfig.md) |  | [optional] [default to null]
    36  **ExpireAnalyticsAfter** | **int64** |  | [optional] [default to null]
    37  **GlobalRateLimit** | [***GlobalRateLimit**](GlobalRateLimit.md) |  | [optional] [default to null]
    38  **HmacAllowedAlgorithms** | **[]string** |  | [optional] [default to null]
    39  **HmacAllowedClockSkew** | **float64** |  | [optional] [default to null]
    40  **Id** | **string** |  | [optional] [default to null]
    41  **Internal** | **bool** |  | [optional] [default to null]
    42  **JwtClientBaseField** | **string** |  | [optional] [default to null]
    43  **JwtExpiresAtValidationSkew** | **int32** |  | [optional] [default to null]
    44  **JwtIdentityBaseField** | **string** |  | [optional] [default to null]
    45  **JwtIssuedAtValidationSkew** | **int32** |  | [optional] [default to null]
    46  **JwtNotBeforeValidationSkew** | **int32** |  | [optional] [default to null]
    47  **JwtPolicyFieldName** | **string** |  | [optional] [default to null]
    48  **JwtScopeClaimName** | **string** |  | [optional] [default to null]
    49  **JwtScopeToPolicyMapping** | **map[string]string** |  | [optional] [default to null]
    50  **JwtSigningMethod** | **string** |  | [optional] [default to null]
    51  **JwtSkipKid** | **bool** |  | [optional] [default to null]
    52  **JwtSource** | **string** |  | [optional] [default to null]
    53  **Name** | **string** |  | [optional] [default to null]
    54  **Notifications** | [***NotificationsManager**](NotificationsManager.md) |  | [optional] [default to null]
    55  **OauthMeta** | [***ApiDefinitionOauthMeta**](APIDefinition_oauth_meta.md) |  | [optional] [default to null]
    56  **OpenidOptions** | [***OpenIdOptions**](OpenIDOptions.md) |  | [optional] [default to null]
    57  **OrgId** | **string** |  | [optional] [default to null]
    58  **PinnedPublicKeys** | **map[string]string** |  | [optional] [default to null]
    59  **Proxy** | [***ApiDefinitionProxy**](APIDefinition_proxy.md) |  | [optional] [default to null]
    60  **ResponseProcessors** | [**[]ResponseProcessor**](ResponseProcessor.md) |  | [optional] [default to null]
    61  **SessionLifetime** | **int64** |  | [optional] [default to null]
    62  **SessionProvider** | [***SessionProviderMeta**](SessionProviderMeta.md) |  | [optional] [default to null]
    63  **Slug** | **string** |  | [optional] [default to null]
    64  **StripAuthData** | **bool** |  | [optional] [default to null]
    65  **TagHeaders** | **[]string** |  | [optional] [default to null]
    66  **UpstreamCertificates** | **map[string]string** |  | [optional] [default to null]
    67  **UptimeTests** | [***ApiDefinitionUptimeTests**](APIDefinition_uptime_tests.md) |  | [optional] [default to null]
    68  **UseBasicAuth** | **bool** |  | [optional] [default to null]
    69  **UseKeyless** | **bool** |  | [optional] [default to null]
    70  **UseMutualTlsAuth** | **bool** |  | [optional] [default to null]
    71  **UseOauth2** | **bool** |  | [optional] [default to null]
    72  **UseOpenid** | **bool** |  | [optional] [default to null]
    73  **UseStandardAuth** | **bool** |  | [optional] [default to null]
    74  **VersionData** | [***ApiDefinitionVersionData**](APIDefinition_version_data.md) |  | [optional] [default to null]
    75  
    76  [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
    77