GlpiOAuthClient
OAuth2 Clients Clients for the GLPI 11 high-level API (/api.php).
GlpiOAuthClient
glpi_utils.oauth.GlpiOAuthClient
¶
Synchronous OAuth2 client for the GLPI 11/12 High-level API (/api.php).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
url
|
str or None
|
Base URL, e.g. |
None
|
client_id
|
str or None
|
OAuth2 client ID. Falls back to |
None
|
client_secret
|
str or None
|
OAuth2 client secret. Falls back to |
None
|
verify_ssl
|
bool
|
Verify TLS certificates (default: |
True
|
timeout
|
int
|
HTTP timeout in seconds (default: |
30
|
api_version
|
str or None
|
High-Level API version to pin, e.g. |
None
|
Source code in glpi_utils/oauth.py
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 | |
api_version
property
¶
Pinned HL API version prefix (e.g. "v3.0"), or None.
close
¶
item
¶
Return an :class:~glpi_utils._resource.ItemProxy for any itemtype.
Source code in glpi_utils/oauth.py
authenticate
¶
Obtain an OAuth2 Bearer token.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
username
|
str or None
|
If provided (along with password), uses the |
None
|
password
|
str or None
|
|
None
|
Source code in glpi_utils/oauth.py
get_version
¶
Fetch and cache the GLPI server version.
Reads GET /Setup/Config/core/version (needs read access to the
general setup); the API root does not expose the GLPI version.
Source code in glpi_utils/oauth.py
get_api_versions
¶
Return the API versions the server offers (GET /api.php/).
Each entry has api_version (major), version and endpoint.
GLPI 11 lists 1.0.0 and 2.0.0-2.3.0; GLPI 12 lists 1.0.0, 2.3.0 and 3.0.0.
Source code in glpi_utils/oauth.py
get_item
¶
Return a single item by ID.
get_all_items
¶
Return a single page of items (start/limit; range="a-b" is translated).
Source code in glpi_utils/oauth.py
get_all_pages
¶
Fetch all items across all pages automatically.
Source code in glpi_utils/oauth.py
iter_pages
¶
Yield one page of items at a time.
Source code in glpi_utils/oauth.py
search
¶
Search a collection with an RSQL filter, e.g. "name=like=*srv*;status.id==1".
Extra kwargs (start, limit, sort) are passed as query parameters.
Source code in glpi_utils/oauth.py
create_item
¶
Create one or several items.
Source code in glpi_utils/oauth.py
update_item
¶
Update one or several items.
Source code in glpi_utils/oauth.py
delete_item
¶
delete_item(itemtype: str, input_data: Any, force_purge: bool = False, history: bool = True) -> list[Any]
Delete one or several items.
Source code in glpi_utils/oauth.py
get_sub_items
¶
Return sub-items of a parent item.
Source code in glpi_utils/oauth.py
add_sub_item
¶
add_sub_item(itemtype: str, item_id: int, sub_itemtype: str, input_data: dict[str, Any], **kwargs: Any) -> dict[str, Any]
Add a sub-item to a parent resource.
Source code in glpi_utils/oauth.py
AsyncGlpiOAuthClient
glpi_utils.oauth.AsyncGlpiOAuthClient
¶
Asynchronous OAuth2 client for the GLPI 11/12 High-level API (/api.php).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
url
|
str or None
|
|
None
|
client_id
|
str or None
|
|
None
|
client_secret
|
str or None
|
|
None
|
verify_ssl
|
bool
|
|
True
|
timeout
|
int
|
|
30
|
api_version
|
str or None
|
See :class: |
None
|
Examples:
::
async with AsyncGlpiOAuthClient(
url="https://glpi.example.com",
client_id="my-app",
client_secret="secret",
) as api:
await api.authenticate()
tickets = await api.ticket.get_all_pages()
Source code in glpi_utils/oauth.py
715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 | |
api_version
property
¶
Pinned HL API version prefix (e.g. "v3.0"), or None.
close
async
¶
authenticate
async
¶
Obtain an OAuth2 Bearer token asynchronously.
Source code in glpi_utils/oauth.py
get_version
async
¶
Fetch and cache the GLPI server version (GET /Setup/Config/core/version).
Source code in glpi_utils/oauth.py
get_api_versions
async
¶
Return the API versions the server offers (GET /api.php/).