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