github.com/treeverse/lakefs@v1.24.1-0.20240520134607-95648127bfb0/clients/java/docs/AuthApi.md (about) 1 # AuthApi 2 3 All URIs are relative to */api/v1* 4 5 | Method | HTTP request | Description | 6 |------------- | ------------- | -------------| 7 | [**addGroupMembership**](AuthApi.md#addGroupMembership) | **PUT** /auth/groups/{groupId}/members/{userId} | add group membership | 8 | [**attachPolicyToGroup**](AuthApi.md#attachPolicyToGroup) | **PUT** /auth/groups/{groupId}/policies/{policyId} | attach policy to group | 9 | [**attachPolicyToUser**](AuthApi.md#attachPolicyToUser) | **PUT** /auth/users/{userId}/policies/{policyId} | attach policy to user | 10 | [**createCredentials**](AuthApi.md#createCredentials) | **POST** /auth/users/{userId}/credentials | create credentials | 11 | [**createGroup**](AuthApi.md#createGroup) | **POST** /auth/groups | create group | 12 | [**createPolicy**](AuthApi.md#createPolicy) | **POST** /auth/policies | create policy | 13 | [**createUser**](AuthApi.md#createUser) | **POST** /auth/users | create user | 14 | [**createUserExternalPrincipal**](AuthApi.md#createUserExternalPrincipal) | **POST** /auth/users/{userId}/external/principals | attach external principal to user | 15 | [**deleteCredentials**](AuthApi.md#deleteCredentials) | **DELETE** /auth/users/{userId}/credentials/{accessKeyId} | delete credentials | 16 | [**deleteGroup**](AuthApi.md#deleteGroup) | **DELETE** /auth/groups/{groupId} | delete group | 17 | [**deleteGroupMembership**](AuthApi.md#deleteGroupMembership) | **DELETE** /auth/groups/{groupId}/members/{userId} | delete group membership | 18 | [**deletePolicy**](AuthApi.md#deletePolicy) | **DELETE** /auth/policies/{policyId} | delete policy | 19 | [**deleteUser**](AuthApi.md#deleteUser) | **DELETE** /auth/users/{userId} | delete user | 20 | [**deleteUserExternalPrincipal**](AuthApi.md#deleteUserExternalPrincipal) | **DELETE** /auth/users/{userId}/external/principals | delete external principal from user | 21 | [**detachPolicyFromGroup**](AuthApi.md#detachPolicyFromGroup) | **DELETE** /auth/groups/{groupId}/policies/{policyId} | detach policy from group | 22 | [**detachPolicyFromUser**](AuthApi.md#detachPolicyFromUser) | **DELETE** /auth/users/{userId}/policies/{policyId} | detach policy from user | 23 | [**externalPrincipalLogin**](AuthApi.md#externalPrincipalLogin) | **POST** /auth/external/principal/login | perform a login using an external authenticator | 24 | [**getCredentials**](AuthApi.md#getCredentials) | **GET** /auth/users/{userId}/credentials/{accessKeyId} | get credentials | 25 | [**getCurrentUser**](AuthApi.md#getCurrentUser) | **GET** /user | get current user | 26 | [**getExternalPrincipal**](AuthApi.md#getExternalPrincipal) | **GET** /auth/external/principals | describe external principal by id | 27 | [**getGroup**](AuthApi.md#getGroup) | **GET** /auth/groups/{groupId} | get group | 28 | [**getGroupACL**](AuthApi.md#getGroupACL) | **GET** /auth/groups/{groupId}/acl | get ACL of group | 29 | [**getPolicy**](AuthApi.md#getPolicy) | **GET** /auth/policies/{policyId} | get policy | 30 | [**getUser**](AuthApi.md#getUser) | **GET** /auth/users/{userId} | get user | 31 | [**listGroupMembers**](AuthApi.md#listGroupMembers) | **GET** /auth/groups/{groupId}/members | list group members | 32 | [**listGroupPolicies**](AuthApi.md#listGroupPolicies) | **GET** /auth/groups/{groupId}/policies | list group policies | 33 | [**listGroups**](AuthApi.md#listGroups) | **GET** /auth/groups | list groups | 34 | [**listPolicies**](AuthApi.md#listPolicies) | **GET** /auth/policies | list policies | 35 | [**listUserCredentials**](AuthApi.md#listUserCredentials) | **GET** /auth/users/{userId}/credentials | list user credentials | 36 | [**listUserExternalPrincipals**](AuthApi.md#listUserExternalPrincipals) | **GET** /auth/users/{userId}/external/principals/ls | list user external policies attached to a user | 37 | [**listUserGroups**](AuthApi.md#listUserGroups) | **GET** /auth/users/{userId}/groups | list user groups | 38 | [**listUserPolicies**](AuthApi.md#listUserPolicies) | **GET** /auth/users/{userId}/policies | list user policies | 39 | [**listUsers**](AuthApi.md#listUsers) | **GET** /auth/users | list users | 40 | [**login**](AuthApi.md#login) | **POST** /auth/login | perform a login | 41 | [**setGroupACL**](AuthApi.md#setGroupACL) | **POST** /auth/groups/{groupId}/acl | set ACL of group | 42 | [**updatePolicy**](AuthApi.md#updatePolicy) | **PUT** /auth/policies/{policyId} | update policy | 43 44 45 <a id="addGroupMembership"></a> 46 # **addGroupMembership** 47 > addGroupMembership(groupId, userId).execute(); 48 49 add group membership 50 51 ### Example 52 ```java 53 // Import classes: 54 import io.lakefs.clients.sdk.ApiClient; 55 import io.lakefs.clients.sdk.ApiException; 56 import io.lakefs.clients.sdk.Configuration; 57 import io.lakefs.clients.sdk.auth.*; 58 import io.lakefs.clients.sdk.models.*; 59 import io.lakefs.clients.sdk.AuthApi; 60 61 public class Example { 62 public static void main(String[] args) { 63 ApiClient defaultClient = Configuration.getDefaultApiClient(); 64 defaultClient.setBasePath("/api/v1"); 65 66 // Configure HTTP basic authorization: basic_auth 67 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 68 basic_auth.setUsername("YOUR USERNAME"); 69 basic_auth.setPassword("YOUR PASSWORD"); 70 71 // Configure API key authorization: cookie_auth 72 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 73 cookie_auth.setApiKey("YOUR API KEY"); 74 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 75 //cookie_auth.setApiKeyPrefix("Token"); 76 77 // Configure API key authorization: oidc_auth 78 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 79 oidc_auth.setApiKey("YOUR API KEY"); 80 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 81 //oidc_auth.setApiKeyPrefix("Token"); 82 83 // Configure API key authorization: saml_auth 84 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 85 saml_auth.setApiKey("YOUR API KEY"); 86 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 87 //saml_auth.setApiKeyPrefix("Token"); 88 89 // Configure HTTP bearer authorization: jwt_token 90 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 91 jwt_token.setBearerToken("BEARER TOKEN"); 92 93 AuthApi apiInstance = new AuthApi(defaultClient); 94 String groupId = "groupId_example"; // String | 95 String userId = "userId_example"; // String | 96 try { 97 apiInstance.addGroupMembership(groupId, userId) 98 .execute(); 99 } catch (ApiException e) { 100 System.err.println("Exception when calling AuthApi#addGroupMembership"); 101 System.err.println("Status code: " + e.getCode()); 102 System.err.println("Reason: " + e.getResponseBody()); 103 System.err.println("Response headers: " + e.getResponseHeaders()); 104 e.printStackTrace(); 105 } 106 } 107 } 108 ``` 109 110 ### Parameters 111 112 | Name | Type | Description | Notes | 113 |------------- | ------------- | ------------- | -------------| 114 | **groupId** | **String**| | | 115 | **userId** | **String**| | | 116 117 ### Return type 118 119 null (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 ### HTTP response details 131 | Status code | Description | Response headers | 132 |-------------|-------------|------------------| 133 | **201** | membership added successfully | - | 134 | **401** | Unauthorized | - | 135 | **404** | Resource Not Found | - | 136 | **420** | too many requests | - | 137 | **0** | Internal Server Error | - | 138 139 <a id="attachPolicyToGroup"></a> 140 # **attachPolicyToGroup** 141 > attachPolicyToGroup(groupId, policyId).execute(); 142 143 attach policy to group 144 145 ### Example 146 ```java 147 // Import classes: 148 import io.lakefs.clients.sdk.ApiClient; 149 import io.lakefs.clients.sdk.ApiException; 150 import io.lakefs.clients.sdk.Configuration; 151 import io.lakefs.clients.sdk.auth.*; 152 import io.lakefs.clients.sdk.models.*; 153 import io.lakefs.clients.sdk.AuthApi; 154 155 public class Example { 156 public static void main(String[] args) { 157 ApiClient defaultClient = Configuration.getDefaultApiClient(); 158 defaultClient.setBasePath("/api/v1"); 159 160 // Configure HTTP basic authorization: basic_auth 161 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 162 basic_auth.setUsername("YOUR USERNAME"); 163 basic_auth.setPassword("YOUR PASSWORD"); 164 165 // Configure API key authorization: cookie_auth 166 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 167 cookie_auth.setApiKey("YOUR API KEY"); 168 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 169 //cookie_auth.setApiKeyPrefix("Token"); 170 171 // Configure API key authorization: oidc_auth 172 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 173 oidc_auth.setApiKey("YOUR API KEY"); 174 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 175 //oidc_auth.setApiKeyPrefix("Token"); 176 177 // Configure API key authorization: saml_auth 178 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 179 saml_auth.setApiKey("YOUR API KEY"); 180 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 181 //saml_auth.setApiKeyPrefix("Token"); 182 183 // Configure HTTP bearer authorization: jwt_token 184 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 185 jwt_token.setBearerToken("BEARER TOKEN"); 186 187 AuthApi apiInstance = new AuthApi(defaultClient); 188 String groupId = "groupId_example"; // String | 189 String policyId = "policyId_example"; // String | 190 try { 191 apiInstance.attachPolicyToGroup(groupId, policyId) 192 .execute(); 193 } catch (ApiException e) { 194 System.err.println("Exception when calling AuthApi#attachPolicyToGroup"); 195 System.err.println("Status code: " + e.getCode()); 196 System.err.println("Reason: " + e.getResponseBody()); 197 System.err.println("Response headers: " + e.getResponseHeaders()); 198 e.printStackTrace(); 199 } 200 } 201 } 202 ``` 203 204 ### Parameters 205 206 | Name | Type | Description | Notes | 207 |------------- | ------------- | ------------- | -------------| 208 | **groupId** | **String**| | | 209 | **policyId** | **String**| | | 210 211 ### Return type 212 213 null (empty response body) 214 215 ### Authorization 216 217 [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) 218 219 ### HTTP request headers 220 221 - **Content-Type**: Not defined 222 - **Accept**: application/json 223 224 ### HTTP response details 225 | Status code | Description | Response headers | 226 |-------------|-------------|------------------| 227 | **201** | policy attached successfully | - | 228 | **401** | Unauthorized | - | 229 | **404** | Resource Not Found | - | 230 | **420** | too many requests | - | 231 | **0** | Internal Server Error | - | 232 233 <a id="attachPolicyToUser"></a> 234 # **attachPolicyToUser** 235 > attachPolicyToUser(userId, policyId).execute(); 236 237 attach policy to user 238 239 ### Example 240 ```java 241 // Import classes: 242 import io.lakefs.clients.sdk.ApiClient; 243 import io.lakefs.clients.sdk.ApiException; 244 import io.lakefs.clients.sdk.Configuration; 245 import io.lakefs.clients.sdk.auth.*; 246 import io.lakefs.clients.sdk.models.*; 247 import io.lakefs.clients.sdk.AuthApi; 248 249 public class Example { 250 public static void main(String[] args) { 251 ApiClient defaultClient = Configuration.getDefaultApiClient(); 252 defaultClient.setBasePath("/api/v1"); 253 254 // Configure HTTP basic authorization: basic_auth 255 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 256 basic_auth.setUsername("YOUR USERNAME"); 257 basic_auth.setPassword("YOUR PASSWORD"); 258 259 // Configure API key authorization: cookie_auth 260 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 261 cookie_auth.setApiKey("YOUR API KEY"); 262 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 263 //cookie_auth.setApiKeyPrefix("Token"); 264 265 // Configure API key authorization: oidc_auth 266 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 267 oidc_auth.setApiKey("YOUR API KEY"); 268 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 269 //oidc_auth.setApiKeyPrefix("Token"); 270 271 // Configure API key authorization: saml_auth 272 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 273 saml_auth.setApiKey("YOUR API KEY"); 274 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 275 //saml_auth.setApiKeyPrefix("Token"); 276 277 // Configure HTTP bearer authorization: jwt_token 278 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 279 jwt_token.setBearerToken("BEARER TOKEN"); 280 281 AuthApi apiInstance = new AuthApi(defaultClient); 282 String userId = "userId_example"; // String | 283 String policyId = "policyId_example"; // String | 284 try { 285 apiInstance.attachPolicyToUser(userId, policyId) 286 .execute(); 287 } catch (ApiException e) { 288 System.err.println("Exception when calling AuthApi#attachPolicyToUser"); 289 System.err.println("Status code: " + e.getCode()); 290 System.err.println("Reason: " + e.getResponseBody()); 291 System.err.println("Response headers: " + e.getResponseHeaders()); 292 e.printStackTrace(); 293 } 294 } 295 } 296 ``` 297 298 ### Parameters 299 300 | Name | Type | Description | Notes | 301 |------------- | ------------- | ------------- | -------------| 302 | **userId** | **String**| | | 303 | **policyId** | **String**| | | 304 305 ### Return type 306 307 null (empty response body) 308 309 ### Authorization 310 311 [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) 312 313 ### HTTP request headers 314 315 - **Content-Type**: Not defined 316 - **Accept**: application/json 317 318 ### HTTP response details 319 | Status code | Description | Response headers | 320 |-------------|-------------|------------------| 321 | **201** | policy attached successfully | - | 322 | **401** | Unauthorized | - | 323 | **404** | Resource Not Found | - | 324 | **420** | too many requests | - | 325 | **0** | Internal Server Error | - | 326 327 <a id="createCredentials"></a> 328 # **createCredentials** 329 > CredentialsWithSecret createCredentials(userId).execute(); 330 331 create credentials 332 333 ### Example 334 ```java 335 // Import classes: 336 import io.lakefs.clients.sdk.ApiClient; 337 import io.lakefs.clients.sdk.ApiException; 338 import io.lakefs.clients.sdk.Configuration; 339 import io.lakefs.clients.sdk.auth.*; 340 import io.lakefs.clients.sdk.models.*; 341 import io.lakefs.clients.sdk.AuthApi; 342 343 public class Example { 344 public static void main(String[] args) { 345 ApiClient defaultClient = Configuration.getDefaultApiClient(); 346 defaultClient.setBasePath("/api/v1"); 347 348 // Configure HTTP basic authorization: basic_auth 349 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 350 basic_auth.setUsername("YOUR USERNAME"); 351 basic_auth.setPassword("YOUR PASSWORD"); 352 353 // Configure API key authorization: cookie_auth 354 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 355 cookie_auth.setApiKey("YOUR API KEY"); 356 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 357 //cookie_auth.setApiKeyPrefix("Token"); 358 359 // Configure API key authorization: oidc_auth 360 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 361 oidc_auth.setApiKey("YOUR API KEY"); 362 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 363 //oidc_auth.setApiKeyPrefix("Token"); 364 365 // Configure API key authorization: saml_auth 366 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 367 saml_auth.setApiKey("YOUR API KEY"); 368 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 369 //saml_auth.setApiKeyPrefix("Token"); 370 371 // Configure HTTP bearer authorization: jwt_token 372 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 373 jwt_token.setBearerToken("BEARER TOKEN"); 374 375 AuthApi apiInstance = new AuthApi(defaultClient); 376 String userId = "userId_example"; // String | 377 try { 378 CredentialsWithSecret result = apiInstance.createCredentials(userId) 379 .execute(); 380 System.out.println(result); 381 } catch (ApiException e) { 382 System.err.println("Exception when calling AuthApi#createCredentials"); 383 System.err.println("Status code: " + e.getCode()); 384 System.err.println("Reason: " + e.getResponseBody()); 385 System.err.println("Response headers: " + e.getResponseHeaders()); 386 e.printStackTrace(); 387 } 388 } 389 } 390 ``` 391 392 ### Parameters 393 394 | Name | Type | Description | Notes | 395 |------------- | ------------- | ------------- | -------------| 396 | **userId** | **String**| | | 397 398 ### Return type 399 400 [**CredentialsWithSecret**](CredentialsWithSecret.md) 401 402 ### Authorization 403 404 [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) 405 406 ### HTTP request headers 407 408 - **Content-Type**: Not defined 409 - **Accept**: application/json 410 411 ### HTTP response details 412 | Status code | Description | Response headers | 413 |-------------|-------------|------------------| 414 | **201** | credentials | - | 415 | **401** | Unauthorized | - | 416 | **404** | Resource Not Found | - | 417 | **420** | too many requests | - | 418 | **0** | Internal Server Error | - | 419 420 <a id="createGroup"></a> 421 # **createGroup** 422 > Group createGroup().groupCreation(groupCreation).execute(); 423 424 create group 425 426 ### Example 427 ```java 428 // Import classes: 429 import io.lakefs.clients.sdk.ApiClient; 430 import io.lakefs.clients.sdk.ApiException; 431 import io.lakefs.clients.sdk.Configuration; 432 import io.lakefs.clients.sdk.auth.*; 433 import io.lakefs.clients.sdk.models.*; 434 import io.lakefs.clients.sdk.AuthApi; 435 436 public class Example { 437 public static void main(String[] args) { 438 ApiClient defaultClient = Configuration.getDefaultApiClient(); 439 defaultClient.setBasePath("/api/v1"); 440 441 // Configure HTTP basic authorization: basic_auth 442 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 443 basic_auth.setUsername("YOUR USERNAME"); 444 basic_auth.setPassword("YOUR PASSWORD"); 445 446 // Configure API key authorization: cookie_auth 447 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 448 cookie_auth.setApiKey("YOUR API KEY"); 449 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 450 //cookie_auth.setApiKeyPrefix("Token"); 451 452 // Configure API key authorization: oidc_auth 453 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 454 oidc_auth.setApiKey("YOUR API KEY"); 455 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 456 //oidc_auth.setApiKeyPrefix("Token"); 457 458 // Configure API key authorization: saml_auth 459 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 460 saml_auth.setApiKey("YOUR API KEY"); 461 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 462 //saml_auth.setApiKeyPrefix("Token"); 463 464 // Configure HTTP bearer authorization: jwt_token 465 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 466 jwt_token.setBearerToken("BEARER TOKEN"); 467 468 AuthApi apiInstance = new AuthApi(defaultClient); 469 GroupCreation groupCreation = new GroupCreation(); // GroupCreation | 470 try { 471 Group result = apiInstance.createGroup() 472 .groupCreation(groupCreation) 473 .execute(); 474 System.out.println(result); 475 } catch (ApiException e) { 476 System.err.println("Exception when calling AuthApi#createGroup"); 477 System.err.println("Status code: " + e.getCode()); 478 System.err.println("Reason: " + e.getResponseBody()); 479 System.err.println("Response headers: " + e.getResponseHeaders()); 480 e.printStackTrace(); 481 } 482 } 483 } 484 ``` 485 486 ### Parameters 487 488 | Name | Type | Description | Notes | 489 |------------- | ------------- | ------------- | -------------| 490 | **groupCreation** | [**GroupCreation**](GroupCreation.md)| | [optional] | 491 492 ### Return type 493 494 [**Group**](Group.md) 495 496 ### Authorization 497 498 [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) 499 500 ### HTTP request headers 501 502 - **Content-Type**: application/json 503 - **Accept**: application/json 504 505 ### HTTP response details 506 | Status code | Description | Response headers | 507 |-------------|-------------|------------------| 508 | **201** | group | - | 509 | **401** | Unauthorized | - | 510 | **404** | Resource Not Found | - | 511 | **420** | too many requests | - | 512 | **0** | Internal Server Error | - | 513 514 <a id="createPolicy"></a> 515 # **createPolicy** 516 > Policy createPolicy(policy).execute(); 517 518 create policy 519 520 ### Example 521 ```java 522 // Import classes: 523 import io.lakefs.clients.sdk.ApiClient; 524 import io.lakefs.clients.sdk.ApiException; 525 import io.lakefs.clients.sdk.Configuration; 526 import io.lakefs.clients.sdk.auth.*; 527 import io.lakefs.clients.sdk.models.*; 528 import io.lakefs.clients.sdk.AuthApi; 529 530 public class Example { 531 public static void main(String[] args) { 532 ApiClient defaultClient = Configuration.getDefaultApiClient(); 533 defaultClient.setBasePath("/api/v1"); 534 535 // Configure HTTP basic authorization: basic_auth 536 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 537 basic_auth.setUsername("YOUR USERNAME"); 538 basic_auth.setPassword("YOUR PASSWORD"); 539 540 // Configure API key authorization: cookie_auth 541 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 542 cookie_auth.setApiKey("YOUR API KEY"); 543 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 544 //cookie_auth.setApiKeyPrefix("Token"); 545 546 // Configure API key authorization: oidc_auth 547 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 548 oidc_auth.setApiKey("YOUR API KEY"); 549 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 550 //oidc_auth.setApiKeyPrefix("Token"); 551 552 // Configure API key authorization: saml_auth 553 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 554 saml_auth.setApiKey("YOUR API KEY"); 555 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 556 //saml_auth.setApiKeyPrefix("Token"); 557 558 // Configure HTTP bearer authorization: jwt_token 559 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 560 jwt_token.setBearerToken("BEARER TOKEN"); 561 562 AuthApi apiInstance = new AuthApi(defaultClient); 563 Policy policy = new Policy(); // Policy | 564 try { 565 Policy result = apiInstance.createPolicy(policy) 566 .execute(); 567 System.out.println(result); 568 } catch (ApiException e) { 569 System.err.println("Exception when calling AuthApi#createPolicy"); 570 System.err.println("Status code: " + e.getCode()); 571 System.err.println("Reason: " + e.getResponseBody()); 572 System.err.println("Response headers: " + e.getResponseHeaders()); 573 e.printStackTrace(); 574 } 575 } 576 } 577 ``` 578 579 ### Parameters 580 581 | Name | Type | Description | Notes | 582 |------------- | ------------- | ------------- | -------------| 583 | **policy** | [**Policy**](Policy.md)| | | 584 585 ### Return type 586 587 [**Policy**](Policy.md) 588 589 ### Authorization 590 591 [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) 592 593 ### HTTP request headers 594 595 - **Content-Type**: application/json 596 - **Accept**: application/json 597 598 ### HTTP response details 599 | Status code | Description | Response headers | 600 |-------------|-------------|------------------| 601 | **201** | policy | - | 602 | **400** | Validation Error | - | 603 | **401** | Unauthorized | - | 604 | **409** | Resource Conflicts With Target | - | 605 | **420** | too many requests | - | 606 | **0** | Internal Server Error | - | 607 608 <a id="createUser"></a> 609 # **createUser** 610 > User createUser().userCreation(userCreation).execute(); 611 612 create user 613 614 ### Example 615 ```java 616 // Import classes: 617 import io.lakefs.clients.sdk.ApiClient; 618 import io.lakefs.clients.sdk.ApiException; 619 import io.lakefs.clients.sdk.Configuration; 620 import io.lakefs.clients.sdk.auth.*; 621 import io.lakefs.clients.sdk.models.*; 622 import io.lakefs.clients.sdk.AuthApi; 623 624 public class Example { 625 public static void main(String[] args) { 626 ApiClient defaultClient = Configuration.getDefaultApiClient(); 627 defaultClient.setBasePath("/api/v1"); 628 629 // Configure HTTP basic authorization: basic_auth 630 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 631 basic_auth.setUsername("YOUR USERNAME"); 632 basic_auth.setPassword("YOUR PASSWORD"); 633 634 // Configure API key authorization: cookie_auth 635 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 636 cookie_auth.setApiKey("YOUR API KEY"); 637 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 638 //cookie_auth.setApiKeyPrefix("Token"); 639 640 // Configure API key authorization: oidc_auth 641 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 642 oidc_auth.setApiKey("YOUR API KEY"); 643 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 644 //oidc_auth.setApiKeyPrefix("Token"); 645 646 // Configure API key authorization: saml_auth 647 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 648 saml_auth.setApiKey("YOUR API KEY"); 649 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 650 //saml_auth.setApiKeyPrefix("Token"); 651 652 // Configure HTTP bearer authorization: jwt_token 653 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 654 jwt_token.setBearerToken("BEARER TOKEN"); 655 656 AuthApi apiInstance = new AuthApi(defaultClient); 657 UserCreation userCreation = new UserCreation(); // UserCreation | 658 try { 659 User result = apiInstance.createUser() 660 .userCreation(userCreation) 661 .execute(); 662 System.out.println(result); 663 } catch (ApiException e) { 664 System.err.println("Exception when calling AuthApi#createUser"); 665 System.err.println("Status code: " + e.getCode()); 666 System.err.println("Reason: " + e.getResponseBody()); 667 System.err.println("Response headers: " + e.getResponseHeaders()); 668 e.printStackTrace(); 669 } 670 } 671 } 672 ``` 673 674 ### Parameters 675 676 | Name | Type | Description | Notes | 677 |------------- | ------------- | ------------- | -------------| 678 | **userCreation** | [**UserCreation**](UserCreation.md)| | [optional] | 679 680 ### Return type 681 682 [**User**](User.md) 683 684 ### Authorization 685 686 [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) 687 688 ### HTTP request headers 689 690 - **Content-Type**: application/json 691 - **Accept**: application/json 692 693 ### HTTP response details 694 | Status code | Description | Response headers | 695 |-------------|-------------|------------------| 696 | **201** | user | - | 697 | **400** | validation error | - | 698 | **401** | Unauthorized | - | 699 | **409** | Resource Conflicts With Target | - | 700 | **420** | too many requests | - | 701 | **0** | Internal Server Error | - | 702 703 <a id="createUserExternalPrincipal"></a> 704 # **createUserExternalPrincipal** 705 > createUserExternalPrincipal(userId, principalId).externalPrincipalCreation(externalPrincipalCreation).execute(); 706 707 attach external principal to user 708 709 ### Example 710 ```java 711 // Import classes: 712 import io.lakefs.clients.sdk.ApiClient; 713 import io.lakefs.clients.sdk.ApiException; 714 import io.lakefs.clients.sdk.Configuration; 715 import io.lakefs.clients.sdk.auth.*; 716 import io.lakefs.clients.sdk.models.*; 717 import io.lakefs.clients.sdk.AuthApi; 718 719 public class Example { 720 public static void main(String[] args) { 721 ApiClient defaultClient = Configuration.getDefaultApiClient(); 722 defaultClient.setBasePath("/api/v1"); 723 724 // Configure HTTP basic authorization: basic_auth 725 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 726 basic_auth.setUsername("YOUR USERNAME"); 727 basic_auth.setPassword("YOUR PASSWORD"); 728 729 // Configure API key authorization: cookie_auth 730 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 731 cookie_auth.setApiKey("YOUR API KEY"); 732 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 733 //cookie_auth.setApiKeyPrefix("Token"); 734 735 // Configure API key authorization: oidc_auth 736 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 737 oidc_auth.setApiKey("YOUR API KEY"); 738 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 739 //oidc_auth.setApiKeyPrefix("Token"); 740 741 // Configure API key authorization: saml_auth 742 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 743 saml_auth.setApiKey("YOUR API KEY"); 744 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 745 //saml_auth.setApiKeyPrefix("Token"); 746 747 // Configure HTTP bearer authorization: jwt_token 748 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 749 jwt_token.setBearerToken("BEARER TOKEN"); 750 751 AuthApi apiInstance = new AuthApi(defaultClient); 752 String userId = "userId_example"; // String | 753 String principalId = "principalId_example"; // String | 754 ExternalPrincipalCreation externalPrincipalCreation = new ExternalPrincipalCreation(); // ExternalPrincipalCreation | 755 try { 756 apiInstance.createUserExternalPrincipal(userId, principalId) 757 .externalPrincipalCreation(externalPrincipalCreation) 758 .execute(); 759 } catch (ApiException e) { 760 System.err.println("Exception when calling AuthApi#createUserExternalPrincipal"); 761 System.err.println("Status code: " + e.getCode()); 762 System.err.println("Reason: " + e.getResponseBody()); 763 System.err.println("Response headers: " + e.getResponseHeaders()); 764 e.printStackTrace(); 765 } 766 } 767 } 768 ``` 769 770 ### Parameters 771 772 | Name | Type | Description | Notes | 773 |------------- | ------------- | ------------- | -------------| 774 | **userId** | **String**| | | 775 | **principalId** | **String**| | | 776 | **externalPrincipalCreation** | [**ExternalPrincipalCreation**](ExternalPrincipalCreation.md)| | [optional] | 777 778 ### Return type 779 780 null (empty response body) 781 782 ### Authorization 783 784 [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) 785 786 ### HTTP request headers 787 788 - **Content-Type**: application/json 789 - **Accept**: application/json 790 791 ### HTTP response details 792 | Status code | Description | Response headers | 793 |-------------|-------------|------------------| 794 | **201** | external principal attached successfully | - | 795 | **401** | Unauthorized | - | 796 | **404** | Resource Not Found | - | 797 | **409** | Resource Conflicts With Target | - | 798 | **420** | too many requests | - | 799 | **0** | Internal Server Error | - | 800 801 <a id="deleteCredentials"></a> 802 # **deleteCredentials** 803 > deleteCredentials(userId, accessKeyId).execute(); 804 805 delete credentials 806 807 ### Example 808 ```java 809 // Import classes: 810 import io.lakefs.clients.sdk.ApiClient; 811 import io.lakefs.clients.sdk.ApiException; 812 import io.lakefs.clients.sdk.Configuration; 813 import io.lakefs.clients.sdk.auth.*; 814 import io.lakefs.clients.sdk.models.*; 815 import io.lakefs.clients.sdk.AuthApi; 816 817 public class Example { 818 public static void main(String[] args) { 819 ApiClient defaultClient = Configuration.getDefaultApiClient(); 820 defaultClient.setBasePath("/api/v1"); 821 822 // Configure HTTP basic authorization: basic_auth 823 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 824 basic_auth.setUsername("YOUR USERNAME"); 825 basic_auth.setPassword("YOUR PASSWORD"); 826 827 // Configure API key authorization: cookie_auth 828 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 829 cookie_auth.setApiKey("YOUR API KEY"); 830 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 831 //cookie_auth.setApiKeyPrefix("Token"); 832 833 // Configure API key authorization: oidc_auth 834 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 835 oidc_auth.setApiKey("YOUR API KEY"); 836 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 837 //oidc_auth.setApiKeyPrefix("Token"); 838 839 // Configure API key authorization: saml_auth 840 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 841 saml_auth.setApiKey("YOUR API KEY"); 842 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 843 //saml_auth.setApiKeyPrefix("Token"); 844 845 // Configure HTTP bearer authorization: jwt_token 846 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 847 jwt_token.setBearerToken("BEARER TOKEN"); 848 849 AuthApi apiInstance = new AuthApi(defaultClient); 850 String userId = "userId_example"; // String | 851 String accessKeyId = "accessKeyId_example"; // String | 852 try { 853 apiInstance.deleteCredentials(userId, accessKeyId) 854 .execute(); 855 } catch (ApiException e) { 856 System.err.println("Exception when calling AuthApi#deleteCredentials"); 857 System.err.println("Status code: " + e.getCode()); 858 System.err.println("Reason: " + e.getResponseBody()); 859 System.err.println("Response headers: " + e.getResponseHeaders()); 860 e.printStackTrace(); 861 } 862 } 863 } 864 ``` 865 866 ### Parameters 867 868 | Name | Type | Description | Notes | 869 |------------- | ------------- | ------------- | -------------| 870 | **userId** | **String**| | | 871 | **accessKeyId** | **String**| | | 872 873 ### Return type 874 875 null (empty response body) 876 877 ### Authorization 878 879 [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) 880 881 ### HTTP request headers 882 883 - **Content-Type**: Not defined 884 - **Accept**: application/json 885 886 ### HTTP response details 887 | Status code | Description | Response headers | 888 |-------------|-------------|------------------| 889 | **204** | credentials deleted successfully | - | 890 | **401** | Unauthorized | - | 891 | **404** | Resource Not Found | - | 892 | **420** | too many requests | - | 893 | **0** | Internal Server Error | - | 894 895 <a id="deleteGroup"></a> 896 # **deleteGroup** 897 > deleteGroup(groupId).execute(); 898 899 delete group 900 901 ### Example 902 ```java 903 // Import classes: 904 import io.lakefs.clients.sdk.ApiClient; 905 import io.lakefs.clients.sdk.ApiException; 906 import io.lakefs.clients.sdk.Configuration; 907 import io.lakefs.clients.sdk.auth.*; 908 import io.lakefs.clients.sdk.models.*; 909 import io.lakefs.clients.sdk.AuthApi; 910 911 public class Example { 912 public static void main(String[] args) { 913 ApiClient defaultClient = Configuration.getDefaultApiClient(); 914 defaultClient.setBasePath("/api/v1"); 915 916 // Configure HTTP basic authorization: basic_auth 917 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 918 basic_auth.setUsername("YOUR USERNAME"); 919 basic_auth.setPassword("YOUR PASSWORD"); 920 921 // Configure API key authorization: cookie_auth 922 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 923 cookie_auth.setApiKey("YOUR API KEY"); 924 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 925 //cookie_auth.setApiKeyPrefix("Token"); 926 927 // Configure API key authorization: oidc_auth 928 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 929 oidc_auth.setApiKey("YOUR API KEY"); 930 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 931 //oidc_auth.setApiKeyPrefix("Token"); 932 933 // Configure API key authorization: saml_auth 934 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 935 saml_auth.setApiKey("YOUR API KEY"); 936 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 937 //saml_auth.setApiKeyPrefix("Token"); 938 939 // Configure HTTP bearer authorization: jwt_token 940 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 941 jwt_token.setBearerToken("BEARER TOKEN"); 942 943 AuthApi apiInstance = new AuthApi(defaultClient); 944 String groupId = "groupId_example"; // String | 945 try { 946 apiInstance.deleteGroup(groupId) 947 .execute(); 948 } catch (ApiException e) { 949 System.err.println("Exception when calling AuthApi#deleteGroup"); 950 System.err.println("Status code: " + e.getCode()); 951 System.err.println("Reason: " + e.getResponseBody()); 952 System.err.println("Response headers: " + e.getResponseHeaders()); 953 e.printStackTrace(); 954 } 955 } 956 } 957 ``` 958 959 ### Parameters 960 961 | Name | Type | Description | Notes | 962 |------------- | ------------- | ------------- | -------------| 963 | **groupId** | **String**| | | 964 965 ### Return type 966 967 null (empty response body) 968 969 ### Authorization 970 971 [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) 972 973 ### HTTP request headers 974 975 - **Content-Type**: Not defined 976 - **Accept**: application/json 977 978 ### HTTP response details 979 | Status code | Description | Response headers | 980 |-------------|-------------|------------------| 981 | **204** | group deleted successfully | - | 982 | **401** | Unauthorized | - | 983 | **404** | Resource Not Found | - | 984 | **420** | too many requests | - | 985 | **0** | Internal Server Error | - | 986 987 <a id="deleteGroupMembership"></a> 988 # **deleteGroupMembership** 989 > deleteGroupMembership(groupId, userId).execute(); 990 991 delete group membership 992 993 ### Example 994 ```java 995 // Import classes: 996 import io.lakefs.clients.sdk.ApiClient; 997 import io.lakefs.clients.sdk.ApiException; 998 import io.lakefs.clients.sdk.Configuration; 999 import io.lakefs.clients.sdk.auth.*; 1000 import io.lakefs.clients.sdk.models.*; 1001 import io.lakefs.clients.sdk.AuthApi; 1002 1003 public class Example { 1004 public static void main(String[] args) { 1005 ApiClient defaultClient = Configuration.getDefaultApiClient(); 1006 defaultClient.setBasePath("/api/v1"); 1007 1008 // Configure HTTP basic authorization: basic_auth 1009 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 1010 basic_auth.setUsername("YOUR USERNAME"); 1011 basic_auth.setPassword("YOUR PASSWORD"); 1012 1013 // Configure API key authorization: cookie_auth 1014 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 1015 cookie_auth.setApiKey("YOUR API KEY"); 1016 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1017 //cookie_auth.setApiKeyPrefix("Token"); 1018 1019 // Configure API key authorization: oidc_auth 1020 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 1021 oidc_auth.setApiKey("YOUR API KEY"); 1022 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1023 //oidc_auth.setApiKeyPrefix("Token"); 1024 1025 // Configure API key authorization: saml_auth 1026 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 1027 saml_auth.setApiKey("YOUR API KEY"); 1028 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1029 //saml_auth.setApiKeyPrefix("Token"); 1030 1031 // Configure HTTP bearer authorization: jwt_token 1032 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 1033 jwt_token.setBearerToken("BEARER TOKEN"); 1034 1035 AuthApi apiInstance = new AuthApi(defaultClient); 1036 String groupId = "groupId_example"; // String | 1037 String userId = "userId_example"; // String | 1038 try { 1039 apiInstance.deleteGroupMembership(groupId, userId) 1040 .execute(); 1041 } catch (ApiException e) { 1042 System.err.println("Exception when calling AuthApi#deleteGroupMembership"); 1043 System.err.println("Status code: " + e.getCode()); 1044 System.err.println("Reason: " + e.getResponseBody()); 1045 System.err.println("Response headers: " + e.getResponseHeaders()); 1046 e.printStackTrace(); 1047 } 1048 } 1049 } 1050 ``` 1051 1052 ### Parameters 1053 1054 | Name | Type | Description | Notes | 1055 |------------- | ------------- | ------------- | -------------| 1056 | **groupId** | **String**| | | 1057 | **userId** | **String**| | | 1058 1059 ### Return type 1060 1061 null (empty response body) 1062 1063 ### Authorization 1064 1065 [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) 1066 1067 ### HTTP request headers 1068 1069 - **Content-Type**: Not defined 1070 - **Accept**: application/json 1071 1072 ### HTTP response details 1073 | Status code | Description | Response headers | 1074 |-------------|-------------|------------------| 1075 | **204** | membership deleted successfully | - | 1076 | **401** | Unauthorized | - | 1077 | **404** | Resource Not Found | - | 1078 | **420** | too many requests | - | 1079 | **0** | Internal Server Error | - | 1080 1081 <a id="deletePolicy"></a> 1082 # **deletePolicy** 1083 > deletePolicy(policyId).execute(); 1084 1085 delete policy 1086 1087 ### Example 1088 ```java 1089 // Import classes: 1090 import io.lakefs.clients.sdk.ApiClient; 1091 import io.lakefs.clients.sdk.ApiException; 1092 import io.lakefs.clients.sdk.Configuration; 1093 import io.lakefs.clients.sdk.auth.*; 1094 import io.lakefs.clients.sdk.models.*; 1095 import io.lakefs.clients.sdk.AuthApi; 1096 1097 public class Example { 1098 public static void main(String[] args) { 1099 ApiClient defaultClient = Configuration.getDefaultApiClient(); 1100 defaultClient.setBasePath("/api/v1"); 1101 1102 // Configure HTTP basic authorization: basic_auth 1103 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 1104 basic_auth.setUsername("YOUR USERNAME"); 1105 basic_auth.setPassword("YOUR PASSWORD"); 1106 1107 // Configure API key authorization: cookie_auth 1108 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 1109 cookie_auth.setApiKey("YOUR API KEY"); 1110 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1111 //cookie_auth.setApiKeyPrefix("Token"); 1112 1113 // Configure API key authorization: oidc_auth 1114 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 1115 oidc_auth.setApiKey("YOUR API KEY"); 1116 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1117 //oidc_auth.setApiKeyPrefix("Token"); 1118 1119 // Configure API key authorization: saml_auth 1120 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 1121 saml_auth.setApiKey("YOUR API KEY"); 1122 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1123 //saml_auth.setApiKeyPrefix("Token"); 1124 1125 // Configure HTTP bearer authorization: jwt_token 1126 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 1127 jwt_token.setBearerToken("BEARER TOKEN"); 1128 1129 AuthApi apiInstance = new AuthApi(defaultClient); 1130 String policyId = "policyId_example"; // String | 1131 try { 1132 apiInstance.deletePolicy(policyId) 1133 .execute(); 1134 } catch (ApiException e) { 1135 System.err.println("Exception when calling AuthApi#deletePolicy"); 1136 System.err.println("Status code: " + e.getCode()); 1137 System.err.println("Reason: " + e.getResponseBody()); 1138 System.err.println("Response headers: " + e.getResponseHeaders()); 1139 e.printStackTrace(); 1140 } 1141 } 1142 } 1143 ``` 1144 1145 ### Parameters 1146 1147 | Name | Type | Description | Notes | 1148 |------------- | ------------- | ------------- | -------------| 1149 | **policyId** | **String**| | | 1150 1151 ### Return type 1152 1153 null (empty response body) 1154 1155 ### Authorization 1156 1157 [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) 1158 1159 ### HTTP request headers 1160 1161 - **Content-Type**: Not defined 1162 - **Accept**: application/json 1163 1164 ### HTTP response details 1165 | Status code | Description | Response headers | 1166 |-------------|-------------|------------------| 1167 | **204** | policy deleted successfully | - | 1168 | **401** | Unauthorized | - | 1169 | **404** | Resource Not Found | - | 1170 | **420** | too many requests | - | 1171 | **0** | Internal Server Error | - | 1172 1173 <a id="deleteUser"></a> 1174 # **deleteUser** 1175 > deleteUser(userId).execute(); 1176 1177 delete user 1178 1179 ### Example 1180 ```java 1181 // Import classes: 1182 import io.lakefs.clients.sdk.ApiClient; 1183 import io.lakefs.clients.sdk.ApiException; 1184 import io.lakefs.clients.sdk.Configuration; 1185 import io.lakefs.clients.sdk.auth.*; 1186 import io.lakefs.clients.sdk.models.*; 1187 import io.lakefs.clients.sdk.AuthApi; 1188 1189 public class Example { 1190 public static void main(String[] args) { 1191 ApiClient defaultClient = Configuration.getDefaultApiClient(); 1192 defaultClient.setBasePath("/api/v1"); 1193 1194 // Configure HTTP basic authorization: basic_auth 1195 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 1196 basic_auth.setUsername("YOUR USERNAME"); 1197 basic_auth.setPassword("YOUR PASSWORD"); 1198 1199 // Configure API key authorization: cookie_auth 1200 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 1201 cookie_auth.setApiKey("YOUR API KEY"); 1202 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1203 //cookie_auth.setApiKeyPrefix("Token"); 1204 1205 // Configure API key authorization: oidc_auth 1206 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 1207 oidc_auth.setApiKey("YOUR API KEY"); 1208 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1209 //oidc_auth.setApiKeyPrefix("Token"); 1210 1211 // Configure API key authorization: saml_auth 1212 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 1213 saml_auth.setApiKey("YOUR API KEY"); 1214 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1215 //saml_auth.setApiKeyPrefix("Token"); 1216 1217 // Configure HTTP bearer authorization: jwt_token 1218 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 1219 jwt_token.setBearerToken("BEARER TOKEN"); 1220 1221 AuthApi apiInstance = new AuthApi(defaultClient); 1222 String userId = "userId_example"; // String | 1223 try { 1224 apiInstance.deleteUser(userId) 1225 .execute(); 1226 } catch (ApiException e) { 1227 System.err.println("Exception when calling AuthApi#deleteUser"); 1228 System.err.println("Status code: " + e.getCode()); 1229 System.err.println("Reason: " + e.getResponseBody()); 1230 System.err.println("Response headers: " + e.getResponseHeaders()); 1231 e.printStackTrace(); 1232 } 1233 } 1234 } 1235 ``` 1236 1237 ### Parameters 1238 1239 | Name | Type | Description | Notes | 1240 |------------- | ------------- | ------------- | -------------| 1241 | **userId** | **String**| | | 1242 1243 ### Return type 1244 1245 null (empty response body) 1246 1247 ### Authorization 1248 1249 [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) 1250 1251 ### HTTP request headers 1252 1253 - **Content-Type**: Not defined 1254 - **Accept**: application/json 1255 1256 ### HTTP response details 1257 | Status code | Description | Response headers | 1258 |-------------|-------------|------------------| 1259 | **204** | user deleted successfully | - | 1260 | **401** | Unauthorized | - | 1261 | **404** | Resource Not Found | - | 1262 | **420** | too many requests | - | 1263 | **0** | Internal Server Error | - | 1264 1265 <a id="deleteUserExternalPrincipal"></a> 1266 # **deleteUserExternalPrincipal** 1267 > deleteUserExternalPrincipal(userId, principalId).execute(); 1268 1269 delete external principal from user 1270 1271 ### Example 1272 ```java 1273 // Import classes: 1274 import io.lakefs.clients.sdk.ApiClient; 1275 import io.lakefs.clients.sdk.ApiException; 1276 import io.lakefs.clients.sdk.Configuration; 1277 import io.lakefs.clients.sdk.auth.*; 1278 import io.lakefs.clients.sdk.models.*; 1279 import io.lakefs.clients.sdk.AuthApi; 1280 1281 public class Example { 1282 public static void main(String[] args) { 1283 ApiClient defaultClient = Configuration.getDefaultApiClient(); 1284 defaultClient.setBasePath("/api/v1"); 1285 1286 // Configure HTTP basic authorization: basic_auth 1287 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 1288 basic_auth.setUsername("YOUR USERNAME"); 1289 basic_auth.setPassword("YOUR PASSWORD"); 1290 1291 // Configure API key authorization: cookie_auth 1292 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 1293 cookie_auth.setApiKey("YOUR API KEY"); 1294 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1295 //cookie_auth.setApiKeyPrefix("Token"); 1296 1297 // Configure API key authorization: oidc_auth 1298 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 1299 oidc_auth.setApiKey("YOUR API KEY"); 1300 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1301 //oidc_auth.setApiKeyPrefix("Token"); 1302 1303 // Configure API key authorization: saml_auth 1304 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 1305 saml_auth.setApiKey("YOUR API KEY"); 1306 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1307 //saml_auth.setApiKeyPrefix("Token"); 1308 1309 // Configure HTTP bearer authorization: jwt_token 1310 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 1311 jwt_token.setBearerToken("BEARER TOKEN"); 1312 1313 AuthApi apiInstance = new AuthApi(defaultClient); 1314 String userId = "userId_example"; // String | 1315 String principalId = "principalId_example"; // String | 1316 try { 1317 apiInstance.deleteUserExternalPrincipal(userId, principalId) 1318 .execute(); 1319 } catch (ApiException e) { 1320 System.err.println("Exception when calling AuthApi#deleteUserExternalPrincipal"); 1321 System.err.println("Status code: " + e.getCode()); 1322 System.err.println("Reason: " + e.getResponseBody()); 1323 System.err.println("Response headers: " + e.getResponseHeaders()); 1324 e.printStackTrace(); 1325 } 1326 } 1327 } 1328 ``` 1329 1330 ### Parameters 1331 1332 | Name | Type | Description | Notes | 1333 |------------- | ------------- | ------------- | -------------| 1334 | **userId** | **String**| | | 1335 | **principalId** | **String**| | | 1336 1337 ### Return type 1338 1339 null (empty response body) 1340 1341 ### Authorization 1342 1343 [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) 1344 1345 ### HTTP request headers 1346 1347 - **Content-Type**: Not defined 1348 - **Accept**: application/json 1349 1350 ### HTTP response details 1351 | Status code | Description | Response headers | 1352 |-------------|-------------|------------------| 1353 | **204** | external principal detached successfully | - | 1354 | **401** | Unauthorized | - | 1355 | **404** | Resource Not Found | - | 1356 | **420** | too many requests | - | 1357 | **0** | Internal Server Error | - | 1358 1359 <a id="detachPolicyFromGroup"></a> 1360 # **detachPolicyFromGroup** 1361 > detachPolicyFromGroup(groupId, policyId).execute(); 1362 1363 detach policy from group 1364 1365 ### Example 1366 ```java 1367 // Import classes: 1368 import io.lakefs.clients.sdk.ApiClient; 1369 import io.lakefs.clients.sdk.ApiException; 1370 import io.lakefs.clients.sdk.Configuration; 1371 import io.lakefs.clients.sdk.auth.*; 1372 import io.lakefs.clients.sdk.models.*; 1373 import io.lakefs.clients.sdk.AuthApi; 1374 1375 public class Example { 1376 public static void main(String[] args) { 1377 ApiClient defaultClient = Configuration.getDefaultApiClient(); 1378 defaultClient.setBasePath("/api/v1"); 1379 1380 // Configure HTTP basic authorization: basic_auth 1381 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 1382 basic_auth.setUsername("YOUR USERNAME"); 1383 basic_auth.setPassword("YOUR PASSWORD"); 1384 1385 // Configure API key authorization: cookie_auth 1386 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 1387 cookie_auth.setApiKey("YOUR API KEY"); 1388 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1389 //cookie_auth.setApiKeyPrefix("Token"); 1390 1391 // Configure API key authorization: oidc_auth 1392 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 1393 oidc_auth.setApiKey("YOUR API KEY"); 1394 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1395 //oidc_auth.setApiKeyPrefix("Token"); 1396 1397 // Configure API key authorization: saml_auth 1398 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 1399 saml_auth.setApiKey("YOUR API KEY"); 1400 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1401 //saml_auth.setApiKeyPrefix("Token"); 1402 1403 // Configure HTTP bearer authorization: jwt_token 1404 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 1405 jwt_token.setBearerToken("BEARER TOKEN"); 1406 1407 AuthApi apiInstance = new AuthApi(defaultClient); 1408 String groupId = "groupId_example"; // String | 1409 String policyId = "policyId_example"; // String | 1410 try { 1411 apiInstance.detachPolicyFromGroup(groupId, policyId) 1412 .execute(); 1413 } catch (ApiException e) { 1414 System.err.println("Exception when calling AuthApi#detachPolicyFromGroup"); 1415 System.err.println("Status code: " + e.getCode()); 1416 System.err.println("Reason: " + e.getResponseBody()); 1417 System.err.println("Response headers: " + e.getResponseHeaders()); 1418 e.printStackTrace(); 1419 } 1420 } 1421 } 1422 ``` 1423 1424 ### Parameters 1425 1426 | Name | Type | Description | Notes | 1427 |------------- | ------------- | ------------- | -------------| 1428 | **groupId** | **String**| | | 1429 | **policyId** | **String**| | | 1430 1431 ### Return type 1432 1433 null (empty response body) 1434 1435 ### Authorization 1436 1437 [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) 1438 1439 ### HTTP request headers 1440 1441 - **Content-Type**: Not defined 1442 - **Accept**: application/json 1443 1444 ### HTTP response details 1445 | Status code | Description | Response headers | 1446 |-------------|-------------|------------------| 1447 | **204** | policy detached successfully | - | 1448 | **401** | Unauthorized | - | 1449 | **404** | Resource Not Found | - | 1450 | **420** | too many requests | - | 1451 | **0** | Internal Server Error | - | 1452 1453 <a id="detachPolicyFromUser"></a> 1454 # **detachPolicyFromUser** 1455 > detachPolicyFromUser(userId, policyId).execute(); 1456 1457 detach policy from user 1458 1459 ### Example 1460 ```java 1461 // Import classes: 1462 import io.lakefs.clients.sdk.ApiClient; 1463 import io.lakefs.clients.sdk.ApiException; 1464 import io.lakefs.clients.sdk.Configuration; 1465 import io.lakefs.clients.sdk.auth.*; 1466 import io.lakefs.clients.sdk.models.*; 1467 import io.lakefs.clients.sdk.AuthApi; 1468 1469 public class Example { 1470 public static void main(String[] args) { 1471 ApiClient defaultClient = Configuration.getDefaultApiClient(); 1472 defaultClient.setBasePath("/api/v1"); 1473 1474 // Configure HTTP basic authorization: basic_auth 1475 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 1476 basic_auth.setUsername("YOUR USERNAME"); 1477 basic_auth.setPassword("YOUR PASSWORD"); 1478 1479 // Configure API key authorization: cookie_auth 1480 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 1481 cookie_auth.setApiKey("YOUR API KEY"); 1482 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1483 //cookie_auth.setApiKeyPrefix("Token"); 1484 1485 // Configure API key authorization: oidc_auth 1486 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 1487 oidc_auth.setApiKey("YOUR API KEY"); 1488 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1489 //oidc_auth.setApiKeyPrefix("Token"); 1490 1491 // Configure API key authorization: saml_auth 1492 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 1493 saml_auth.setApiKey("YOUR API KEY"); 1494 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1495 //saml_auth.setApiKeyPrefix("Token"); 1496 1497 // Configure HTTP bearer authorization: jwt_token 1498 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 1499 jwt_token.setBearerToken("BEARER TOKEN"); 1500 1501 AuthApi apiInstance = new AuthApi(defaultClient); 1502 String userId = "userId_example"; // String | 1503 String policyId = "policyId_example"; // String | 1504 try { 1505 apiInstance.detachPolicyFromUser(userId, policyId) 1506 .execute(); 1507 } catch (ApiException e) { 1508 System.err.println("Exception when calling AuthApi#detachPolicyFromUser"); 1509 System.err.println("Status code: " + e.getCode()); 1510 System.err.println("Reason: " + e.getResponseBody()); 1511 System.err.println("Response headers: " + e.getResponseHeaders()); 1512 e.printStackTrace(); 1513 } 1514 } 1515 } 1516 ``` 1517 1518 ### Parameters 1519 1520 | Name | Type | Description | Notes | 1521 |------------- | ------------- | ------------- | -------------| 1522 | **userId** | **String**| | | 1523 | **policyId** | **String**| | | 1524 1525 ### Return type 1526 1527 null (empty response body) 1528 1529 ### Authorization 1530 1531 [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) 1532 1533 ### HTTP request headers 1534 1535 - **Content-Type**: Not defined 1536 - **Accept**: application/json 1537 1538 ### HTTP response details 1539 | Status code | Description | Response headers | 1540 |-------------|-------------|------------------| 1541 | **204** | policy detached successfully | - | 1542 | **401** | Unauthorized | - | 1543 | **404** | Resource Not Found | - | 1544 | **420** | too many requests | - | 1545 | **0** | Internal Server Error | - | 1546 1547 <a id="externalPrincipalLogin"></a> 1548 # **externalPrincipalLogin** 1549 > AuthenticationToken externalPrincipalLogin().externalLoginInformation(externalLoginInformation).execute(); 1550 1551 perform a login using an external authenticator 1552 1553 ### Example 1554 ```java 1555 // Import classes: 1556 import io.lakefs.clients.sdk.ApiClient; 1557 import io.lakefs.clients.sdk.ApiException; 1558 import io.lakefs.clients.sdk.Configuration; 1559 import io.lakefs.clients.sdk.models.*; 1560 import io.lakefs.clients.sdk.AuthApi; 1561 1562 public class Example { 1563 public static void main(String[] args) { 1564 ApiClient defaultClient = Configuration.getDefaultApiClient(); 1565 defaultClient.setBasePath("/api/v1"); 1566 1567 AuthApi apiInstance = new AuthApi(defaultClient); 1568 ExternalLoginInformation externalLoginInformation = new ExternalLoginInformation(); // ExternalLoginInformation | 1569 try { 1570 AuthenticationToken result = apiInstance.externalPrincipalLogin() 1571 .externalLoginInformation(externalLoginInformation) 1572 .execute(); 1573 System.out.println(result); 1574 } catch (ApiException e) { 1575 System.err.println("Exception when calling AuthApi#externalPrincipalLogin"); 1576 System.err.println("Status code: " + e.getCode()); 1577 System.err.println("Reason: " + e.getResponseBody()); 1578 System.err.println("Response headers: " + e.getResponseHeaders()); 1579 e.printStackTrace(); 1580 } 1581 } 1582 } 1583 ``` 1584 1585 ### Parameters 1586 1587 | Name | Type | Description | Notes | 1588 |------------- | ------------- | ------------- | -------------| 1589 | **externalLoginInformation** | [**ExternalLoginInformation**](ExternalLoginInformation.md)| | [optional] | 1590 1591 ### Return type 1592 1593 [**AuthenticationToken**](AuthenticationToken.md) 1594 1595 ### Authorization 1596 1597 No authorization required 1598 1599 ### HTTP request headers 1600 1601 - **Content-Type**: application/json 1602 - **Accept**: application/json 1603 1604 ### HTTP response details 1605 | Status code | Description | Response headers | 1606 |-------------|-------------|------------------| 1607 | **200** | successful external login | - | 1608 | **400** | Bad Request | - | 1609 | **401** | Unauthorized | - | 1610 | **403** | Forbidden | - | 1611 | **404** | Resource Not Found | - | 1612 | **420** | too many requests | - | 1613 | **0** | Internal Server Error | - | 1614 1615 <a id="getCredentials"></a> 1616 # **getCredentials** 1617 > Credentials getCredentials(userId, accessKeyId).execute(); 1618 1619 get credentials 1620 1621 ### Example 1622 ```java 1623 // Import classes: 1624 import io.lakefs.clients.sdk.ApiClient; 1625 import io.lakefs.clients.sdk.ApiException; 1626 import io.lakefs.clients.sdk.Configuration; 1627 import io.lakefs.clients.sdk.auth.*; 1628 import io.lakefs.clients.sdk.models.*; 1629 import io.lakefs.clients.sdk.AuthApi; 1630 1631 public class Example { 1632 public static void main(String[] args) { 1633 ApiClient defaultClient = Configuration.getDefaultApiClient(); 1634 defaultClient.setBasePath("/api/v1"); 1635 1636 // Configure HTTP basic authorization: basic_auth 1637 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 1638 basic_auth.setUsername("YOUR USERNAME"); 1639 basic_auth.setPassword("YOUR PASSWORD"); 1640 1641 // Configure API key authorization: cookie_auth 1642 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 1643 cookie_auth.setApiKey("YOUR API KEY"); 1644 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1645 //cookie_auth.setApiKeyPrefix("Token"); 1646 1647 // Configure API key authorization: oidc_auth 1648 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 1649 oidc_auth.setApiKey("YOUR API KEY"); 1650 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1651 //oidc_auth.setApiKeyPrefix("Token"); 1652 1653 // Configure API key authorization: saml_auth 1654 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 1655 saml_auth.setApiKey("YOUR API KEY"); 1656 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1657 //saml_auth.setApiKeyPrefix("Token"); 1658 1659 // Configure HTTP bearer authorization: jwt_token 1660 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 1661 jwt_token.setBearerToken("BEARER TOKEN"); 1662 1663 AuthApi apiInstance = new AuthApi(defaultClient); 1664 String userId = "userId_example"; // String | 1665 String accessKeyId = "accessKeyId_example"; // String | 1666 try { 1667 Credentials result = apiInstance.getCredentials(userId, accessKeyId) 1668 .execute(); 1669 System.out.println(result); 1670 } catch (ApiException e) { 1671 System.err.println("Exception when calling AuthApi#getCredentials"); 1672 System.err.println("Status code: " + e.getCode()); 1673 System.err.println("Reason: " + e.getResponseBody()); 1674 System.err.println("Response headers: " + e.getResponseHeaders()); 1675 e.printStackTrace(); 1676 } 1677 } 1678 } 1679 ``` 1680 1681 ### Parameters 1682 1683 | Name | Type | Description | Notes | 1684 |------------- | ------------- | ------------- | -------------| 1685 | **userId** | **String**| | | 1686 | **accessKeyId** | **String**| | | 1687 1688 ### Return type 1689 1690 [**Credentials**](Credentials.md) 1691 1692 ### Authorization 1693 1694 [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) 1695 1696 ### HTTP request headers 1697 1698 - **Content-Type**: Not defined 1699 - **Accept**: application/json 1700 1701 ### HTTP response details 1702 | Status code | Description | Response headers | 1703 |-------------|-------------|------------------| 1704 | **200** | credentials | - | 1705 | **401** | Unauthorized | - | 1706 | **404** | Resource Not Found | - | 1707 | **420** | too many requests | - | 1708 | **0** | Internal Server Error | - | 1709 1710 <a id="getCurrentUser"></a> 1711 # **getCurrentUser** 1712 > CurrentUser getCurrentUser().execute(); 1713 1714 get current user 1715 1716 ### Example 1717 ```java 1718 // Import classes: 1719 import io.lakefs.clients.sdk.ApiClient; 1720 import io.lakefs.clients.sdk.ApiException; 1721 import io.lakefs.clients.sdk.Configuration; 1722 import io.lakefs.clients.sdk.auth.*; 1723 import io.lakefs.clients.sdk.models.*; 1724 import io.lakefs.clients.sdk.AuthApi; 1725 1726 public class Example { 1727 public static void main(String[] args) { 1728 ApiClient defaultClient = Configuration.getDefaultApiClient(); 1729 defaultClient.setBasePath("/api/v1"); 1730 1731 // Configure HTTP basic authorization: basic_auth 1732 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 1733 basic_auth.setUsername("YOUR USERNAME"); 1734 basic_auth.setPassword("YOUR PASSWORD"); 1735 1736 // Configure API key authorization: cookie_auth 1737 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 1738 cookie_auth.setApiKey("YOUR API KEY"); 1739 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1740 //cookie_auth.setApiKeyPrefix("Token"); 1741 1742 // Configure API key authorization: oidc_auth 1743 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 1744 oidc_auth.setApiKey("YOUR API KEY"); 1745 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1746 //oidc_auth.setApiKeyPrefix("Token"); 1747 1748 // Configure API key authorization: saml_auth 1749 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 1750 saml_auth.setApiKey("YOUR API KEY"); 1751 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1752 //saml_auth.setApiKeyPrefix("Token"); 1753 1754 // Configure HTTP bearer authorization: jwt_token 1755 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 1756 jwt_token.setBearerToken("BEARER TOKEN"); 1757 1758 AuthApi apiInstance = new AuthApi(defaultClient); 1759 try { 1760 CurrentUser result = apiInstance.getCurrentUser() 1761 .execute(); 1762 System.out.println(result); 1763 } catch (ApiException e) { 1764 System.err.println("Exception when calling AuthApi#getCurrentUser"); 1765 System.err.println("Status code: " + e.getCode()); 1766 System.err.println("Reason: " + e.getResponseBody()); 1767 System.err.println("Response headers: " + e.getResponseHeaders()); 1768 e.printStackTrace(); 1769 } 1770 } 1771 } 1772 ``` 1773 1774 ### Parameters 1775 This endpoint does not need any parameter. 1776 1777 ### Return type 1778 1779 [**CurrentUser**](CurrentUser.md) 1780 1781 ### Authorization 1782 1783 [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) 1784 1785 ### HTTP request headers 1786 1787 - **Content-Type**: Not defined 1788 - **Accept**: application/json 1789 1790 ### HTTP response details 1791 | Status code | Description | Response headers | 1792 |-------------|-------------|------------------| 1793 | **200** | user | - | 1794 1795 <a id="getExternalPrincipal"></a> 1796 # **getExternalPrincipal** 1797 > ExternalPrincipal getExternalPrincipal(principalId).execute(); 1798 1799 describe external principal by id 1800 1801 ### Example 1802 ```java 1803 // Import classes: 1804 import io.lakefs.clients.sdk.ApiClient; 1805 import io.lakefs.clients.sdk.ApiException; 1806 import io.lakefs.clients.sdk.Configuration; 1807 import io.lakefs.clients.sdk.auth.*; 1808 import io.lakefs.clients.sdk.models.*; 1809 import io.lakefs.clients.sdk.AuthApi; 1810 1811 public class Example { 1812 public static void main(String[] args) { 1813 ApiClient defaultClient = Configuration.getDefaultApiClient(); 1814 defaultClient.setBasePath("/api/v1"); 1815 1816 // Configure HTTP basic authorization: basic_auth 1817 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 1818 basic_auth.setUsername("YOUR USERNAME"); 1819 basic_auth.setPassword("YOUR PASSWORD"); 1820 1821 // Configure API key authorization: cookie_auth 1822 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 1823 cookie_auth.setApiKey("YOUR API KEY"); 1824 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1825 //cookie_auth.setApiKeyPrefix("Token"); 1826 1827 // Configure API key authorization: oidc_auth 1828 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 1829 oidc_auth.setApiKey("YOUR API KEY"); 1830 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1831 //oidc_auth.setApiKeyPrefix("Token"); 1832 1833 // Configure API key authorization: saml_auth 1834 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 1835 saml_auth.setApiKey("YOUR API KEY"); 1836 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1837 //saml_auth.setApiKeyPrefix("Token"); 1838 1839 // Configure HTTP bearer authorization: jwt_token 1840 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 1841 jwt_token.setBearerToken("BEARER TOKEN"); 1842 1843 AuthApi apiInstance = new AuthApi(defaultClient); 1844 String principalId = "principalId_example"; // String | 1845 try { 1846 ExternalPrincipal result = apiInstance.getExternalPrincipal(principalId) 1847 .execute(); 1848 System.out.println(result); 1849 } catch (ApiException e) { 1850 System.err.println("Exception when calling AuthApi#getExternalPrincipal"); 1851 System.err.println("Status code: " + e.getCode()); 1852 System.err.println("Reason: " + e.getResponseBody()); 1853 System.err.println("Response headers: " + e.getResponseHeaders()); 1854 e.printStackTrace(); 1855 } 1856 } 1857 } 1858 ``` 1859 1860 ### Parameters 1861 1862 | Name | Type | Description | Notes | 1863 |------------- | ------------- | ------------- | -------------| 1864 | **principalId** | **String**| | | 1865 1866 ### Return type 1867 1868 [**ExternalPrincipal**](ExternalPrincipal.md) 1869 1870 ### Authorization 1871 1872 [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) 1873 1874 ### HTTP request headers 1875 1876 - **Content-Type**: Not defined 1877 - **Accept**: application/json 1878 1879 ### HTTP response details 1880 | Status code | Description | Response headers | 1881 |-------------|-------------|------------------| 1882 | **200** | external principal | - | 1883 | **401** | Unauthorized | - | 1884 | **404** | Resource Not Found | - | 1885 | **420** | too many requests | - | 1886 | **0** | Internal Server Error | - | 1887 1888 <a id="getGroup"></a> 1889 # **getGroup** 1890 > Group getGroup(groupId).execute(); 1891 1892 get group 1893 1894 ### Example 1895 ```java 1896 // Import classes: 1897 import io.lakefs.clients.sdk.ApiClient; 1898 import io.lakefs.clients.sdk.ApiException; 1899 import io.lakefs.clients.sdk.Configuration; 1900 import io.lakefs.clients.sdk.auth.*; 1901 import io.lakefs.clients.sdk.models.*; 1902 import io.lakefs.clients.sdk.AuthApi; 1903 1904 public class Example { 1905 public static void main(String[] args) { 1906 ApiClient defaultClient = Configuration.getDefaultApiClient(); 1907 defaultClient.setBasePath("/api/v1"); 1908 1909 // Configure HTTP basic authorization: basic_auth 1910 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 1911 basic_auth.setUsername("YOUR USERNAME"); 1912 basic_auth.setPassword("YOUR PASSWORD"); 1913 1914 // Configure API key authorization: cookie_auth 1915 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 1916 cookie_auth.setApiKey("YOUR API KEY"); 1917 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1918 //cookie_auth.setApiKeyPrefix("Token"); 1919 1920 // Configure API key authorization: oidc_auth 1921 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 1922 oidc_auth.setApiKey("YOUR API KEY"); 1923 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1924 //oidc_auth.setApiKeyPrefix("Token"); 1925 1926 // Configure API key authorization: saml_auth 1927 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 1928 saml_auth.setApiKey("YOUR API KEY"); 1929 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 1930 //saml_auth.setApiKeyPrefix("Token"); 1931 1932 // Configure HTTP bearer authorization: jwt_token 1933 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 1934 jwt_token.setBearerToken("BEARER TOKEN"); 1935 1936 AuthApi apiInstance = new AuthApi(defaultClient); 1937 String groupId = "groupId_example"; // String | 1938 try { 1939 Group result = apiInstance.getGroup(groupId) 1940 .execute(); 1941 System.out.println(result); 1942 } catch (ApiException e) { 1943 System.err.println("Exception when calling AuthApi#getGroup"); 1944 System.err.println("Status code: " + e.getCode()); 1945 System.err.println("Reason: " + e.getResponseBody()); 1946 System.err.println("Response headers: " + e.getResponseHeaders()); 1947 e.printStackTrace(); 1948 } 1949 } 1950 } 1951 ``` 1952 1953 ### Parameters 1954 1955 | Name | Type | Description | Notes | 1956 |------------- | ------------- | ------------- | -------------| 1957 | **groupId** | **String**| | | 1958 1959 ### Return type 1960 1961 [**Group**](Group.md) 1962 1963 ### Authorization 1964 1965 [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) 1966 1967 ### HTTP request headers 1968 1969 - **Content-Type**: Not defined 1970 - **Accept**: application/json 1971 1972 ### HTTP response details 1973 | Status code | Description | Response headers | 1974 |-------------|-------------|------------------| 1975 | **200** | group | - | 1976 | **401** | Unauthorized | - | 1977 | **404** | Resource Not Found | - | 1978 | **420** | too many requests | - | 1979 | **0** | Internal Server Error | - | 1980 1981 <a id="getGroupACL"></a> 1982 # **getGroupACL** 1983 > ACL getGroupACL(groupId).execute(); 1984 1985 get ACL of group 1986 1987 ### Example 1988 ```java 1989 // Import classes: 1990 import io.lakefs.clients.sdk.ApiClient; 1991 import io.lakefs.clients.sdk.ApiException; 1992 import io.lakefs.clients.sdk.Configuration; 1993 import io.lakefs.clients.sdk.auth.*; 1994 import io.lakefs.clients.sdk.models.*; 1995 import io.lakefs.clients.sdk.AuthApi; 1996 1997 public class Example { 1998 public static void main(String[] args) { 1999 ApiClient defaultClient = Configuration.getDefaultApiClient(); 2000 defaultClient.setBasePath("/api/v1"); 2001 2002 // Configure HTTP basic authorization: basic_auth 2003 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 2004 basic_auth.setUsername("YOUR USERNAME"); 2005 basic_auth.setPassword("YOUR PASSWORD"); 2006 2007 // Configure API key authorization: cookie_auth 2008 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 2009 cookie_auth.setApiKey("YOUR API KEY"); 2010 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 2011 //cookie_auth.setApiKeyPrefix("Token"); 2012 2013 // Configure API key authorization: oidc_auth 2014 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 2015 oidc_auth.setApiKey("YOUR API KEY"); 2016 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 2017 //oidc_auth.setApiKeyPrefix("Token"); 2018 2019 // Configure API key authorization: saml_auth 2020 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 2021 saml_auth.setApiKey("YOUR API KEY"); 2022 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 2023 //saml_auth.setApiKeyPrefix("Token"); 2024 2025 // Configure HTTP bearer authorization: jwt_token 2026 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 2027 jwt_token.setBearerToken("BEARER TOKEN"); 2028 2029 AuthApi apiInstance = new AuthApi(defaultClient); 2030 String groupId = "groupId_example"; // String | 2031 try { 2032 ACL result = apiInstance.getGroupACL(groupId) 2033 .execute(); 2034 System.out.println(result); 2035 } catch (ApiException e) { 2036 System.err.println("Exception when calling AuthApi#getGroupACL"); 2037 System.err.println("Status code: " + e.getCode()); 2038 System.err.println("Reason: " + e.getResponseBody()); 2039 System.err.println("Response headers: " + e.getResponseHeaders()); 2040 e.printStackTrace(); 2041 } 2042 } 2043 } 2044 ``` 2045 2046 ### Parameters 2047 2048 | Name | Type | Description | Notes | 2049 |------------- | ------------- | ------------- | -------------| 2050 | **groupId** | **String**| | | 2051 2052 ### Return type 2053 2054 [**ACL**](ACL.md) 2055 2056 ### Authorization 2057 2058 [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) 2059 2060 ### HTTP request headers 2061 2062 - **Content-Type**: Not defined 2063 - **Accept**: application/json 2064 2065 ### HTTP response details 2066 | Status code | Description | Response headers | 2067 |-------------|-------------|------------------| 2068 | **200** | ACL of group | - | 2069 | **401** | Unauthorized | - | 2070 | **404** | Group not found, or group found but has no ACL | - | 2071 | **420** | too many requests | - | 2072 | **0** | Internal Server Error | - | 2073 2074 <a id="getPolicy"></a> 2075 # **getPolicy** 2076 > Policy getPolicy(policyId).execute(); 2077 2078 get policy 2079 2080 ### Example 2081 ```java 2082 // Import classes: 2083 import io.lakefs.clients.sdk.ApiClient; 2084 import io.lakefs.clients.sdk.ApiException; 2085 import io.lakefs.clients.sdk.Configuration; 2086 import io.lakefs.clients.sdk.auth.*; 2087 import io.lakefs.clients.sdk.models.*; 2088 import io.lakefs.clients.sdk.AuthApi; 2089 2090 public class Example { 2091 public static void main(String[] args) { 2092 ApiClient defaultClient = Configuration.getDefaultApiClient(); 2093 defaultClient.setBasePath("/api/v1"); 2094 2095 // Configure HTTP basic authorization: basic_auth 2096 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 2097 basic_auth.setUsername("YOUR USERNAME"); 2098 basic_auth.setPassword("YOUR PASSWORD"); 2099 2100 // Configure API key authorization: cookie_auth 2101 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 2102 cookie_auth.setApiKey("YOUR API KEY"); 2103 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 2104 //cookie_auth.setApiKeyPrefix("Token"); 2105 2106 // Configure API key authorization: oidc_auth 2107 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 2108 oidc_auth.setApiKey("YOUR API KEY"); 2109 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 2110 //oidc_auth.setApiKeyPrefix("Token"); 2111 2112 // Configure API key authorization: saml_auth 2113 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 2114 saml_auth.setApiKey("YOUR API KEY"); 2115 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 2116 //saml_auth.setApiKeyPrefix("Token"); 2117 2118 // Configure HTTP bearer authorization: jwt_token 2119 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 2120 jwt_token.setBearerToken("BEARER TOKEN"); 2121 2122 AuthApi apiInstance = new AuthApi(defaultClient); 2123 String policyId = "policyId_example"; // String | 2124 try { 2125 Policy result = apiInstance.getPolicy(policyId) 2126 .execute(); 2127 System.out.println(result); 2128 } catch (ApiException e) { 2129 System.err.println("Exception when calling AuthApi#getPolicy"); 2130 System.err.println("Status code: " + e.getCode()); 2131 System.err.println("Reason: " + e.getResponseBody()); 2132 System.err.println("Response headers: " + e.getResponseHeaders()); 2133 e.printStackTrace(); 2134 } 2135 } 2136 } 2137 ``` 2138 2139 ### Parameters 2140 2141 | Name | Type | Description | Notes | 2142 |------------- | ------------- | ------------- | -------------| 2143 | **policyId** | **String**| | | 2144 2145 ### Return type 2146 2147 [**Policy**](Policy.md) 2148 2149 ### Authorization 2150 2151 [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) 2152 2153 ### HTTP request headers 2154 2155 - **Content-Type**: Not defined 2156 - **Accept**: application/json 2157 2158 ### HTTP response details 2159 | Status code | Description | Response headers | 2160 |-------------|-------------|------------------| 2161 | **200** | policy | - | 2162 | **401** | Unauthorized | - | 2163 | **404** | Resource Not Found | - | 2164 | **420** | too many requests | - | 2165 | **0** | Internal Server Error | - | 2166 2167 <a id="getUser"></a> 2168 # **getUser** 2169 > User getUser(userId).execute(); 2170 2171 get user 2172 2173 ### Example 2174 ```java 2175 // Import classes: 2176 import io.lakefs.clients.sdk.ApiClient; 2177 import io.lakefs.clients.sdk.ApiException; 2178 import io.lakefs.clients.sdk.Configuration; 2179 import io.lakefs.clients.sdk.auth.*; 2180 import io.lakefs.clients.sdk.models.*; 2181 import io.lakefs.clients.sdk.AuthApi; 2182 2183 public class Example { 2184 public static void main(String[] args) { 2185 ApiClient defaultClient = Configuration.getDefaultApiClient(); 2186 defaultClient.setBasePath("/api/v1"); 2187 2188 // Configure HTTP basic authorization: basic_auth 2189 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 2190 basic_auth.setUsername("YOUR USERNAME"); 2191 basic_auth.setPassword("YOUR PASSWORD"); 2192 2193 // Configure API key authorization: cookie_auth 2194 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 2195 cookie_auth.setApiKey("YOUR API KEY"); 2196 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 2197 //cookie_auth.setApiKeyPrefix("Token"); 2198 2199 // Configure API key authorization: oidc_auth 2200 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 2201 oidc_auth.setApiKey("YOUR API KEY"); 2202 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 2203 //oidc_auth.setApiKeyPrefix("Token"); 2204 2205 // Configure API key authorization: saml_auth 2206 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 2207 saml_auth.setApiKey("YOUR API KEY"); 2208 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 2209 //saml_auth.setApiKeyPrefix("Token"); 2210 2211 // Configure HTTP bearer authorization: jwt_token 2212 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 2213 jwt_token.setBearerToken("BEARER TOKEN"); 2214 2215 AuthApi apiInstance = new AuthApi(defaultClient); 2216 String userId = "userId_example"; // String | 2217 try { 2218 User result = apiInstance.getUser(userId) 2219 .execute(); 2220 System.out.println(result); 2221 } catch (ApiException e) { 2222 System.err.println("Exception when calling AuthApi#getUser"); 2223 System.err.println("Status code: " + e.getCode()); 2224 System.err.println("Reason: " + e.getResponseBody()); 2225 System.err.println("Response headers: " + e.getResponseHeaders()); 2226 e.printStackTrace(); 2227 } 2228 } 2229 } 2230 ``` 2231 2232 ### Parameters 2233 2234 | Name | Type | Description | Notes | 2235 |------------- | ------------- | ------------- | -------------| 2236 | **userId** | **String**| | | 2237 2238 ### Return type 2239 2240 [**User**](User.md) 2241 2242 ### Authorization 2243 2244 [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) 2245 2246 ### HTTP request headers 2247 2248 - **Content-Type**: Not defined 2249 - **Accept**: application/json 2250 2251 ### HTTP response details 2252 | Status code | Description | Response headers | 2253 |-------------|-------------|------------------| 2254 | **200** | user | - | 2255 | **401** | Unauthorized | - | 2256 | **404** | Resource Not Found | - | 2257 | **420** | too many requests | - | 2258 | **0** | Internal Server Error | - | 2259 2260 <a id="listGroupMembers"></a> 2261 # **listGroupMembers** 2262 > UserList listGroupMembers(groupId).prefix(prefix).after(after).amount(amount).execute(); 2263 2264 list group members 2265 2266 ### Example 2267 ```java 2268 // Import classes: 2269 import io.lakefs.clients.sdk.ApiClient; 2270 import io.lakefs.clients.sdk.ApiException; 2271 import io.lakefs.clients.sdk.Configuration; 2272 import io.lakefs.clients.sdk.auth.*; 2273 import io.lakefs.clients.sdk.models.*; 2274 import io.lakefs.clients.sdk.AuthApi; 2275 2276 public class Example { 2277 public static void main(String[] args) { 2278 ApiClient defaultClient = Configuration.getDefaultApiClient(); 2279 defaultClient.setBasePath("/api/v1"); 2280 2281 // Configure HTTP basic authorization: basic_auth 2282 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 2283 basic_auth.setUsername("YOUR USERNAME"); 2284 basic_auth.setPassword("YOUR PASSWORD"); 2285 2286 // Configure API key authorization: cookie_auth 2287 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 2288 cookie_auth.setApiKey("YOUR API KEY"); 2289 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 2290 //cookie_auth.setApiKeyPrefix("Token"); 2291 2292 // Configure API key authorization: oidc_auth 2293 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 2294 oidc_auth.setApiKey("YOUR API KEY"); 2295 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 2296 //oidc_auth.setApiKeyPrefix("Token"); 2297 2298 // Configure API key authorization: saml_auth 2299 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 2300 saml_auth.setApiKey("YOUR API KEY"); 2301 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 2302 //saml_auth.setApiKeyPrefix("Token"); 2303 2304 // Configure HTTP bearer authorization: jwt_token 2305 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 2306 jwt_token.setBearerToken("BEARER TOKEN"); 2307 2308 AuthApi apiInstance = new AuthApi(defaultClient); 2309 String groupId = "groupId_example"; // String | 2310 String prefix = "prefix_example"; // String | return items prefixed with this value 2311 String after = "after_example"; // String | return items after this value 2312 Integer amount = 100; // Integer | how many items to return 2313 try { 2314 UserList result = apiInstance.listGroupMembers(groupId) 2315 .prefix(prefix) 2316 .after(after) 2317 .amount(amount) 2318 .execute(); 2319 System.out.println(result); 2320 } catch (ApiException e) { 2321 System.err.println("Exception when calling AuthApi#listGroupMembers"); 2322 System.err.println("Status code: " + e.getCode()); 2323 System.err.println("Reason: " + e.getResponseBody()); 2324 System.err.println("Response headers: " + e.getResponseHeaders()); 2325 e.printStackTrace(); 2326 } 2327 } 2328 } 2329 ``` 2330 2331 ### Parameters 2332 2333 | Name | Type | Description | Notes | 2334 |------------- | ------------- | ------------- | -------------| 2335 | **groupId** | **String**| | | 2336 | **prefix** | **String**| return items prefixed with this value | [optional] | 2337 | **after** | **String**| return items after this value | [optional] | 2338 | **amount** | **Integer**| how many items to return | [optional] [default to 100] | 2339 2340 ### Return type 2341 2342 [**UserList**](UserList.md) 2343 2344 ### Authorization 2345 2346 [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) 2347 2348 ### HTTP request headers 2349 2350 - **Content-Type**: Not defined 2351 - **Accept**: application/json 2352 2353 ### HTTP response details 2354 | Status code | Description | Response headers | 2355 |-------------|-------------|------------------| 2356 | **200** | group member list | - | 2357 | **401** | Unauthorized | - | 2358 | **420** | too many requests | - | 2359 | **0** | Internal Server Error | - | 2360 2361 <a id="listGroupPolicies"></a> 2362 # **listGroupPolicies** 2363 > PolicyList listGroupPolicies(groupId).prefix(prefix).after(after).amount(amount).execute(); 2364 2365 list group policies 2366 2367 ### Example 2368 ```java 2369 // Import classes: 2370 import io.lakefs.clients.sdk.ApiClient; 2371 import io.lakefs.clients.sdk.ApiException; 2372 import io.lakefs.clients.sdk.Configuration; 2373 import io.lakefs.clients.sdk.auth.*; 2374 import io.lakefs.clients.sdk.models.*; 2375 import io.lakefs.clients.sdk.AuthApi; 2376 2377 public class Example { 2378 public static void main(String[] args) { 2379 ApiClient defaultClient = Configuration.getDefaultApiClient(); 2380 defaultClient.setBasePath("/api/v1"); 2381 2382 // Configure HTTP basic authorization: basic_auth 2383 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 2384 basic_auth.setUsername("YOUR USERNAME"); 2385 basic_auth.setPassword("YOUR PASSWORD"); 2386 2387 // Configure API key authorization: cookie_auth 2388 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 2389 cookie_auth.setApiKey("YOUR API KEY"); 2390 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 2391 //cookie_auth.setApiKeyPrefix("Token"); 2392 2393 // Configure API key authorization: oidc_auth 2394 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 2395 oidc_auth.setApiKey("YOUR API KEY"); 2396 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 2397 //oidc_auth.setApiKeyPrefix("Token"); 2398 2399 // Configure API key authorization: saml_auth 2400 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 2401 saml_auth.setApiKey("YOUR API KEY"); 2402 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 2403 //saml_auth.setApiKeyPrefix("Token"); 2404 2405 // Configure HTTP bearer authorization: jwt_token 2406 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 2407 jwt_token.setBearerToken("BEARER TOKEN"); 2408 2409 AuthApi apiInstance = new AuthApi(defaultClient); 2410 String groupId = "groupId_example"; // String | 2411 String prefix = "prefix_example"; // String | return items prefixed with this value 2412 String after = "after_example"; // String | return items after this value 2413 Integer amount = 100; // Integer | how many items to return 2414 try { 2415 PolicyList result = apiInstance.listGroupPolicies(groupId) 2416 .prefix(prefix) 2417 .after(after) 2418 .amount(amount) 2419 .execute(); 2420 System.out.println(result); 2421 } catch (ApiException e) { 2422 System.err.println("Exception when calling AuthApi#listGroupPolicies"); 2423 System.err.println("Status code: " + e.getCode()); 2424 System.err.println("Reason: " + e.getResponseBody()); 2425 System.err.println("Response headers: " + e.getResponseHeaders()); 2426 e.printStackTrace(); 2427 } 2428 } 2429 } 2430 ``` 2431 2432 ### Parameters 2433 2434 | Name | Type | Description | Notes | 2435 |------------- | ------------- | ------------- | -------------| 2436 | **groupId** | **String**| | | 2437 | **prefix** | **String**| return items prefixed with this value | [optional] | 2438 | **after** | **String**| return items after this value | [optional] | 2439 | **amount** | **Integer**| how many items to return | [optional] [default to 100] | 2440 2441 ### Return type 2442 2443 [**PolicyList**](PolicyList.md) 2444 2445 ### Authorization 2446 2447 [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) 2448 2449 ### HTTP request headers 2450 2451 - **Content-Type**: Not defined 2452 - **Accept**: application/json 2453 2454 ### HTTP response details 2455 | Status code | Description | Response headers | 2456 |-------------|-------------|------------------| 2457 | **200** | policy list | - | 2458 | **401** | Unauthorized | - | 2459 | **404** | Resource Not Found | - | 2460 | **420** | too many requests | - | 2461 | **0** | Internal Server Error | - | 2462 2463 <a id="listGroups"></a> 2464 # **listGroups** 2465 > GroupList listGroups().prefix(prefix).after(after).amount(amount).execute(); 2466 2467 list groups 2468 2469 ### Example 2470 ```java 2471 // Import classes: 2472 import io.lakefs.clients.sdk.ApiClient; 2473 import io.lakefs.clients.sdk.ApiException; 2474 import io.lakefs.clients.sdk.Configuration; 2475 import io.lakefs.clients.sdk.auth.*; 2476 import io.lakefs.clients.sdk.models.*; 2477 import io.lakefs.clients.sdk.AuthApi; 2478 2479 public class Example { 2480 public static void main(String[] args) { 2481 ApiClient defaultClient = Configuration.getDefaultApiClient(); 2482 defaultClient.setBasePath("/api/v1"); 2483 2484 // Configure HTTP basic authorization: basic_auth 2485 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 2486 basic_auth.setUsername("YOUR USERNAME"); 2487 basic_auth.setPassword("YOUR PASSWORD"); 2488 2489 // Configure API key authorization: cookie_auth 2490 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 2491 cookie_auth.setApiKey("YOUR API KEY"); 2492 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 2493 //cookie_auth.setApiKeyPrefix("Token"); 2494 2495 // Configure API key authorization: oidc_auth 2496 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 2497 oidc_auth.setApiKey("YOUR API KEY"); 2498 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 2499 //oidc_auth.setApiKeyPrefix("Token"); 2500 2501 // Configure API key authorization: saml_auth 2502 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 2503 saml_auth.setApiKey("YOUR API KEY"); 2504 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 2505 //saml_auth.setApiKeyPrefix("Token"); 2506 2507 // Configure HTTP bearer authorization: jwt_token 2508 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 2509 jwt_token.setBearerToken("BEARER TOKEN"); 2510 2511 AuthApi apiInstance = new AuthApi(defaultClient); 2512 String prefix = "prefix_example"; // String | return items prefixed with this value 2513 String after = "after_example"; // String | return items after this value 2514 Integer amount = 100; // Integer | how many items to return 2515 try { 2516 GroupList result = apiInstance.listGroups() 2517 .prefix(prefix) 2518 .after(after) 2519 .amount(amount) 2520 .execute(); 2521 System.out.println(result); 2522 } catch (ApiException e) { 2523 System.err.println("Exception when calling AuthApi#listGroups"); 2524 System.err.println("Status code: " + e.getCode()); 2525 System.err.println("Reason: " + e.getResponseBody()); 2526 System.err.println("Response headers: " + e.getResponseHeaders()); 2527 e.printStackTrace(); 2528 } 2529 } 2530 } 2531 ``` 2532 2533 ### Parameters 2534 2535 | Name | Type | Description | Notes | 2536 |------------- | ------------- | ------------- | -------------| 2537 | **prefix** | **String**| return items prefixed with this value | [optional] | 2538 | **after** | **String**| return items after this value | [optional] | 2539 | **amount** | **Integer**| how many items to return | [optional] [default to 100] | 2540 2541 ### Return type 2542 2543 [**GroupList**](GroupList.md) 2544 2545 ### Authorization 2546 2547 [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) 2548 2549 ### HTTP request headers 2550 2551 - **Content-Type**: Not defined 2552 - **Accept**: application/json 2553 2554 ### HTTP response details 2555 | Status code | Description | Response headers | 2556 |-------------|-------------|------------------| 2557 | **200** | group list | - | 2558 | **401** | Unauthorized | - | 2559 | **420** | too many requests | - | 2560 | **0** | Internal Server Error | - | 2561 2562 <a id="listPolicies"></a> 2563 # **listPolicies** 2564 > PolicyList listPolicies().prefix(prefix).after(after).amount(amount).execute(); 2565 2566 list policies 2567 2568 ### Example 2569 ```java 2570 // Import classes: 2571 import io.lakefs.clients.sdk.ApiClient; 2572 import io.lakefs.clients.sdk.ApiException; 2573 import io.lakefs.clients.sdk.Configuration; 2574 import io.lakefs.clients.sdk.auth.*; 2575 import io.lakefs.clients.sdk.models.*; 2576 import io.lakefs.clients.sdk.AuthApi; 2577 2578 public class Example { 2579 public static void main(String[] args) { 2580 ApiClient defaultClient = Configuration.getDefaultApiClient(); 2581 defaultClient.setBasePath("/api/v1"); 2582 2583 // Configure HTTP basic authorization: basic_auth 2584 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 2585 basic_auth.setUsername("YOUR USERNAME"); 2586 basic_auth.setPassword("YOUR PASSWORD"); 2587 2588 // Configure API key authorization: cookie_auth 2589 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 2590 cookie_auth.setApiKey("YOUR API KEY"); 2591 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 2592 //cookie_auth.setApiKeyPrefix("Token"); 2593 2594 // Configure API key authorization: oidc_auth 2595 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 2596 oidc_auth.setApiKey("YOUR API KEY"); 2597 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 2598 //oidc_auth.setApiKeyPrefix("Token"); 2599 2600 // Configure API key authorization: saml_auth 2601 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 2602 saml_auth.setApiKey("YOUR API KEY"); 2603 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 2604 //saml_auth.setApiKeyPrefix("Token"); 2605 2606 // Configure HTTP bearer authorization: jwt_token 2607 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 2608 jwt_token.setBearerToken("BEARER TOKEN"); 2609 2610 AuthApi apiInstance = new AuthApi(defaultClient); 2611 String prefix = "prefix_example"; // String | return items prefixed with this value 2612 String after = "after_example"; // String | return items after this value 2613 Integer amount = 100; // Integer | how many items to return 2614 try { 2615 PolicyList result = apiInstance.listPolicies() 2616 .prefix(prefix) 2617 .after(after) 2618 .amount(amount) 2619 .execute(); 2620 System.out.println(result); 2621 } catch (ApiException e) { 2622 System.err.println("Exception when calling AuthApi#listPolicies"); 2623 System.err.println("Status code: " + e.getCode()); 2624 System.err.println("Reason: " + e.getResponseBody()); 2625 System.err.println("Response headers: " + e.getResponseHeaders()); 2626 e.printStackTrace(); 2627 } 2628 } 2629 } 2630 ``` 2631 2632 ### Parameters 2633 2634 | Name | Type | Description | Notes | 2635 |------------- | ------------- | ------------- | -------------| 2636 | **prefix** | **String**| return items prefixed with this value | [optional] | 2637 | **after** | **String**| return items after this value | [optional] | 2638 | **amount** | **Integer**| how many items to return | [optional] [default to 100] | 2639 2640 ### Return type 2641 2642 [**PolicyList**](PolicyList.md) 2643 2644 ### Authorization 2645 2646 [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) 2647 2648 ### HTTP request headers 2649 2650 - **Content-Type**: Not defined 2651 - **Accept**: application/json 2652 2653 ### HTTP response details 2654 | Status code | Description | Response headers | 2655 |-------------|-------------|------------------| 2656 | **200** | policy list | - | 2657 | **401** | Unauthorized | - | 2658 | **420** | too many requests | - | 2659 | **0** | Internal Server Error | - | 2660 2661 <a id="listUserCredentials"></a> 2662 # **listUserCredentials** 2663 > CredentialsList listUserCredentials(userId).prefix(prefix).after(after).amount(amount).execute(); 2664 2665 list user credentials 2666 2667 ### Example 2668 ```java 2669 // Import classes: 2670 import io.lakefs.clients.sdk.ApiClient; 2671 import io.lakefs.clients.sdk.ApiException; 2672 import io.lakefs.clients.sdk.Configuration; 2673 import io.lakefs.clients.sdk.auth.*; 2674 import io.lakefs.clients.sdk.models.*; 2675 import io.lakefs.clients.sdk.AuthApi; 2676 2677 public class Example { 2678 public static void main(String[] args) { 2679 ApiClient defaultClient = Configuration.getDefaultApiClient(); 2680 defaultClient.setBasePath("/api/v1"); 2681 2682 // Configure HTTP basic authorization: basic_auth 2683 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 2684 basic_auth.setUsername("YOUR USERNAME"); 2685 basic_auth.setPassword("YOUR PASSWORD"); 2686 2687 // Configure API key authorization: cookie_auth 2688 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 2689 cookie_auth.setApiKey("YOUR API KEY"); 2690 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 2691 //cookie_auth.setApiKeyPrefix("Token"); 2692 2693 // Configure API key authorization: oidc_auth 2694 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 2695 oidc_auth.setApiKey("YOUR API KEY"); 2696 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 2697 //oidc_auth.setApiKeyPrefix("Token"); 2698 2699 // Configure API key authorization: saml_auth 2700 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 2701 saml_auth.setApiKey("YOUR API KEY"); 2702 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 2703 //saml_auth.setApiKeyPrefix("Token"); 2704 2705 // Configure HTTP bearer authorization: jwt_token 2706 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 2707 jwt_token.setBearerToken("BEARER TOKEN"); 2708 2709 AuthApi apiInstance = new AuthApi(defaultClient); 2710 String userId = "userId_example"; // String | 2711 String prefix = "prefix_example"; // String | return items prefixed with this value 2712 String after = "after_example"; // String | return items after this value 2713 Integer amount = 100; // Integer | how many items to return 2714 try { 2715 CredentialsList result = apiInstance.listUserCredentials(userId) 2716 .prefix(prefix) 2717 .after(after) 2718 .amount(amount) 2719 .execute(); 2720 System.out.println(result); 2721 } catch (ApiException e) { 2722 System.err.println("Exception when calling AuthApi#listUserCredentials"); 2723 System.err.println("Status code: " + e.getCode()); 2724 System.err.println("Reason: " + e.getResponseBody()); 2725 System.err.println("Response headers: " + e.getResponseHeaders()); 2726 e.printStackTrace(); 2727 } 2728 } 2729 } 2730 ``` 2731 2732 ### Parameters 2733 2734 | Name | Type | Description | Notes | 2735 |------------- | ------------- | ------------- | -------------| 2736 | **userId** | **String**| | | 2737 | **prefix** | **String**| return items prefixed with this value | [optional] | 2738 | **after** | **String**| return items after this value | [optional] | 2739 | **amount** | **Integer**| how many items to return | [optional] [default to 100] | 2740 2741 ### Return type 2742 2743 [**CredentialsList**](CredentialsList.md) 2744 2745 ### Authorization 2746 2747 [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) 2748 2749 ### HTTP request headers 2750 2751 - **Content-Type**: Not defined 2752 - **Accept**: application/json 2753 2754 ### HTTP response details 2755 | Status code | Description | Response headers | 2756 |-------------|-------------|------------------| 2757 | **200** | credential list | - | 2758 | **401** | Unauthorized | - | 2759 | **404** | Resource Not Found | - | 2760 | **420** | too many requests | - | 2761 | **0** | Internal Server Error | - | 2762 2763 <a id="listUserExternalPrincipals"></a> 2764 # **listUserExternalPrincipals** 2765 > ExternalPrincipalList listUserExternalPrincipals(userId).prefix(prefix).after(after).amount(amount).execute(); 2766 2767 list user external policies attached to a user 2768 2769 ### Example 2770 ```java 2771 // Import classes: 2772 import io.lakefs.clients.sdk.ApiClient; 2773 import io.lakefs.clients.sdk.ApiException; 2774 import io.lakefs.clients.sdk.Configuration; 2775 import io.lakefs.clients.sdk.auth.*; 2776 import io.lakefs.clients.sdk.models.*; 2777 import io.lakefs.clients.sdk.AuthApi; 2778 2779 public class Example { 2780 public static void main(String[] args) { 2781 ApiClient defaultClient = Configuration.getDefaultApiClient(); 2782 defaultClient.setBasePath("/api/v1"); 2783 2784 // Configure HTTP basic authorization: basic_auth 2785 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 2786 basic_auth.setUsername("YOUR USERNAME"); 2787 basic_auth.setPassword("YOUR PASSWORD"); 2788 2789 // Configure API key authorization: cookie_auth 2790 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 2791 cookie_auth.setApiKey("YOUR API KEY"); 2792 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 2793 //cookie_auth.setApiKeyPrefix("Token"); 2794 2795 // Configure API key authorization: oidc_auth 2796 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 2797 oidc_auth.setApiKey("YOUR API KEY"); 2798 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 2799 //oidc_auth.setApiKeyPrefix("Token"); 2800 2801 // Configure API key authorization: saml_auth 2802 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 2803 saml_auth.setApiKey("YOUR API KEY"); 2804 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 2805 //saml_auth.setApiKeyPrefix("Token"); 2806 2807 // Configure HTTP bearer authorization: jwt_token 2808 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 2809 jwt_token.setBearerToken("BEARER TOKEN"); 2810 2811 AuthApi apiInstance = new AuthApi(defaultClient); 2812 String userId = "userId_example"; // String | 2813 String prefix = "prefix_example"; // String | return items prefixed with this value 2814 String after = "after_example"; // String | return items after this value 2815 Integer amount = 100; // Integer | how many items to return 2816 try { 2817 ExternalPrincipalList result = apiInstance.listUserExternalPrincipals(userId) 2818 .prefix(prefix) 2819 .after(after) 2820 .amount(amount) 2821 .execute(); 2822 System.out.println(result); 2823 } catch (ApiException e) { 2824 System.err.println("Exception when calling AuthApi#listUserExternalPrincipals"); 2825 System.err.println("Status code: " + e.getCode()); 2826 System.err.println("Reason: " + e.getResponseBody()); 2827 System.err.println("Response headers: " + e.getResponseHeaders()); 2828 e.printStackTrace(); 2829 } 2830 } 2831 } 2832 ``` 2833 2834 ### Parameters 2835 2836 | Name | Type | Description | Notes | 2837 |------------- | ------------- | ------------- | -------------| 2838 | **userId** | **String**| | | 2839 | **prefix** | **String**| return items prefixed with this value | [optional] | 2840 | **after** | **String**| return items after this value | [optional] | 2841 | **amount** | **Integer**| how many items to return | [optional] [default to 100] | 2842 2843 ### Return type 2844 2845 [**ExternalPrincipalList**](ExternalPrincipalList.md) 2846 2847 ### Authorization 2848 2849 [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) 2850 2851 ### HTTP request headers 2852 2853 - **Content-Type**: Not defined 2854 - **Accept**: application/json 2855 2856 ### HTTP response details 2857 | Status code | Description | Response headers | 2858 |-------------|-------------|------------------| 2859 | **200** | external principals list | - | 2860 | **401** | Unauthorized | - | 2861 | **404** | Resource Not Found | - | 2862 | **420** | too many requests | - | 2863 | **0** | Internal Server Error | - | 2864 2865 <a id="listUserGroups"></a> 2866 # **listUserGroups** 2867 > GroupList listUserGroups(userId).prefix(prefix).after(after).amount(amount).execute(); 2868 2869 list user groups 2870 2871 ### Example 2872 ```java 2873 // Import classes: 2874 import io.lakefs.clients.sdk.ApiClient; 2875 import io.lakefs.clients.sdk.ApiException; 2876 import io.lakefs.clients.sdk.Configuration; 2877 import io.lakefs.clients.sdk.auth.*; 2878 import io.lakefs.clients.sdk.models.*; 2879 import io.lakefs.clients.sdk.AuthApi; 2880 2881 public class Example { 2882 public static void main(String[] args) { 2883 ApiClient defaultClient = Configuration.getDefaultApiClient(); 2884 defaultClient.setBasePath("/api/v1"); 2885 2886 // Configure HTTP basic authorization: basic_auth 2887 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 2888 basic_auth.setUsername("YOUR USERNAME"); 2889 basic_auth.setPassword("YOUR PASSWORD"); 2890 2891 // Configure API key authorization: cookie_auth 2892 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 2893 cookie_auth.setApiKey("YOUR API KEY"); 2894 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 2895 //cookie_auth.setApiKeyPrefix("Token"); 2896 2897 // Configure API key authorization: oidc_auth 2898 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 2899 oidc_auth.setApiKey("YOUR API KEY"); 2900 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 2901 //oidc_auth.setApiKeyPrefix("Token"); 2902 2903 // Configure API key authorization: saml_auth 2904 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 2905 saml_auth.setApiKey("YOUR API KEY"); 2906 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 2907 //saml_auth.setApiKeyPrefix("Token"); 2908 2909 // Configure HTTP bearer authorization: jwt_token 2910 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 2911 jwt_token.setBearerToken("BEARER TOKEN"); 2912 2913 AuthApi apiInstance = new AuthApi(defaultClient); 2914 String userId = "userId_example"; // String | 2915 String prefix = "prefix_example"; // String | return items prefixed with this value 2916 String after = "after_example"; // String | return items after this value 2917 Integer amount = 100; // Integer | how many items to return 2918 try { 2919 GroupList result = apiInstance.listUserGroups(userId) 2920 .prefix(prefix) 2921 .after(after) 2922 .amount(amount) 2923 .execute(); 2924 System.out.println(result); 2925 } catch (ApiException e) { 2926 System.err.println("Exception when calling AuthApi#listUserGroups"); 2927 System.err.println("Status code: " + e.getCode()); 2928 System.err.println("Reason: " + e.getResponseBody()); 2929 System.err.println("Response headers: " + e.getResponseHeaders()); 2930 e.printStackTrace(); 2931 } 2932 } 2933 } 2934 ``` 2935 2936 ### Parameters 2937 2938 | Name | Type | Description | Notes | 2939 |------------- | ------------- | ------------- | -------------| 2940 | **userId** | **String**| | | 2941 | **prefix** | **String**| return items prefixed with this value | [optional] | 2942 | **after** | **String**| return items after this value | [optional] | 2943 | **amount** | **Integer**| how many items to return | [optional] [default to 100] | 2944 2945 ### Return type 2946 2947 [**GroupList**](GroupList.md) 2948 2949 ### Authorization 2950 2951 [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) 2952 2953 ### HTTP request headers 2954 2955 - **Content-Type**: Not defined 2956 - **Accept**: application/json 2957 2958 ### HTTP response details 2959 | Status code | Description | Response headers | 2960 |-------------|-------------|------------------| 2961 | **200** | group list | - | 2962 | **401** | Unauthorized | - | 2963 | **404** | Resource Not Found | - | 2964 | **420** | too many requests | - | 2965 | **0** | Internal Server Error | - | 2966 2967 <a id="listUserPolicies"></a> 2968 # **listUserPolicies** 2969 > PolicyList listUserPolicies(userId).prefix(prefix).after(after).amount(amount).effective(effective).execute(); 2970 2971 list user policies 2972 2973 ### Example 2974 ```java 2975 // Import classes: 2976 import io.lakefs.clients.sdk.ApiClient; 2977 import io.lakefs.clients.sdk.ApiException; 2978 import io.lakefs.clients.sdk.Configuration; 2979 import io.lakefs.clients.sdk.auth.*; 2980 import io.lakefs.clients.sdk.models.*; 2981 import io.lakefs.clients.sdk.AuthApi; 2982 2983 public class Example { 2984 public static void main(String[] args) { 2985 ApiClient defaultClient = Configuration.getDefaultApiClient(); 2986 defaultClient.setBasePath("/api/v1"); 2987 2988 // Configure HTTP basic authorization: basic_auth 2989 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 2990 basic_auth.setUsername("YOUR USERNAME"); 2991 basic_auth.setPassword("YOUR PASSWORD"); 2992 2993 // Configure API key authorization: cookie_auth 2994 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 2995 cookie_auth.setApiKey("YOUR API KEY"); 2996 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 2997 //cookie_auth.setApiKeyPrefix("Token"); 2998 2999 // Configure API key authorization: oidc_auth 3000 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 3001 oidc_auth.setApiKey("YOUR API KEY"); 3002 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 3003 //oidc_auth.setApiKeyPrefix("Token"); 3004 3005 // Configure API key authorization: saml_auth 3006 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 3007 saml_auth.setApiKey("YOUR API KEY"); 3008 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 3009 //saml_auth.setApiKeyPrefix("Token"); 3010 3011 // Configure HTTP bearer authorization: jwt_token 3012 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 3013 jwt_token.setBearerToken("BEARER TOKEN"); 3014 3015 AuthApi apiInstance = new AuthApi(defaultClient); 3016 String userId = "userId_example"; // String | 3017 String prefix = "prefix_example"; // String | return items prefixed with this value 3018 String after = "after_example"; // String | return items after this value 3019 Integer amount = 100; // Integer | how many items to return 3020 Boolean effective = false; // Boolean | will return all distinct policies attached to the user or any of its groups 3021 try { 3022 PolicyList result = apiInstance.listUserPolicies(userId) 3023 .prefix(prefix) 3024 .after(after) 3025 .amount(amount) 3026 .effective(effective) 3027 .execute(); 3028 System.out.println(result); 3029 } catch (ApiException e) { 3030 System.err.println("Exception when calling AuthApi#listUserPolicies"); 3031 System.err.println("Status code: " + e.getCode()); 3032 System.err.println("Reason: " + e.getResponseBody()); 3033 System.err.println("Response headers: " + e.getResponseHeaders()); 3034 e.printStackTrace(); 3035 } 3036 } 3037 } 3038 ``` 3039 3040 ### Parameters 3041 3042 | Name | Type | Description | Notes | 3043 |------------- | ------------- | ------------- | -------------| 3044 | **userId** | **String**| | | 3045 | **prefix** | **String**| return items prefixed with this value | [optional] | 3046 | **after** | **String**| return items after this value | [optional] | 3047 | **amount** | **Integer**| how many items to return | [optional] [default to 100] | 3048 | **effective** | **Boolean**| will return all distinct policies attached to the user or any of its groups | [optional] [default to false] | 3049 3050 ### Return type 3051 3052 [**PolicyList**](PolicyList.md) 3053 3054 ### Authorization 3055 3056 [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) 3057 3058 ### HTTP request headers 3059 3060 - **Content-Type**: Not defined 3061 - **Accept**: application/json 3062 3063 ### HTTP response details 3064 | Status code | Description | Response headers | 3065 |-------------|-------------|------------------| 3066 | **200** | policy list | - | 3067 | **401** | Unauthorized | - | 3068 | **404** | Resource Not Found | - | 3069 | **420** | too many requests | - | 3070 | **0** | Internal Server Error | - | 3071 3072 <a id="listUsers"></a> 3073 # **listUsers** 3074 > UserList listUsers().prefix(prefix).after(after).amount(amount).execute(); 3075 3076 list users 3077 3078 ### Example 3079 ```java 3080 // Import classes: 3081 import io.lakefs.clients.sdk.ApiClient; 3082 import io.lakefs.clients.sdk.ApiException; 3083 import io.lakefs.clients.sdk.Configuration; 3084 import io.lakefs.clients.sdk.auth.*; 3085 import io.lakefs.clients.sdk.models.*; 3086 import io.lakefs.clients.sdk.AuthApi; 3087 3088 public class Example { 3089 public static void main(String[] args) { 3090 ApiClient defaultClient = Configuration.getDefaultApiClient(); 3091 defaultClient.setBasePath("/api/v1"); 3092 3093 // Configure HTTP basic authorization: basic_auth 3094 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 3095 basic_auth.setUsername("YOUR USERNAME"); 3096 basic_auth.setPassword("YOUR PASSWORD"); 3097 3098 // Configure API key authorization: cookie_auth 3099 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 3100 cookie_auth.setApiKey("YOUR API KEY"); 3101 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 3102 //cookie_auth.setApiKeyPrefix("Token"); 3103 3104 // Configure API key authorization: oidc_auth 3105 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 3106 oidc_auth.setApiKey("YOUR API KEY"); 3107 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 3108 //oidc_auth.setApiKeyPrefix("Token"); 3109 3110 // Configure API key authorization: saml_auth 3111 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 3112 saml_auth.setApiKey("YOUR API KEY"); 3113 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 3114 //saml_auth.setApiKeyPrefix("Token"); 3115 3116 // Configure HTTP bearer authorization: jwt_token 3117 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 3118 jwt_token.setBearerToken("BEARER TOKEN"); 3119 3120 AuthApi apiInstance = new AuthApi(defaultClient); 3121 String prefix = "prefix_example"; // String | return items prefixed with this value 3122 String after = "after_example"; // String | return items after this value 3123 Integer amount = 100; // Integer | how many items to return 3124 try { 3125 UserList result = apiInstance.listUsers() 3126 .prefix(prefix) 3127 .after(after) 3128 .amount(amount) 3129 .execute(); 3130 System.out.println(result); 3131 } catch (ApiException e) { 3132 System.err.println("Exception when calling AuthApi#listUsers"); 3133 System.err.println("Status code: " + e.getCode()); 3134 System.err.println("Reason: " + e.getResponseBody()); 3135 System.err.println("Response headers: " + e.getResponseHeaders()); 3136 e.printStackTrace(); 3137 } 3138 } 3139 } 3140 ``` 3141 3142 ### Parameters 3143 3144 | Name | Type | Description | Notes | 3145 |------------- | ------------- | ------------- | -------------| 3146 | **prefix** | **String**| return items prefixed with this value | [optional] | 3147 | **after** | **String**| return items after this value | [optional] | 3148 | **amount** | **Integer**| how many items to return | [optional] [default to 100] | 3149 3150 ### Return type 3151 3152 [**UserList**](UserList.md) 3153 3154 ### Authorization 3155 3156 [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) 3157 3158 ### HTTP request headers 3159 3160 - **Content-Type**: Not defined 3161 - **Accept**: application/json 3162 3163 ### HTTP response details 3164 | Status code | Description | Response headers | 3165 |-------------|-------------|------------------| 3166 | **200** | user list | - | 3167 | **401** | Unauthorized | - | 3168 | **420** | too many requests | - | 3169 | **0** | Internal Server Error | - | 3170 3171 <a id="login"></a> 3172 # **login** 3173 > AuthenticationToken login().loginInformation(loginInformation).execute(); 3174 3175 perform a login 3176 3177 ### Example 3178 ```java 3179 // Import classes: 3180 import io.lakefs.clients.sdk.ApiClient; 3181 import io.lakefs.clients.sdk.ApiException; 3182 import io.lakefs.clients.sdk.Configuration; 3183 import io.lakefs.clients.sdk.models.*; 3184 import io.lakefs.clients.sdk.AuthApi; 3185 3186 public class Example { 3187 public static void main(String[] args) { 3188 ApiClient defaultClient = Configuration.getDefaultApiClient(); 3189 defaultClient.setBasePath("/api/v1"); 3190 3191 AuthApi apiInstance = new AuthApi(defaultClient); 3192 LoginInformation loginInformation = new LoginInformation(); // LoginInformation | 3193 try { 3194 AuthenticationToken result = apiInstance.login() 3195 .loginInformation(loginInformation) 3196 .execute(); 3197 System.out.println(result); 3198 } catch (ApiException e) { 3199 System.err.println("Exception when calling AuthApi#login"); 3200 System.err.println("Status code: " + e.getCode()); 3201 System.err.println("Reason: " + e.getResponseBody()); 3202 System.err.println("Response headers: " + e.getResponseHeaders()); 3203 e.printStackTrace(); 3204 } 3205 } 3206 } 3207 ``` 3208 3209 ### Parameters 3210 3211 | Name | Type | Description | Notes | 3212 |------------- | ------------- | ------------- | -------------| 3213 | **loginInformation** | [**LoginInformation**](LoginInformation.md)| | [optional] | 3214 3215 ### Return type 3216 3217 [**AuthenticationToken**](AuthenticationToken.md) 3218 3219 ### Authorization 3220 3221 No authorization required 3222 3223 ### HTTP request headers 3224 3225 - **Content-Type**: application/json 3226 - **Accept**: application/json 3227 3228 ### HTTP response details 3229 | Status code | Description | Response headers | 3230 |-------------|-------------|------------------| 3231 | **200** | successful login | * Set-Cookie - <br> | 3232 | **401** | Unauthorized | - | 3233 | **420** | too many requests | - | 3234 | **0** | Internal Server Error | - | 3235 3236 <a id="setGroupACL"></a> 3237 # **setGroupACL** 3238 > setGroupACL(groupId, ACL).execute(); 3239 3240 set ACL of group 3241 3242 ### Example 3243 ```java 3244 // Import classes: 3245 import io.lakefs.clients.sdk.ApiClient; 3246 import io.lakefs.clients.sdk.ApiException; 3247 import io.lakefs.clients.sdk.Configuration; 3248 import io.lakefs.clients.sdk.auth.*; 3249 import io.lakefs.clients.sdk.models.*; 3250 import io.lakefs.clients.sdk.AuthApi; 3251 3252 public class Example { 3253 public static void main(String[] args) { 3254 ApiClient defaultClient = Configuration.getDefaultApiClient(); 3255 defaultClient.setBasePath("/api/v1"); 3256 3257 // Configure HTTP basic authorization: basic_auth 3258 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 3259 basic_auth.setUsername("YOUR USERNAME"); 3260 basic_auth.setPassword("YOUR PASSWORD"); 3261 3262 // Configure API key authorization: cookie_auth 3263 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 3264 cookie_auth.setApiKey("YOUR API KEY"); 3265 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 3266 //cookie_auth.setApiKeyPrefix("Token"); 3267 3268 // Configure API key authorization: oidc_auth 3269 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 3270 oidc_auth.setApiKey("YOUR API KEY"); 3271 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 3272 //oidc_auth.setApiKeyPrefix("Token"); 3273 3274 // Configure API key authorization: saml_auth 3275 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 3276 saml_auth.setApiKey("YOUR API KEY"); 3277 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 3278 //saml_auth.setApiKeyPrefix("Token"); 3279 3280 // Configure HTTP bearer authorization: jwt_token 3281 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 3282 jwt_token.setBearerToken("BEARER TOKEN"); 3283 3284 AuthApi apiInstance = new AuthApi(defaultClient); 3285 String groupId = "groupId_example"; // String | 3286 ACL ACL = new ACL(); // ACL | 3287 try { 3288 apiInstance.setGroupACL(groupId, ACL) 3289 .execute(); 3290 } catch (ApiException e) { 3291 System.err.println("Exception when calling AuthApi#setGroupACL"); 3292 System.err.println("Status code: " + e.getCode()); 3293 System.err.println("Reason: " + e.getResponseBody()); 3294 System.err.println("Response headers: " + e.getResponseHeaders()); 3295 e.printStackTrace(); 3296 } 3297 } 3298 } 3299 ``` 3300 3301 ### Parameters 3302 3303 | Name | Type | Description | Notes | 3304 |------------- | ------------- | ------------- | -------------| 3305 | **groupId** | **String**| | | 3306 | **ACL** | [**ACL**](ACL.md)| | | 3307 3308 ### Return type 3309 3310 null (empty response body) 3311 3312 ### Authorization 3313 3314 [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) 3315 3316 ### HTTP request headers 3317 3318 - **Content-Type**: application/json 3319 - **Accept**: application/json 3320 3321 ### HTTP response details 3322 | Status code | Description | Response headers | 3323 |-------------|-------------|------------------| 3324 | **201** | ACL successfully changed | - | 3325 | **401** | Unauthorized | - | 3326 | **404** | Resource Not Found | - | 3327 | **420** | too many requests | - | 3328 | **0** | Internal Server Error | - | 3329 3330 <a id="updatePolicy"></a> 3331 # **updatePolicy** 3332 > Policy updatePolicy(policyId, policy).execute(); 3333 3334 update policy 3335 3336 ### Example 3337 ```java 3338 // Import classes: 3339 import io.lakefs.clients.sdk.ApiClient; 3340 import io.lakefs.clients.sdk.ApiException; 3341 import io.lakefs.clients.sdk.Configuration; 3342 import io.lakefs.clients.sdk.auth.*; 3343 import io.lakefs.clients.sdk.models.*; 3344 import io.lakefs.clients.sdk.AuthApi; 3345 3346 public class Example { 3347 public static void main(String[] args) { 3348 ApiClient defaultClient = Configuration.getDefaultApiClient(); 3349 defaultClient.setBasePath("/api/v1"); 3350 3351 // Configure HTTP basic authorization: basic_auth 3352 HttpBasicAuth basic_auth = (HttpBasicAuth) defaultClient.getAuthentication("basic_auth"); 3353 basic_auth.setUsername("YOUR USERNAME"); 3354 basic_auth.setPassword("YOUR PASSWORD"); 3355 3356 // Configure API key authorization: cookie_auth 3357 ApiKeyAuth cookie_auth = (ApiKeyAuth) defaultClient.getAuthentication("cookie_auth"); 3358 cookie_auth.setApiKey("YOUR API KEY"); 3359 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 3360 //cookie_auth.setApiKeyPrefix("Token"); 3361 3362 // Configure API key authorization: oidc_auth 3363 ApiKeyAuth oidc_auth = (ApiKeyAuth) defaultClient.getAuthentication("oidc_auth"); 3364 oidc_auth.setApiKey("YOUR API KEY"); 3365 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 3366 //oidc_auth.setApiKeyPrefix("Token"); 3367 3368 // Configure API key authorization: saml_auth 3369 ApiKeyAuth saml_auth = (ApiKeyAuth) defaultClient.getAuthentication("saml_auth"); 3370 saml_auth.setApiKey("YOUR API KEY"); 3371 // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) 3372 //saml_auth.setApiKeyPrefix("Token"); 3373 3374 // Configure HTTP bearer authorization: jwt_token 3375 HttpBearerAuth jwt_token = (HttpBearerAuth) defaultClient.getAuthentication("jwt_token"); 3376 jwt_token.setBearerToken("BEARER TOKEN"); 3377 3378 AuthApi apiInstance = new AuthApi(defaultClient); 3379 String policyId = "policyId_example"; // String | 3380 Policy policy = new Policy(); // Policy | 3381 try { 3382 Policy result = apiInstance.updatePolicy(policyId, policy) 3383 .execute(); 3384 System.out.println(result); 3385 } catch (ApiException e) { 3386 System.err.println("Exception when calling AuthApi#updatePolicy"); 3387 System.err.println("Status code: " + e.getCode()); 3388 System.err.println("Reason: " + e.getResponseBody()); 3389 System.err.println("Response headers: " + e.getResponseHeaders()); 3390 e.printStackTrace(); 3391 } 3392 } 3393 } 3394 ``` 3395 3396 ### Parameters 3397 3398 | Name | Type | Description | Notes | 3399 |------------- | ------------- | ------------- | -------------| 3400 | **policyId** | **String**| | | 3401 | **policy** | [**Policy**](Policy.md)| | | 3402 3403 ### Return type 3404 3405 [**Policy**](Policy.md) 3406 3407 ### Authorization 3408 3409 [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) 3410 3411 ### HTTP request headers 3412 3413 - **Content-Type**: application/json 3414 - **Accept**: application/json 3415 3416 ### HTTP response details 3417 | Status code | Description | Response headers | 3418 |-------------|-------------|------------------| 3419 | **200** | policy | - | 3420 | **400** | Validation Error | - | 3421 | **401** | Unauthorized | - | 3422 | **404** | Resource Not Found | - | 3423 | **420** | too many requests | - | 3424 | **0** | Internal Server Error | - | 3425