github.com/treeverse/lakefs@v1.24.1-0.20240520134607-95648127bfb0/clients/rust/docs/ExternalApi.md (about)

     1  # \ExternalApi
     2  
     3  All URIs are relative to */api/v1*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**create_user_external_principal**](ExternalApi.md#create_user_external_principal) | **POST** /auth/users/{userId}/external/principals | attach external principal to user
     8  [**delete_user_external_principal**](ExternalApi.md#delete_user_external_principal) | **DELETE** /auth/users/{userId}/external/principals | delete external principal from user
     9  [**external_principal_login**](ExternalApi.md#external_principal_login) | **POST** /auth/external/principal/login | perform a login using an external authenticator
    10  [**get_external_principal**](ExternalApi.md#get_external_principal) | **GET** /auth/external/principals | describe external principal by id
    11  [**list_user_external_principals**](ExternalApi.md#list_user_external_principals) | **GET** /auth/users/{userId}/external/principals/ls | list user external policies attached to a user
    12  
    13  
    14  
    15  ## create_user_external_principal
    16  
    17  > create_user_external_principal(user_id, principal_id, external_principal_creation)
    18  attach external principal to user
    19  
    20  ### Parameters
    21  
    22  
    23  Name | Type | Description  | Required | Notes
    24  ------------- | ------------- | ------------- | ------------- | -------------
    25  **user_id** | **String** |  | [required] |
    26  **principal_id** | **String** |  | [required] |
    27  **external_principal_creation** | Option<[**ExternalPrincipalCreation**](ExternalPrincipalCreation.md)> |  |  |
    28  
    29  ### Return type
    30  
    31   (empty response body)
    32  
    33  ### Authorization
    34  
    35  [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token)
    36  
    37  ### HTTP request headers
    38  
    39  - **Content-Type**: application/json
    40  - **Accept**: application/json
    41  
    42  [[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)
    43  
    44  
    45  ## delete_user_external_principal
    46  
    47  > delete_user_external_principal(user_id, principal_id)
    48  delete external principal from user
    49  
    50  ### Parameters
    51  
    52  
    53  Name | Type | Description  | Required | Notes
    54  ------------- | ------------- | ------------- | ------------- | -------------
    55  **user_id** | **String** |  | [required] |
    56  **principal_id** | **String** |  | [required] |
    57  
    58  ### Return type
    59  
    60   (empty response body)
    61  
    62  ### Authorization
    63  
    64  [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token)
    65  
    66  ### HTTP request headers
    67  
    68  - **Content-Type**: Not defined
    69  - **Accept**: application/json
    70  
    71  [[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)
    72  
    73  
    74  ## external_principal_login
    75  
    76  > models::AuthenticationToken external_principal_login(external_login_information)
    77  perform a login using an external authenticator
    78  
    79  ### Parameters
    80  
    81  
    82  Name | Type | Description  | Required | Notes
    83  ------------- | ------------- | ------------- | ------------- | -------------
    84  **external_login_information** | Option<[**ExternalLoginInformation**](ExternalLoginInformation.md)> |  |  |
    85  
    86  ### Return type
    87  
    88  [**models::AuthenticationToken**](AuthenticationToken.md)
    89  
    90  ### Authorization
    91  
    92  No authorization required
    93  
    94  ### HTTP request headers
    95  
    96  - **Content-Type**: application/json
    97  - **Accept**: application/json
    98  
    99  [[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)
   100  
   101  
   102  ## get_external_principal
   103  
   104  > models::ExternalPrincipal get_external_principal(principal_id)
   105  describe external principal by id
   106  
   107  ### Parameters
   108  
   109  
   110  Name | Type | Description  | Required | Notes
   111  ------------- | ------------- | ------------- | ------------- | -------------
   112  **principal_id** | **String** |  | [required] |
   113  
   114  ### Return type
   115  
   116  [**models::ExternalPrincipal**](ExternalPrincipal.md)
   117  
   118  ### Authorization
   119  
   120  [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token)
   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  
   130  ## list_user_external_principals
   131  
   132  > models::ExternalPrincipalList list_user_external_principals(user_id, prefix, after, amount)
   133  list user external policies attached to a user
   134  
   135  ### Parameters
   136  
   137  
   138  Name | Type | Description  | Required | Notes
   139  ------------- | ------------- | ------------- | ------------- | -------------
   140  **user_id** | **String** |  | [required] |
   141  **prefix** | Option<**String**> | return items prefixed with this value |  |
   142  **after** | Option<**String**> | return items after this value |  |
   143  **amount** | Option<**i32**> | how many items to return |  |[default to 100]
   144  
   145  ### Return type
   146  
   147  [**models::ExternalPrincipalList**](ExternalPrincipalList.md)
   148  
   149  ### Authorization
   150  
   151  [basic_auth](../README.md#basic_auth), [cookie_auth](../README.md#cookie_auth), [oidc_auth](../README.md#oidc_auth), [saml_auth](../README.md#saml_auth), [jwt_token](../README.md#jwt_token)
   152  
   153  ### HTTP request headers
   154  
   155  - **Content-Type**: Not defined
   156  - **Accept**: application/json
   157  
   158  [[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)
   159