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

     1  # \AuthControllerApi
     2  
     3  All URIs are relative to *https://localhost*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**GetServiceAccountsUsingGET**](AuthControllerApi.md#GetServiceAccountsUsingGET) | **Get** /auth/user/serviceAccounts | Get service accounts
     8  [**LoggedOutUsingGET**](AuthControllerApi.md#LoggedOutUsingGET) | **Get** /auth/loggedOut | Get logged out message
     9  [**RedirectUsingGET**](AuthControllerApi.md#RedirectUsingGET) | **Get** /auth/redirect | Redirect to Deck
    10  [**SyncUsingPOST**](AuthControllerApi.md#SyncUsingPOST) | **Post** /auth/roles/sync | Sync user roles
    11  [**UserUsingGET**](AuthControllerApi.md#UserUsingGET) | **Get** /auth/user | Get user
    12  
    13  
    14  # **GetServiceAccountsUsingGET**
    15  > []interface{} GetServiceAccountsUsingGET(ctx, optional)
    16  Get service accounts
    17  
    18  ### Required Parameters
    19  
    20  Name | Type | Description  | Notes
    21  ------------- | ------------- | ------------- | -------------
    22   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    23   **optional** | ***AuthControllerApiGetServiceAccountsUsingGETOpts** | optional parameters | nil if no parameters
    24  
    25  ### Optional Parameters
    26  Optional parameters are passed through a pointer to a AuthControllerApiGetServiceAccountsUsingGETOpts struct
    27  
    28  Name | Type | Description  | Notes
    29  ------------- | ------------- | ------------- | -------------
    30   **application** | **optional.String**| application | 
    31  
    32  ### Return type
    33  
    34  [**[]interface{}**](interface{}.md)
    35  
    36  ### Authorization
    37  
    38  No authorization required
    39  
    40  ### HTTP request headers
    41  
    42   - **Content-Type**: Not defined
    43   - **Accept**: */*
    44  
    45  [[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)
    46  
    47  # **LoggedOutUsingGET**
    48  > string LoggedOutUsingGET(ctx, )
    49  Get logged out message
    50  
    51  ### Required Parameters
    52  This endpoint does not need any parameter.
    53  
    54  ### Return type
    55  
    56  **string**
    57  
    58  ### Authorization
    59  
    60  No authorization required
    61  
    62  ### HTTP request headers
    63  
    64   - **Content-Type**: Not defined
    65   - **Accept**: */*
    66  
    67  [[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)
    68  
    69  # **RedirectUsingGET**
    70  > RedirectUsingGET(ctx, to)
    71  Redirect to Deck
    72  
    73  ### Required Parameters
    74  
    75  Name | Type | Description  | Notes
    76  ------------- | ------------- | ------------- | -------------
    77   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    78    **to** | **string**| to | 
    79  
    80  ### Return type
    81  
    82   (empty response body)
    83  
    84  ### Authorization
    85  
    86  No authorization required
    87  
    88  ### HTTP request headers
    89  
    90   - **Content-Type**: Not defined
    91   - **Accept**: */*
    92  
    93  [[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)
    94  
    95  # **SyncUsingPOST**
    96  > SyncUsingPOST(ctx, )
    97  Sync user roles
    98  
    99  ### Required Parameters
   100  This endpoint does not need any parameter.
   101  
   102  ### Return type
   103  
   104   (empty response body)
   105  
   106  ### Authorization
   107  
   108  No authorization required
   109  
   110  ### HTTP request headers
   111  
   112   - **Content-Type**: application/json
   113   - **Accept**: */*
   114  
   115  [[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)
   116  
   117  # **UserUsingGET**
   118  > User UserUsingGET(ctx, )
   119  Get user
   120  
   121  ### Required Parameters
   122  This endpoint does not need any parameter.
   123  
   124  ### Return type
   125  
   126  [**User**](User.md)
   127  
   128  ### Authorization
   129  
   130  No authorization required
   131  
   132  ### HTTP request headers
   133  
   134   - **Content-Type**: Not defined
   135   - **Accept**: */*
   136  
   137  [[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)
   138