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

     1  # {{classname}}
     2  
     3  All URIs are relative to *http://localhost/*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**AddOrgKey**](OrganisationQuotasApi.md#AddOrgKey) | **Post** /tyk/org/keys/{keyID} | Create an organisation key
     8  [**DeleteOrgKey**](OrganisationQuotasApi.md#DeleteOrgKey) | **Delete** /tyk/org/keys/{keyID} | Delete Organisation Key
     9  [**GetOrgKey**](OrganisationQuotasApi.md#GetOrgKey) | **Get** /tyk/org/keys/{keyID} | Get an Organisation Key
    10  [**ListOrgKeys**](OrganisationQuotasApi.md#ListOrgKeys) | **Get** /tyk/org/keys | List Organisation Keys
    11  [**UpdateOrgKey**](OrganisationQuotasApi.md#UpdateOrgKey) | **Put** /tyk/org/keys/{keyID} | Update Organisation Key
    12  
    13  # **AddOrgKey**
    14  > ApiModifyKeySuccess AddOrgKey(ctx, keyID, optional)
    15  Create an organisation key
    16  
    17  This work similar to Keys API except that Key ID is always equals Organisation ID
    18  
    19  ### Required Parameters
    20  
    21  Name | Type | Description  | Notes
    22  ------------- | ------------- | ------------- | -------------
    23   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    24    **keyID** | **string**| The Key ID | 
    25   **optional** | ***OrganisationQuotasApiAddOrgKeyOpts** | optional parameters | nil if no parameters
    26  
    27  ### Optional Parameters
    28  Optional parameters are passed through a pointer to a OrganisationQuotasApiAddOrgKeyOpts struct
    29  Name | Type | Description  | Notes
    30  ------------- | ------------- | ------------- | -------------
    31  
    32   **body** | [**optional.Interface of SessionState**](SessionState.md)|  | 
    33  
    34  ### Return type
    35  
    36  [**ApiModifyKeySuccess**](apiModifyKeySuccess.md)
    37  
    38  ### Authorization
    39  
    40  [api_key](../README.md#api_key)
    41  
    42  ### HTTP request headers
    43  
    44   - **Content-Type**: application/json
    45   - **Accept**: application/json
    46  
    47  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    48  
    49  # **DeleteOrgKey**
    50  > ApiStatusMessage DeleteOrgKey(ctx, keyID)
    51  Delete Organisation Key
    52  
    53  Deleting a key will remove all limits from organisation. It does not affects regualar keys created within organisation.
    54  
    55  ### Required Parameters
    56  
    57  Name | Type | Description  | Notes
    58  ------------- | ------------- | ------------- | -------------
    59   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    60    **keyID** | **string**| The Key ID | 
    61  
    62  ### Return type
    63  
    64  [**ApiStatusMessage**](apiStatusMessage.md)
    65  
    66  ### Authorization
    67  
    68  [api_key](../README.md#api_key)
    69  
    70  ### HTTP request headers
    71  
    72   - **Content-Type**: Not defined
    73   - **Accept**: application/json
    74  
    75  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    76  
    77  # **GetOrgKey**
    78  > SessionState GetOrgKey(ctx, keyID)
    79  Get an Organisation Key
    80  
    81  Get session info about specified orgnanisation key. Should return up to date rate limit and quota usage numbers.
    82  
    83  ### Required Parameters
    84  
    85  Name | Type | Description  | Notes
    86  ------------- | ------------- | ------------- | -------------
    87   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    88    **keyID** | **string**| The Key ID | 
    89  
    90  ### Return type
    91  
    92  [**SessionState**](SessionState.md)
    93  
    94  ### Authorization
    95  
    96  [api_key](../README.md#api_key)
    97  
    98  ### HTTP request headers
    99  
   100   - **Content-Type**: Not defined
   101   - **Accept**: application/json
   102  
   103  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   104  
   105  # **ListOrgKeys**
   106  > InlineResponse2002 ListOrgKeys(ctx, )
   107  List Organisation Keys
   108  
   109  You can now set rate limits at the organisation level by using the following fields - allowance and rate. These are the number of allowed requests for the specified per value, and need to be set to the same value. If you don't want to have organisation level rate limiting, set 'rate' or 'per' to zero, or don't add them to your request.
   110  
   111  ### Required Parameters
   112  This endpoint does not need any parameter.
   113  
   114  ### Return type
   115  
   116  [**InlineResponse2002**](inline_response_200_2.md)
   117  
   118  ### Authorization
   119  
   120  [api_key](../README.md#api_key)
   121  
   122  ### HTTP request headers
   123  
   124   - **Content-Type**: Not defined
   125   - **Accept**: application/json
   126  
   127  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   128  
   129  # **UpdateOrgKey**
   130  > ApiModifyKeySuccess UpdateOrgKey(ctx, keyID, optional)
   131  Update Organisation Key
   132  
   133  This work similar to Keys API except that Key ID is always equals Organisation ID  For Gateway v2.6.0 onwards, you can now set rate limits at the organisation level by using the following fields - allowance and rate. These are the number of allowed requests for the specified per value, and need to be set to the same value. If you don't want to have organisation level rate limiting, set `rate` or `per` to zero, or don't add them to your request.
   134  
   135  ### Required Parameters
   136  
   137  Name | Type | Description  | Notes
   138  ------------- | ------------- | ------------- | -------------
   139   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   140    **keyID** | **string**| The Key ID | 
   141   **optional** | ***OrganisationQuotasApiUpdateOrgKeyOpts** | optional parameters | nil if no parameters
   142  
   143  ### Optional Parameters
   144  Optional parameters are passed through a pointer to a OrganisationQuotasApiUpdateOrgKeyOpts struct
   145  Name | Type | Description  | Notes
   146  ------------- | ------------- | ------------- | -------------
   147  
   148   **body** | [**optional.Interface of SessionState**](SessionState.md)|  | 
   149   **resetQuota** | **optional.**| Adding the `reset_quota` parameter and setting it to 1, will cause Tyk reset the organisations quota in the live quota manager, it is recommended to use this mechanism to reset organisation-level access if a monthly subscription is in place. | 
   150  
   151  ### Return type
   152  
   153  [**ApiModifyKeySuccess**](apiModifyKeySuccess.md)
   154  
   155  ### Authorization
   156  
   157  [api_key](../README.md#api_key)
   158  
   159  ### HTTP request headers
   160  
   161   - **Content-Type**: application/json
   162   - **Accept**: application/json
   163  
   164  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
   165