github.com/spinnaker/spin@v1.30.0/gateapi/docs/CredentialsControllerApi.md (about)

     1  # \CredentialsControllerApi
     2  
     3  All URIs are relative to *https://localhost*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**CreateAccountUsingPOST**](CredentialsControllerApi.md#CreateAccountUsingPOST) | **Post** /credentials | Creates a new account definition.
     8  [**DeleteAccountUsingDELETE**](CredentialsControllerApi.md#DeleteAccountUsingDELETE) | **Delete** /credentials/{accountName} | Deletes an account definition by name.
     9  [**GetAccountUsingGET**](CredentialsControllerApi.md#GetAccountUsingGET) | **Get** /credentials/{account} | Retrieve an account's details
    10  [**GetAccountsByTypeUsingGET**](CredentialsControllerApi.md#GetAccountsByTypeUsingGET) | **Get** /credentials/type/{accountType} | Looks up account definitions by type.
    11  [**GetAccountsUsingGET**](CredentialsControllerApi.md#GetAccountsUsingGET) | **Get** /credentials | Retrieve a list of accounts
    12  [**UpdateAccountUsingPUT**](CredentialsControllerApi.md#UpdateAccountUsingPUT) | **Put** /credentials | Updates an existing account definition.
    13  
    14  
    15  # **CreateAccountUsingPOST**
    16  > AccountDefinition CreateAccountUsingPOST(ctx, optional)
    17  Creates a new account definition.
    18  
    19  ### Required Parameters
    20  
    21  Name | Type | Description  | Notes
    22  ------------- | ------------- | ------------- | -------------
    23   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    24   **optional** | ***CredentialsControllerApiCreateAccountUsingPOSTOpts** | optional parameters | nil if no parameters
    25  
    26  ### Optional Parameters
    27  Optional parameters are passed through a pointer to a CredentialsControllerApiCreateAccountUsingPOSTOpts struct
    28  
    29  Name | Type | Description  | Notes
    30  ------------- | ------------- | ------------- | -------------
    31   **accountDefinition** | [**optional.Interface of AccountDefinition**](AccountDefinition.md)| Account definition body including a discriminator field named \"type\" with the account type. | 
    32  
    33  ### Return type
    34  
    35  [**AccountDefinition**](AccountDefinition.md)
    36  
    37  ### Authorization
    38  
    39  No authorization required
    40  
    41  ### HTTP request headers
    42  
    43   - **Content-Type**: application/json
    44   - **Accept**: */*
    45  
    46  [[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)
    47  
    48  # **DeleteAccountUsingDELETE**
    49  > DeleteAccountUsingDELETE(ctx, accountName)
    50  Deletes an account definition by name.
    51  
    52  ### Required Parameters
    53  
    54  Name | Type | Description  | Notes
    55  ------------- | ------------- | ------------- | -------------
    56   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    57    **accountName** | **string**| Name of account definition to delete. | 
    58  
    59  ### Return type
    60  
    61   (empty response body)
    62  
    63  ### Authorization
    64  
    65  No authorization required
    66  
    67  ### HTTP request headers
    68  
    69   - **Content-Type**: Not defined
    70   - **Accept**: */*
    71  
    72  [[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)
    73  
    74  # **GetAccountUsingGET**
    75  > AccountDetails GetAccountUsingGET(ctx, account, optional)
    76  Retrieve an account's details
    77  
    78  ### Required Parameters
    79  
    80  Name | Type | Description  | Notes
    81  ------------- | ------------- | ------------- | -------------
    82   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    83    **account** | **string**| account | 
    84   **optional** | ***CredentialsControllerApiGetAccountUsingGETOpts** | optional parameters | nil if no parameters
    85  
    86  ### Optional Parameters
    87  Optional parameters are passed through a pointer to a CredentialsControllerApiGetAccountUsingGETOpts struct
    88  
    89  Name | Type | Description  | Notes
    90  ------------- | ------------- | ------------- | -------------
    91  
    92   **xRateLimitApp** | **optional.String**| X-RateLimit-App | 
    93   **accountNonExpired** | **optional.Bool**|  | 
    94   **accountNonLocked** | **optional.Bool**|  | 
    95   **allowedAccounts** | [**optional.Interface of []string**](string.md)|  | 
    96   **authorities0Authority** | **optional.String**|  | 
    97   **credentialsNonExpired** | **optional.Bool**|  | 
    98   **email** | **optional.String**|  | 
    99   **enabled** | **optional.Bool**|  | 
   100   **firstName** | **optional.String**|  | 
   101   **lastName** | **optional.String**|  | 
   102   **password** | **optional.String**|  | 
   103   **roles** | [**optional.Interface of []string**](string.md)|  | 
   104   **username** | **optional.String**|  | 
   105  
   106  ### Return type
   107  
   108  [**AccountDetails**](AccountDetails.md)
   109  
   110  ### Authorization
   111  
   112  No authorization required
   113  
   114  ### HTTP request headers
   115  
   116   - **Content-Type**: Not defined
   117   - **Accept**: */*
   118  
   119  [[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)
   120  
   121  # **GetAccountsByTypeUsingGET**
   122  > []AccountDefinition GetAccountsByTypeUsingGET(ctx, accountType, optional)
   123  Looks up account definitions by type.
   124  
   125  ### Required Parameters
   126  
   127  Name | Type | Description  | Notes
   128  ------------- | ------------- | ------------- | -------------
   129   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   130    **accountType** | **string**| Value of the \"@type\" key for accounts to search for. | 
   131   **optional** | ***CredentialsControllerApiGetAccountsByTypeUsingGETOpts** | optional parameters | nil if no parameters
   132  
   133  ### Optional Parameters
   134  Optional parameters are passed through a pointer to a CredentialsControllerApiGetAccountsByTypeUsingGETOpts struct
   135  
   136  Name | Type | Description  | Notes
   137  ------------- | ------------- | ------------- | -------------
   138  
   139   **limit** | **optional.String**| Maximum number of entries to return in results. Used for pagination. | 
   140   **startingAccountName** | **optional.String**| Account name to start account definition listing from. Used for pagination. | 
   141  
   142  ### Return type
   143  
   144  [**[]AccountDefinition**](AccountDefinition.md)
   145  
   146  ### Authorization
   147  
   148  No authorization required
   149  
   150  ### HTTP request headers
   151  
   152   - **Content-Type**: Not defined
   153   - **Accept**: */*
   154  
   155  [[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)
   156  
   157  # **GetAccountsUsingGET**
   158  > []Account GetAccountsUsingGET(ctx, optional)
   159  Retrieve a list of accounts
   160  
   161  ### Required Parameters
   162  
   163  Name | Type | Description  | Notes
   164  ------------- | ------------- | ------------- | -------------
   165   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   166   **optional** | ***CredentialsControllerApiGetAccountsUsingGETOpts** | optional parameters | nil if no parameters
   167  
   168  ### Optional Parameters
   169  Optional parameters are passed through a pointer to a CredentialsControllerApiGetAccountsUsingGETOpts struct
   170  
   171  Name | Type | Description  | Notes
   172  ------------- | ------------- | ------------- | -------------
   173   **accountNonExpired** | **optional.Bool**|  | 
   174   **accountNonLocked** | **optional.Bool**|  | 
   175   **allowedAccounts** | [**optional.Interface of []string**](string.md)|  | 
   176   **authorities0Authority** | **optional.String**|  | 
   177   **credentialsNonExpired** | **optional.Bool**|  | 
   178   **email** | **optional.String**|  | 
   179   **enabled** | **optional.Bool**|  | 
   180   **expand** | **optional.Bool**| expand | 
   181   **firstName** | **optional.String**|  | 
   182   **lastName** | **optional.String**|  | 
   183   **password** | **optional.String**|  | 
   184   **roles** | [**optional.Interface of []string**](string.md)|  | 
   185   **username** | **optional.String**|  | 
   186  
   187  ### Return type
   188  
   189  [**[]Account**](Account.md)
   190  
   191  ### Authorization
   192  
   193  No authorization required
   194  
   195  ### HTTP request headers
   196  
   197   - **Content-Type**: Not defined
   198   - **Accept**: */*
   199  
   200  [[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)
   201  
   202  # **UpdateAccountUsingPUT**
   203  > AccountDefinition UpdateAccountUsingPUT(ctx, optional)
   204  Updates an existing account definition.
   205  
   206  ### Required Parameters
   207  
   208  Name | Type | Description  | Notes
   209  ------------- | ------------- | ------------- | -------------
   210   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
   211   **optional** | ***CredentialsControllerApiUpdateAccountUsingPUTOpts** | optional parameters | nil if no parameters
   212  
   213  ### Optional Parameters
   214  Optional parameters are passed through a pointer to a CredentialsControllerApiUpdateAccountUsingPUTOpts struct
   215  
   216  Name | Type | Description  | Notes
   217  ------------- | ------------- | ------------- | -------------
   218   **accountDefinition** | [**optional.Interface of AccountDefinition**](AccountDefinition.md)| Account definition body including a discriminator field named \"type\" with the account type. | 
   219  
   220  ### Return type
   221  
   222  [**AccountDefinition**](AccountDefinition.md)
   223  
   224  ### Authorization
   225  
   226  No authorization required
   227  
   228  ### HTTP request headers
   229  
   230   - **Content-Type**: application/json
   231   - **Accept**: */*
   232  
   233  [[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)
   234