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

     1  # \AuthApi
     2  
     3  All URIs are relative to */api/v1*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**add_group_membership**](AuthApi.md#add_group_membership) | **PUT** /auth/groups/{groupId}/members/{userId} | add group membership
     8  [**attach_policy_to_group**](AuthApi.md#attach_policy_to_group) | **PUT** /auth/groups/{groupId}/policies/{policyId} | attach policy to group
     9  [**attach_policy_to_user**](AuthApi.md#attach_policy_to_user) | **PUT** /auth/users/{userId}/policies/{policyId} | attach policy to user
    10  [**create_credentials**](AuthApi.md#create_credentials) | **POST** /auth/users/{userId}/credentials | create credentials
    11  [**create_group**](AuthApi.md#create_group) | **POST** /auth/groups | create group
    12  [**create_policy**](AuthApi.md#create_policy) | **POST** /auth/policies | create policy
    13  [**create_user**](AuthApi.md#create_user) | **POST** /auth/users | create user
    14  [**create_user_external_principal**](AuthApi.md#create_user_external_principal) | **POST** /auth/users/{userId}/external/principals | attach external principal to user
    15  [**delete_credentials**](AuthApi.md#delete_credentials) | **DELETE** /auth/users/{userId}/credentials/{accessKeyId} | delete credentials
    16  [**delete_group**](AuthApi.md#delete_group) | **DELETE** /auth/groups/{groupId} | delete group
    17  [**delete_group_membership**](AuthApi.md#delete_group_membership) | **DELETE** /auth/groups/{groupId}/members/{userId} | delete group membership
    18  [**delete_policy**](AuthApi.md#delete_policy) | **DELETE** /auth/policies/{policyId} | delete policy
    19  [**delete_user**](AuthApi.md#delete_user) | **DELETE** /auth/users/{userId} | delete user
    20  [**delete_user_external_principal**](AuthApi.md#delete_user_external_principal) | **DELETE** /auth/users/{userId}/external/principals | delete external principal from user
    21  [**detach_policy_from_group**](AuthApi.md#detach_policy_from_group) | **DELETE** /auth/groups/{groupId}/policies/{policyId} | detach policy from group
    22  [**detach_policy_from_user**](AuthApi.md#detach_policy_from_user) | **DELETE** /auth/users/{userId}/policies/{policyId} | detach policy from user
    23  [**external_principal_login**](AuthApi.md#external_principal_login) | **POST** /auth/external/principal/login | perform a login using an external authenticator
    24  [**get_credentials**](AuthApi.md#get_credentials) | **GET** /auth/users/{userId}/credentials/{accessKeyId} | get credentials
    25  [**get_current_user**](AuthApi.md#get_current_user) | **GET** /user | get current user
    26  [**get_external_principal**](AuthApi.md#get_external_principal) | **GET** /auth/external/principals | describe external principal by id
    27  [**get_group**](AuthApi.md#get_group) | **GET** /auth/groups/{groupId} | get group
    28  [**get_group_acl**](AuthApi.md#get_group_acl) | **GET** /auth/groups/{groupId}/acl | get ACL of group
    29  [**get_policy**](AuthApi.md#get_policy) | **GET** /auth/policies/{policyId} | get policy
    30  [**get_user**](AuthApi.md#get_user) | **GET** /auth/users/{userId} | get user
    31  [**list_group_members**](AuthApi.md#list_group_members) | **GET** /auth/groups/{groupId}/members | list group members
    32  [**list_group_policies**](AuthApi.md#list_group_policies) | **GET** /auth/groups/{groupId}/policies | list group policies
    33  [**list_groups**](AuthApi.md#list_groups) | **GET** /auth/groups | list groups
    34  [**list_policies**](AuthApi.md#list_policies) | **GET** /auth/policies | list policies
    35  [**list_user_credentials**](AuthApi.md#list_user_credentials) | **GET** /auth/users/{userId}/credentials | list user credentials
    36  [**list_user_external_principals**](AuthApi.md#list_user_external_principals) | **GET** /auth/users/{userId}/external/principals/ls | list user external policies attached to a user
    37  [**list_user_groups**](AuthApi.md#list_user_groups) | **GET** /auth/users/{userId}/groups | list user groups
    38  [**list_user_policies**](AuthApi.md#list_user_policies) | **GET** /auth/users/{userId}/policies | list user policies
    39  [**list_users**](AuthApi.md#list_users) | **GET** /auth/users | list users
    40  [**login**](AuthApi.md#login) | **POST** /auth/login | perform a login
    41  [**set_group_acl**](AuthApi.md#set_group_acl) | **POST** /auth/groups/{groupId}/acl | set ACL of group
    42  [**update_policy**](AuthApi.md#update_policy) | **PUT** /auth/policies/{policyId} | update policy
    43  
    44  
    45  
    46  ## add_group_membership
    47  
    48  > add_group_membership(group_id, user_id)
    49  add group membership
    50  
    51  ### Parameters
    52  
    53  
    54  Name | Type | Description  | Required | Notes
    55  ------------- | ------------- | ------------- | ------------- | -------------
    56  **group_id** | **String** |  | [required] |
    57  **user_id** | **String** |  | [required] |
    58  
    59  ### Return type
    60  
    61   (empty response body)
    62  
    63  ### Authorization
    64  
    65  [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)
    66  
    67  ### HTTP request headers
    68  
    69  - **Content-Type**: Not defined
    70  - **Accept**: application/json
    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  
    75  ## attach_policy_to_group
    76  
    77  > attach_policy_to_group(group_id, policy_id)
    78  attach policy to group
    79  
    80  ### Parameters
    81  
    82  
    83  Name | Type | Description  | Required | Notes
    84  ------------- | ------------- | ------------- | ------------- | -------------
    85  **group_id** | **String** |  | [required] |
    86  **policy_id** | **String** |  | [required] |
    87  
    88  ### Return type
    89  
    90   (empty response body)
    91  
    92  ### Authorization
    93  
    94  [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)
    95  
    96  ### HTTP request headers
    97  
    98  - **Content-Type**: Not defined
    99  - **Accept**: application/json
   100  
   101  [[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)
   102  
   103  
   104  ## attach_policy_to_user
   105  
   106  > attach_policy_to_user(user_id, policy_id)
   107  attach policy to user
   108  
   109  ### Parameters
   110  
   111  
   112  Name | Type | Description  | Required | Notes
   113  ------------- | ------------- | ------------- | ------------- | -------------
   114  **user_id** | **String** |  | [required] |
   115  **policy_id** | **String** |  | [required] |
   116  
   117  ### Return type
   118  
   119   (empty response body)
   120  
   121  ### Authorization
   122  
   123  [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)
   124  
   125  ### HTTP request headers
   126  
   127  - **Content-Type**: Not defined
   128  - **Accept**: application/json
   129  
   130  [[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)
   131  
   132  
   133  ## create_credentials
   134  
   135  > models::CredentialsWithSecret create_credentials(user_id)
   136  create credentials
   137  
   138  ### Parameters
   139  
   140  
   141  Name | Type | Description  | Required | Notes
   142  ------------- | ------------- | ------------- | ------------- | -------------
   143  **user_id** | **String** |  | [required] |
   144  
   145  ### Return type
   146  
   147  [**models::CredentialsWithSecret**](CredentialsWithSecret.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  
   160  
   161  ## create_group
   162  
   163  > models::Group create_group(group_creation)
   164  create group
   165  
   166  ### Parameters
   167  
   168  
   169  Name | Type | Description  | Required | Notes
   170  ------------- | ------------- | ------------- | ------------- | -------------
   171  **group_creation** | Option<[**GroupCreation**](GroupCreation.md)> |  |  |
   172  
   173  ### Return type
   174  
   175  [**models::Group**](Group.md)
   176  
   177  ### Authorization
   178  
   179  [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)
   180  
   181  ### HTTP request headers
   182  
   183  - **Content-Type**: application/json
   184  - **Accept**: application/json
   185  
   186  [[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)
   187  
   188  
   189  ## create_policy
   190  
   191  > models::Policy create_policy(policy)
   192  create policy
   193  
   194  ### Parameters
   195  
   196  
   197  Name | Type | Description  | Required | Notes
   198  ------------- | ------------- | ------------- | ------------- | -------------
   199  **policy** | [**Policy**](Policy.md) |  | [required] |
   200  
   201  ### Return type
   202  
   203  [**models::Policy**](Policy.md)
   204  
   205  ### Authorization
   206  
   207  [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)
   208  
   209  ### HTTP request headers
   210  
   211  - **Content-Type**: application/json
   212  - **Accept**: application/json
   213  
   214  [[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)
   215  
   216  
   217  ## create_user
   218  
   219  > models::User create_user(user_creation)
   220  create user
   221  
   222  ### Parameters
   223  
   224  
   225  Name | Type | Description  | Required | Notes
   226  ------------- | ------------- | ------------- | ------------- | -------------
   227  **user_creation** | Option<[**UserCreation**](UserCreation.md)> |  |  |
   228  
   229  ### Return type
   230  
   231  [**models::User**](User.md)
   232  
   233  ### Authorization
   234  
   235  [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)
   236  
   237  ### HTTP request headers
   238  
   239  - **Content-Type**: application/json
   240  - **Accept**: application/json
   241  
   242  [[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)
   243  
   244  
   245  ## create_user_external_principal
   246  
   247  > create_user_external_principal(user_id, principal_id, external_principal_creation)
   248  attach external principal to user
   249  
   250  ### Parameters
   251  
   252  
   253  Name | Type | Description  | Required | Notes
   254  ------------- | ------------- | ------------- | ------------- | -------------
   255  **user_id** | **String** |  | [required] |
   256  **principal_id** | **String** |  | [required] |
   257  **external_principal_creation** | Option<[**ExternalPrincipalCreation**](ExternalPrincipalCreation.md)> |  |  |
   258  
   259  ### Return type
   260  
   261   (empty response body)
   262  
   263  ### Authorization
   264  
   265  [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)
   266  
   267  ### HTTP request headers
   268  
   269  - **Content-Type**: application/json
   270  - **Accept**: application/json
   271  
   272  [[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)
   273  
   274  
   275  ## delete_credentials
   276  
   277  > delete_credentials(user_id, access_key_id)
   278  delete credentials
   279  
   280  ### Parameters
   281  
   282  
   283  Name | Type | Description  | Required | Notes
   284  ------------- | ------------- | ------------- | ------------- | -------------
   285  **user_id** | **String** |  | [required] |
   286  **access_key_id** | **String** |  | [required] |
   287  
   288  ### Return type
   289  
   290   (empty response body)
   291  
   292  ### Authorization
   293  
   294  [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)
   295  
   296  ### HTTP request headers
   297  
   298  - **Content-Type**: Not defined
   299  - **Accept**: application/json
   300  
   301  [[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)
   302  
   303  
   304  ## delete_group
   305  
   306  > delete_group(group_id)
   307  delete group
   308  
   309  ### Parameters
   310  
   311  
   312  Name | Type | Description  | Required | Notes
   313  ------------- | ------------- | ------------- | ------------- | -------------
   314  **group_id** | **String** |  | [required] |
   315  
   316  ### Return type
   317  
   318   (empty response body)
   319  
   320  ### Authorization
   321  
   322  [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)
   323  
   324  ### HTTP request headers
   325  
   326  - **Content-Type**: Not defined
   327  - **Accept**: application/json
   328  
   329  [[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)
   330  
   331  
   332  ## delete_group_membership
   333  
   334  > delete_group_membership(group_id, user_id)
   335  delete group membership
   336  
   337  ### Parameters
   338  
   339  
   340  Name | Type | Description  | Required | Notes
   341  ------------- | ------------- | ------------- | ------------- | -------------
   342  **group_id** | **String** |  | [required] |
   343  **user_id** | **String** |  | [required] |
   344  
   345  ### Return type
   346  
   347   (empty response body)
   348  
   349  ### Authorization
   350  
   351  [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)
   352  
   353  ### HTTP request headers
   354  
   355  - **Content-Type**: Not defined
   356  - **Accept**: application/json
   357  
   358  [[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)
   359  
   360  
   361  ## delete_policy
   362  
   363  > delete_policy(policy_id)
   364  delete policy
   365  
   366  ### Parameters
   367  
   368  
   369  Name | Type | Description  | Required | Notes
   370  ------------- | ------------- | ------------- | ------------- | -------------
   371  **policy_id** | **String** |  | [required] |
   372  
   373  ### Return type
   374  
   375   (empty response body)
   376  
   377  ### Authorization
   378  
   379  [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)
   380  
   381  ### HTTP request headers
   382  
   383  - **Content-Type**: Not defined
   384  - **Accept**: application/json
   385  
   386  [[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)
   387  
   388  
   389  ## delete_user
   390  
   391  > delete_user(user_id)
   392  delete user
   393  
   394  ### Parameters
   395  
   396  
   397  Name | Type | Description  | Required | Notes
   398  ------------- | ------------- | ------------- | ------------- | -------------
   399  **user_id** | **String** |  | [required] |
   400  
   401  ### Return type
   402  
   403   (empty response body)
   404  
   405  ### Authorization
   406  
   407  [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)
   408  
   409  ### HTTP request headers
   410  
   411  - **Content-Type**: Not defined
   412  - **Accept**: application/json
   413  
   414  [[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)
   415  
   416  
   417  ## delete_user_external_principal
   418  
   419  > delete_user_external_principal(user_id, principal_id)
   420  delete external principal from user
   421  
   422  ### Parameters
   423  
   424  
   425  Name | Type | Description  | Required | Notes
   426  ------------- | ------------- | ------------- | ------------- | -------------
   427  **user_id** | **String** |  | [required] |
   428  **principal_id** | **String** |  | [required] |
   429  
   430  ### Return type
   431  
   432   (empty response body)
   433  
   434  ### Authorization
   435  
   436  [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)
   437  
   438  ### HTTP request headers
   439  
   440  - **Content-Type**: Not defined
   441  - **Accept**: application/json
   442  
   443  [[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)
   444  
   445  
   446  ## detach_policy_from_group
   447  
   448  > detach_policy_from_group(group_id, policy_id)
   449  detach policy from group
   450  
   451  ### Parameters
   452  
   453  
   454  Name | Type | Description  | Required | Notes
   455  ------------- | ------------- | ------------- | ------------- | -------------
   456  **group_id** | **String** |  | [required] |
   457  **policy_id** | **String** |  | [required] |
   458  
   459  ### Return type
   460  
   461   (empty response body)
   462  
   463  ### Authorization
   464  
   465  [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)
   466  
   467  ### HTTP request headers
   468  
   469  - **Content-Type**: Not defined
   470  - **Accept**: application/json
   471  
   472  [[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)
   473  
   474  
   475  ## detach_policy_from_user
   476  
   477  > detach_policy_from_user(user_id, policy_id)
   478  detach policy from user
   479  
   480  ### Parameters
   481  
   482  
   483  Name | Type | Description  | Required | Notes
   484  ------------- | ------------- | ------------- | ------------- | -------------
   485  **user_id** | **String** |  | [required] |
   486  **policy_id** | **String** |  | [required] |
   487  
   488  ### Return type
   489  
   490   (empty response body)
   491  
   492  ### Authorization
   493  
   494  [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)
   495  
   496  ### HTTP request headers
   497  
   498  - **Content-Type**: Not defined
   499  - **Accept**: application/json
   500  
   501  [[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)
   502  
   503  
   504  ## external_principal_login
   505  
   506  > models::AuthenticationToken external_principal_login(external_login_information)
   507  perform a login using an external authenticator
   508  
   509  ### Parameters
   510  
   511  
   512  Name | Type | Description  | Required | Notes
   513  ------------- | ------------- | ------------- | ------------- | -------------
   514  **external_login_information** | Option<[**ExternalLoginInformation**](ExternalLoginInformation.md)> |  |  |
   515  
   516  ### Return type
   517  
   518  [**models::AuthenticationToken**](AuthenticationToken.md)
   519  
   520  ### Authorization
   521  
   522  No authorization required
   523  
   524  ### HTTP request headers
   525  
   526  - **Content-Type**: application/json
   527  - **Accept**: application/json
   528  
   529  [[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)
   530  
   531  
   532  ## get_credentials
   533  
   534  > models::Credentials get_credentials(user_id, access_key_id)
   535  get credentials
   536  
   537  ### Parameters
   538  
   539  
   540  Name | Type | Description  | Required | Notes
   541  ------------- | ------------- | ------------- | ------------- | -------------
   542  **user_id** | **String** |  | [required] |
   543  **access_key_id** | **String** |  | [required] |
   544  
   545  ### Return type
   546  
   547  [**models::Credentials**](Credentials.md)
   548  
   549  ### Authorization
   550  
   551  [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)
   552  
   553  ### HTTP request headers
   554  
   555  - **Content-Type**: Not defined
   556  - **Accept**: application/json
   557  
   558  [[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)
   559  
   560  
   561  ## get_current_user
   562  
   563  > models::CurrentUser get_current_user()
   564  get current user
   565  
   566  ### Parameters
   567  
   568  This endpoint does not need any parameter.
   569  
   570  ### Return type
   571  
   572  [**models::CurrentUser**](CurrentUser.md)
   573  
   574  ### Authorization
   575  
   576  [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)
   577  
   578  ### HTTP request headers
   579  
   580  - **Content-Type**: Not defined
   581  - **Accept**: application/json
   582  
   583  [[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)
   584  
   585  
   586  ## get_external_principal
   587  
   588  > models::ExternalPrincipal get_external_principal(principal_id)
   589  describe external principal by id
   590  
   591  ### Parameters
   592  
   593  
   594  Name | Type | Description  | Required | Notes
   595  ------------- | ------------- | ------------- | ------------- | -------------
   596  **principal_id** | **String** |  | [required] |
   597  
   598  ### Return type
   599  
   600  [**models::ExternalPrincipal**](ExternalPrincipal.md)
   601  
   602  ### Authorization
   603  
   604  [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)
   605  
   606  ### HTTP request headers
   607  
   608  - **Content-Type**: Not defined
   609  - **Accept**: application/json
   610  
   611  [[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)
   612  
   613  
   614  ## get_group
   615  
   616  > models::Group get_group(group_id)
   617  get group
   618  
   619  ### Parameters
   620  
   621  
   622  Name | Type | Description  | Required | Notes
   623  ------------- | ------------- | ------------- | ------------- | -------------
   624  **group_id** | **String** |  | [required] |
   625  
   626  ### Return type
   627  
   628  [**models::Group**](Group.md)
   629  
   630  ### Authorization
   631  
   632  [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)
   633  
   634  ### HTTP request headers
   635  
   636  - **Content-Type**: Not defined
   637  - **Accept**: application/json
   638  
   639  [[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)
   640  
   641  
   642  ## get_group_acl
   643  
   644  > models::Acl get_group_acl(group_id)
   645  get ACL of group
   646  
   647  ### Parameters
   648  
   649  
   650  Name | Type | Description  | Required | Notes
   651  ------------- | ------------- | ------------- | ------------- | -------------
   652  **group_id** | **String** |  | [required] |
   653  
   654  ### Return type
   655  
   656  [**models::Acl**](ACL.md)
   657  
   658  ### Authorization
   659  
   660  [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)
   661  
   662  ### HTTP request headers
   663  
   664  - **Content-Type**: Not defined
   665  - **Accept**: application/json
   666  
   667  [[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)
   668  
   669  
   670  ## get_policy
   671  
   672  > models::Policy get_policy(policy_id)
   673  get policy
   674  
   675  ### Parameters
   676  
   677  
   678  Name | Type | Description  | Required | Notes
   679  ------------- | ------------- | ------------- | ------------- | -------------
   680  **policy_id** | **String** |  | [required] |
   681  
   682  ### Return type
   683  
   684  [**models::Policy**](Policy.md)
   685  
   686  ### Authorization
   687  
   688  [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)
   689  
   690  ### HTTP request headers
   691  
   692  - **Content-Type**: Not defined
   693  - **Accept**: application/json
   694  
   695  [[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)
   696  
   697  
   698  ## get_user
   699  
   700  > models::User get_user(user_id)
   701  get user
   702  
   703  ### Parameters
   704  
   705  
   706  Name | Type | Description  | Required | Notes
   707  ------------- | ------------- | ------------- | ------------- | -------------
   708  **user_id** | **String** |  | [required] |
   709  
   710  ### Return type
   711  
   712  [**models::User**](User.md)
   713  
   714  ### Authorization
   715  
   716  [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)
   717  
   718  ### HTTP request headers
   719  
   720  - **Content-Type**: Not defined
   721  - **Accept**: application/json
   722  
   723  [[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)
   724  
   725  
   726  ## list_group_members
   727  
   728  > models::UserList list_group_members(group_id, prefix, after, amount)
   729  list group members
   730  
   731  ### Parameters
   732  
   733  
   734  Name | Type | Description  | Required | Notes
   735  ------------- | ------------- | ------------- | ------------- | -------------
   736  **group_id** | **String** |  | [required] |
   737  **prefix** | Option<**String**> | return items prefixed with this value |  |
   738  **after** | Option<**String**> | return items after this value |  |
   739  **amount** | Option<**i32**> | how many items to return |  |[default to 100]
   740  
   741  ### Return type
   742  
   743  [**models::UserList**](UserList.md)
   744  
   745  ### Authorization
   746  
   747  [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)
   748  
   749  ### HTTP request headers
   750  
   751  - **Content-Type**: Not defined
   752  - **Accept**: application/json
   753  
   754  [[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)
   755  
   756  
   757  ## list_group_policies
   758  
   759  > models::PolicyList list_group_policies(group_id, prefix, after, amount)
   760  list group policies
   761  
   762  ### Parameters
   763  
   764  
   765  Name | Type | Description  | Required | Notes
   766  ------------- | ------------- | ------------- | ------------- | -------------
   767  **group_id** | **String** |  | [required] |
   768  **prefix** | Option<**String**> | return items prefixed with this value |  |
   769  **after** | Option<**String**> | return items after this value |  |
   770  **amount** | Option<**i32**> | how many items to return |  |[default to 100]
   771  
   772  ### Return type
   773  
   774  [**models::PolicyList**](PolicyList.md)
   775  
   776  ### Authorization
   777  
   778  [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)
   779  
   780  ### HTTP request headers
   781  
   782  - **Content-Type**: Not defined
   783  - **Accept**: application/json
   784  
   785  [[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)
   786  
   787  
   788  ## list_groups
   789  
   790  > models::GroupList list_groups(prefix, after, amount)
   791  list groups
   792  
   793  ### Parameters
   794  
   795  
   796  Name | Type | Description  | Required | Notes
   797  ------------- | ------------- | ------------- | ------------- | -------------
   798  **prefix** | Option<**String**> | return items prefixed with this value |  |
   799  **after** | Option<**String**> | return items after this value |  |
   800  **amount** | Option<**i32**> | how many items to return |  |[default to 100]
   801  
   802  ### Return type
   803  
   804  [**models::GroupList**](GroupList.md)
   805  
   806  ### Authorization
   807  
   808  [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)
   809  
   810  ### HTTP request headers
   811  
   812  - **Content-Type**: Not defined
   813  - **Accept**: application/json
   814  
   815  [[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)
   816  
   817  
   818  ## list_policies
   819  
   820  > models::PolicyList list_policies(prefix, after, amount)
   821  list policies
   822  
   823  ### Parameters
   824  
   825  
   826  Name | Type | Description  | Required | Notes
   827  ------------- | ------------- | ------------- | ------------- | -------------
   828  **prefix** | Option<**String**> | return items prefixed with this value |  |
   829  **after** | Option<**String**> | return items after this value |  |
   830  **amount** | Option<**i32**> | how many items to return |  |[default to 100]
   831  
   832  ### Return type
   833  
   834  [**models::PolicyList**](PolicyList.md)
   835  
   836  ### Authorization
   837  
   838  [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)
   839  
   840  ### HTTP request headers
   841  
   842  - **Content-Type**: Not defined
   843  - **Accept**: application/json
   844  
   845  [[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)
   846  
   847  
   848  ## list_user_credentials
   849  
   850  > models::CredentialsList list_user_credentials(user_id, prefix, after, amount)
   851  list user credentials
   852  
   853  ### Parameters
   854  
   855  
   856  Name | Type | Description  | Required | Notes
   857  ------------- | ------------- | ------------- | ------------- | -------------
   858  **user_id** | **String** |  | [required] |
   859  **prefix** | Option<**String**> | return items prefixed with this value |  |
   860  **after** | Option<**String**> | return items after this value |  |
   861  **amount** | Option<**i32**> | how many items to return |  |[default to 100]
   862  
   863  ### Return type
   864  
   865  [**models::CredentialsList**](CredentialsList.md)
   866  
   867  ### Authorization
   868  
   869  [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)
   870  
   871  ### HTTP request headers
   872  
   873  - **Content-Type**: Not defined
   874  - **Accept**: application/json
   875  
   876  [[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)
   877  
   878  
   879  ## list_user_external_principals
   880  
   881  > models::ExternalPrincipalList list_user_external_principals(user_id, prefix, after, amount)
   882  list user external policies attached to a user
   883  
   884  ### Parameters
   885  
   886  
   887  Name | Type | Description  | Required | Notes
   888  ------------- | ------------- | ------------- | ------------- | -------------
   889  **user_id** | **String** |  | [required] |
   890  **prefix** | Option<**String**> | return items prefixed with this value |  |
   891  **after** | Option<**String**> | return items after this value |  |
   892  **amount** | Option<**i32**> | how many items to return |  |[default to 100]
   893  
   894  ### Return type
   895  
   896  [**models::ExternalPrincipalList**](ExternalPrincipalList.md)
   897  
   898  ### Authorization
   899  
   900  [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)
   901  
   902  ### HTTP request headers
   903  
   904  - **Content-Type**: Not defined
   905  - **Accept**: application/json
   906  
   907  [[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)
   908  
   909  
   910  ## list_user_groups
   911  
   912  > models::GroupList list_user_groups(user_id, prefix, after, amount)
   913  list user groups
   914  
   915  ### Parameters
   916  
   917  
   918  Name | Type | Description  | Required | Notes
   919  ------------- | ------------- | ------------- | ------------- | -------------
   920  **user_id** | **String** |  | [required] |
   921  **prefix** | Option<**String**> | return items prefixed with this value |  |
   922  **after** | Option<**String**> | return items after this value |  |
   923  **amount** | Option<**i32**> | how many items to return |  |[default to 100]
   924  
   925  ### Return type
   926  
   927  [**models::GroupList**](GroupList.md)
   928  
   929  ### Authorization
   930  
   931  [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)
   932  
   933  ### HTTP request headers
   934  
   935  - **Content-Type**: Not defined
   936  - **Accept**: application/json
   937  
   938  [[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)
   939  
   940  
   941  ## list_user_policies
   942  
   943  > models::PolicyList list_user_policies(user_id, prefix, after, amount, effective)
   944  list user policies
   945  
   946  ### Parameters
   947  
   948  
   949  Name | Type | Description  | Required | Notes
   950  ------------- | ------------- | ------------- | ------------- | -------------
   951  **user_id** | **String** |  | [required] |
   952  **prefix** | Option<**String**> | return items prefixed with this value |  |
   953  **after** | Option<**String**> | return items after this value |  |
   954  **amount** | Option<**i32**> | how many items to return |  |[default to 100]
   955  **effective** | Option<**bool**> | will return all distinct policies attached to the user or any of its groups |  |[default to false]
   956  
   957  ### Return type
   958  
   959  [**models::PolicyList**](PolicyList.md)
   960  
   961  ### Authorization
   962  
   963  [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)
   964  
   965  ### HTTP request headers
   966  
   967  - **Content-Type**: Not defined
   968  - **Accept**: application/json
   969  
   970  [[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)
   971  
   972  
   973  ## list_users
   974  
   975  > models::UserList list_users(prefix, after, amount)
   976  list users
   977  
   978  ### Parameters
   979  
   980  
   981  Name | Type | Description  | Required | Notes
   982  ------------- | ------------- | ------------- | ------------- | -------------
   983  **prefix** | Option<**String**> | return items prefixed with this value |  |
   984  **after** | Option<**String**> | return items after this value |  |
   985  **amount** | Option<**i32**> | how many items to return |  |[default to 100]
   986  
   987  ### Return type
   988  
   989  [**models::UserList**](UserList.md)
   990  
   991  ### Authorization
   992  
   993  [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)
   994  
   995  ### HTTP request headers
   996  
   997  - **Content-Type**: Not defined
   998  - **Accept**: application/json
   999  
  1000  [[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)
  1001  
  1002  
  1003  ## login
  1004  
  1005  > models::AuthenticationToken login(login_information)
  1006  perform a login
  1007  
  1008  ### Parameters
  1009  
  1010  
  1011  Name | Type | Description  | Required | Notes
  1012  ------------- | ------------- | ------------- | ------------- | -------------
  1013  **login_information** | Option<[**LoginInformation**](LoginInformation.md)> |  |  |
  1014  
  1015  ### Return type
  1016  
  1017  [**models::AuthenticationToken**](AuthenticationToken.md)
  1018  
  1019  ### Authorization
  1020  
  1021  No authorization required
  1022  
  1023  ### HTTP request headers
  1024  
  1025  - **Content-Type**: application/json
  1026  - **Accept**: application/json
  1027  
  1028  [[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)
  1029  
  1030  
  1031  ## set_group_acl
  1032  
  1033  > set_group_acl(group_id, acl)
  1034  set ACL of group
  1035  
  1036  ### Parameters
  1037  
  1038  
  1039  Name | Type | Description  | Required | Notes
  1040  ------------- | ------------- | ------------- | ------------- | -------------
  1041  **group_id** | **String** |  | [required] |
  1042  **acl** | [**Acl**](Acl.md) |  | [required] |
  1043  
  1044  ### Return type
  1045  
  1046   (empty response body)
  1047  
  1048  ### Authorization
  1049  
  1050  [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)
  1051  
  1052  ### HTTP request headers
  1053  
  1054  - **Content-Type**: application/json
  1055  - **Accept**: application/json
  1056  
  1057  [[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)
  1058  
  1059  
  1060  ## update_policy
  1061  
  1062  > models::Policy update_policy(policy_id, policy)
  1063  update policy
  1064  
  1065  ### Parameters
  1066  
  1067  
  1068  Name | Type | Description  | Required | Notes
  1069  ------------- | ------------- | ------------- | ------------- | -------------
  1070  **policy_id** | **String** |  | [required] |
  1071  **policy** | [**Policy**](Policy.md) |  | [required] |
  1072  
  1073  ### Return type
  1074  
  1075  [**models::Policy**](Policy.md)
  1076  
  1077  ### Authorization
  1078  
  1079  [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)
  1080  
  1081  ### HTTP request headers
  1082  
  1083  - **Content-Type**: application/json
  1084  - **Accept**: application/json
  1085  
  1086  [[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)
  1087