crc-pulpcore-client 20250819.1__py3-none-any.whl → 20250820.1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of crc-pulpcore-client might be problematic. Click here for more details.

Files changed (239) hide show
  1. crc-pulpcore-client/api_client.py +1 -1
  2. crc-pulpcore-client/configuration.py +3 -3
  3. crc-pulpcore-client/models/artifact_distribution_response.py +17 -17
  4. {crc_pulpcore_client-20250819.1.dist-info → crc_pulpcore_client-20250820.1.dist-info}/METADATA +1 -1
  5. crc_pulpcore_client-20250820.1.dist-info/RECORD +234 -0
  6. crc_pulpcore_client-20250820.1.dist-info/top_level.txt +1 -0
  7. crc_pulpcore_client-20250819.1.dist-info/RECORD +0 -464
  8. crc_pulpcore_client-20250819.1.dist-info/top_level.txt +0 -2
  9. services-pulpcore-client/__init__.py +0 -2
  10. services-pulpcore-client/api/__init__.py +0 -53
  11. services-pulpcore-client/api/access_policies_api.py +0 -1864
  12. services-pulpcore-client/api/artifacts_api.py +0 -1615
  13. services-pulpcore-client/api/content_api.py +0 -598
  14. services-pulpcore-client/api/content_openpgp_publickey_api.py +0 -1887
  15. services-pulpcore-client/api/content_openpgp_publicsubkey_api.py +0 -1518
  16. services-pulpcore-client/api/content_openpgp_signature_api.py +0 -1518
  17. services-pulpcore-client/api/content_openpgp_userattribute_api.py +0 -1518
  18. services-pulpcore-client/api/content_openpgp_userid_api.py +0 -1655
  19. services-pulpcore-client/api/contentguards_api.py +0 -667
  20. services-pulpcore-client/api/contentguards_composite_api.py +0 -3401
  21. services-pulpcore-client/api/contentguards_content_redirect_api.py +0 -3401
  22. services-pulpcore-client/api/contentguards_header_api.py +0 -3401
  23. services-pulpcore-client/api/contentguards_rbac_api.py +0 -3401
  24. services-pulpcore-client/api/distributions_api.py +0 -822
  25. services-pulpcore-client/api/distributions_artifacts_api.py +0 -1103
  26. services-pulpcore-client/api/distributions_openpgp_api.py +0 -2676
  27. services-pulpcore-client/api/domains_api.py +0 -3106
  28. services-pulpcore-client/api/exporters_filesystem_api.py +0 -2157
  29. services-pulpcore-client/api/exporters_filesystem_exports_api.py +0 -1288
  30. services-pulpcore-client/api/exporters_pulp_api.py +0 -2157
  31. services-pulpcore-client/api/exporters_pulp_exports_api.py +0 -1288
  32. services-pulpcore-client/api/groups_api.py +0 -3368
  33. services-pulpcore-client/api/groups_roles_api.py +0 -1496
  34. services-pulpcore-client/api/groups_users_api.py +0 -972
  35. services-pulpcore-client/api/importers_pulp_api.py +0 -2149
  36. services-pulpcore-client/api/importers_pulp_import_check_api.py +0 -350
  37. services-pulpcore-client/api/importers_pulp_imports_api.py +0 -1288
  38. services-pulpcore-client/api/livez_api.py +0 -329
  39. services-pulpcore-client/api/login_api.py +0 -897
  40. services-pulpcore-client/api/orphans_api.py +0 -319
  41. services-pulpcore-client/api/orphans_cleanup_api.py +0 -350
  42. services-pulpcore-client/api/publications_api.py +0 -765
  43. services-pulpcore-client/api/remotes_api.py +0 -850
  44. services-pulpcore-client/api/repair_api.py +0 -350
  45. services-pulpcore-client/api/repositories_api.py +0 -872
  46. services-pulpcore-client/api/repositories_openpgp_keyring_api.py +0 -4546
  47. services-pulpcore-client/api/repositories_reclaim_space_api.py +0 -350
  48. services-pulpcore-client/api/repository_versions_api.py +0 -764
  49. services-pulpcore-client/api/roles_api.py +0 -2269
  50. services-pulpcore-client/api/signing_services_api.py +0 -811
  51. services-pulpcore-client/api/status_api.py +0 -337
  52. services-pulpcore-client/api/task_groups_api.py +0 -1012
  53. services-pulpcore-client/api/task_schedules_api.py +0 -2114
  54. services-pulpcore-client/api/tasks_api.py +0 -4299
  55. services-pulpcore-client/api/uploads_api.py +0 -3346
  56. services-pulpcore-client/api/upstream_pulps_api.py +0 -4001
  57. services-pulpcore-client/api/users_api.py +0 -2373
  58. services-pulpcore-client/api/users_roles_api.py +0 -1496
  59. services-pulpcore-client/api/workers_api.py +0 -1148
  60. services-pulpcore-client/api_client.py +0 -798
  61. services-pulpcore-client/api_response.py +0 -21
  62. services-pulpcore-client/configuration.py +0 -628
  63. services-pulpcore-client/exceptions.py +0 -200
  64. services-pulpcore-client/models/__init__.py +0 -189
  65. services-pulpcore-client/models/access_policy.py +0 -94
  66. services-pulpcore-client/models/access_policy_response.py +0 -119
  67. services-pulpcore-client/models/api_app_status_response.py +0 -99
  68. services-pulpcore-client/models/artifact_distribution_response.py +0 -126
  69. services-pulpcore-client/models/artifact_response.py +0 -149
  70. services-pulpcore-client/models/async_operation_response.py +0 -88
  71. services-pulpcore-client/models/composite_content_guard.py +0 -98
  72. services-pulpcore-client/models/composite_content_guard_response.py +0 -114
  73. services-pulpcore-client/models/content_app_status_response.py +0 -99
  74. services-pulpcore-client/models/content_guard_response.py +0 -112
  75. services-pulpcore-client/models/content_redirect_content_guard.py +0 -96
  76. services-pulpcore-client/models/content_redirect_content_guard_response.py +0 -112
  77. services-pulpcore-client/models/content_settings_response.py +0 -95
  78. services-pulpcore-client/models/content_summary_response.py +0 -92
  79. services-pulpcore-client/models/database_connection_response.py +0 -88
  80. services-pulpcore-client/models/distribution_response.py +0 -133
  81. services-pulpcore-client/models/domain.py +0 -114
  82. services-pulpcore-client/models/domain_backend_migrator.py +0 -91
  83. services-pulpcore-client/models/domain_response.py +0 -131
  84. services-pulpcore-client/models/evaluation_response.py +0 -92
  85. services-pulpcore-client/models/filesystem_export.py +0 -99
  86. services-pulpcore-client/models/filesystem_export_response.py +0 -118
  87. services-pulpcore-client/models/filesystem_exporter.py +0 -94
  88. services-pulpcore-client/models/filesystem_exporter_response.py +0 -110
  89. services-pulpcore-client/models/generic_remote_response.py +0 -199
  90. services-pulpcore-client/models/generic_remote_response_hidden_fields_inner.py +0 -90
  91. services-pulpcore-client/models/generic_remote_response_policy_enum.py +0 -39
  92. services-pulpcore-client/models/group.py +0 -89
  93. services-pulpcore-client/models/group_progress_report_response.py +0 -111
  94. services-pulpcore-client/models/group_response.py +0 -101
  95. services-pulpcore-client/models/group_role.py +0 -110
  96. services-pulpcore-client/models/group_role_response.py +0 -134
  97. services-pulpcore-client/models/group_user.py +0 -89
  98. services-pulpcore-client/models/group_user_response.py +0 -97
  99. services-pulpcore-client/models/header_content_guard.py +0 -107
  100. services-pulpcore-client/models/header_content_guard_response.py +0 -123
  101. services-pulpcore-client/models/import_response.py +0 -107
  102. services-pulpcore-client/models/login_response.py +0 -98
  103. services-pulpcore-client/models/method_enum.py +0 -39
  104. services-pulpcore-client/models/minimal_task_response.py +0 -125
  105. services-pulpcore-client/models/multiple_artifact_content_response.py +0 -107
  106. services-pulpcore-client/models/my_permissions_response.py +0 -88
  107. services-pulpcore-client/models/nested_open_pgp_public_subkey.py +0 -92
  108. services-pulpcore-client/models/nested_open_pgp_public_subkey_response.py +0 -104
  109. services-pulpcore-client/models/nested_open_pgp_signature.py +0 -120
  110. services-pulpcore-client/models/nested_open_pgp_signature_response.py +0 -124
  111. services-pulpcore-client/models/nested_open_pgp_user_attribute.py +0 -89
  112. services-pulpcore-client/models/nested_open_pgp_user_attribute_response.py +0 -101
  113. services-pulpcore-client/models/nested_open_pgp_user_id.py +0 -89
  114. services-pulpcore-client/models/nested_open_pgp_user_id_response.py +0 -100
  115. services-pulpcore-client/models/nested_role.py +0 -93
  116. services-pulpcore-client/models/nested_role_response.py +0 -92
  117. services-pulpcore-client/models/object_roles_response.py +0 -96
  118. services-pulpcore-client/models/open_pgp_distribution.py +0 -116
  119. services-pulpcore-client/models/open_pgp_distribution_response.py +0 -140
  120. services-pulpcore-client/models/open_pgp_keyring.py +0 -112
  121. services-pulpcore-client/models/open_pgp_keyring_response.py +0 -137
  122. services-pulpcore-client/models/open_pgp_public_key_response.py +0 -150
  123. services-pulpcore-client/models/open_pgp_public_subkey_response.py +0 -126
  124. services-pulpcore-client/models/open_pgp_signature_response.py +0 -146
  125. services-pulpcore-client/models/open_pgp_user_attribute_response.py +0 -124
  126. services-pulpcore-client/models/open_pgp_user_id_response.py +0 -123
  127. services-pulpcore-client/models/orphans_cleanup.py +0 -96
  128. services-pulpcore-client/models/paginated_access_policy_response_list.py +0 -112
  129. services-pulpcore-client/models/paginated_artifact_distribution_response_list.py +0 -112
  130. services-pulpcore-client/models/paginated_artifact_response_list.py +0 -112
  131. services-pulpcore-client/models/paginated_composite_content_guard_response_list.py +0 -112
  132. services-pulpcore-client/models/paginated_content_guard_response_list.py +0 -112
  133. services-pulpcore-client/models/paginated_content_redirect_content_guard_response_list.py +0 -112
  134. services-pulpcore-client/models/paginated_distribution_response_list.py +0 -112
  135. services-pulpcore-client/models/paginated_domain_response_list.py +0 -112
  136. services-pulpcore-client/models/paginated_filesystem_export_response_list.py +0 -112
  137. services-pulpcore-client/models/paginated_filesystem_exporter_response_list.py +0 -112
  138. services-pulpcore-client/models/paginated_generic_remote_response_list.py +0 -112
  139. services-pulpcore-client/models/paginated_group_response_list.py +0 -112
  140. services-pulpcore-client/models/paginated_group_role_response_list.py +0 -112
  141. services-pulpcore-client/models/paginated_group_user_response_list.py +0 -112
  142. services-pulpcore-client/models/paginated_header_content_guard_response_list.py +0 -112
  143. services-pulpcore-client/models/paginated_import_response_list.py +0 -112
  144. services-pulpcore-client/models/paginated_multiple_artifact_content_response_list.py +0 -112
  145. services-pulpcore-client/models/paginated_open_pgp_distribution_response_list.py +0 -112
  146. services-pulpcore-client/models/paginated_open_pgp_keyring_response_list.py +0 -112
  147. services-pulpcore-client/models/paginated_open_pgp_public_key_response_list.py +0 -112
  148. services-pulpcore-client/models/paginated_open_pgp_public_subkey_response_list.py +0 -112
  149. services-pulpcore-client/models/paginated_open_pgp_signature_response_list.py +0 -112
  150. services-pulpcore-client/models/paginated_open_pgp_user_attribute_response_list.py +0 -112
  151. services-pulpcore-client/models/paginated_open_pgp_user_id_response_list.py +0 -112
  152. services-pulpcore-client/models/paginated_publication_response_list.py +0 -112
  153. services-pulpcore-client/models/paginated_pulp_export_response_list.py +0 -112
  154. services-pulpcore-client/models/paginated_pulp_exporter_response_list.py +0 -112
  155. services-pulpcore-client/models/paginated_pulp_importer_response_list.py +0 -112
  156. services-pulpcore-client/models/paginated_rbac_content_guard_response_list.py +0 -112
  157. services-pulpcore-client/models/paginated_repository_response_list.py +0 -112
  158. services-pulpcore-client/models/paginated_repository_version_response_list.py +0 -112
  159. services-pulpcore-client/models/paginated_role_response_list.py +0 -112
  160. services-pulpcore-client/models/paginated_signing_service_response_list.py +0 -112
  161. services-pulpcore-client/models/paginated_task_group_response_list.py +0 -112
  162. services-pulpcore-client/models/paginated_task_response_list.py +0 -112
  163. services-pulpcore-client/models/paginated_task_schedule_response_list.py +0 -112
  164. services-pulpcore-client/models/paginated_upload_response_list.py +0 -112
  165. services-pulpcore-client/models/paginated_upstream_pulp_response_list.py +0 -112
  166. services-pulpcore-client/models/paginated_user_response_list.py +0 -112
  167. services-pulpcore-client/models/paginated_user_role_response_list.py +0 -112
  168. services-pulpcore-client/models/paginated_worker_response_list.py +0 -112
  169. services-pulpcore-client/models/patched_access_policy.py +0 -94
  170. services-pulpcore-client/models/patched_composite_content_guard.py +0 -98
  171. services-pulpcore-client/models/patched_content_redirect_content_guard.py +0 -96
  172. services-pulpcore-client/models/patched_domain.py +0 -117
  173. services-pulpcore-client/models/patched_filesystem_exporter.py +0 -94
  174. services-pulpcore-client/models/patched_group.py +0 -89
  175. services-pulpcore-client/models/patched_header_content_guard.py +0 -107
  176. services-pulpcore-client/models/patched_open_pgp_distribution.py +0 -116
  177. services-pulpcore-client/models/patched_open_pgp_keyring.py +0 -112
  178. services-pulpcore-client/models/patched_pulp_exporter.py +0 -100
  179. services-pulpcore-client/models/patched_pulp_importer.py +0 -91
  180. services-pulpcore-client/models/patched_rbac_content_guard.py +0 -96
  181. services-pulpcore-client/models/patched_role.py +0 -98
  182. services-pulpcore-client/models/patched_task_cancel.py +0 -89
  183. services-pulpcore-client/models/patched_upstream_pulp.py +0 -147
  184. services-pulpcore-client/models/patched_user.py +0 -106
  185. services-pulpcore-client/models/policy357_enum.py +0 -39
  186. services-pulpcore-client/models/profile_artifact_response.py +0 -88
  187. services-pulpcore-client/models/progress_report_response.py +0 -115
  188. services-pulpcore-client/models/publication_response.py +0 -107
  189. services-pulpcore-client/models/pulp_export.py +0 -104
  190. services-pulpcore-client/models/pulp_export_response.py +0 -126
  191. services-pulpcore-client/models/pulp_exporter.py +0 -100
  192. services-pulpcore-client/models/pulp_exporter_response.py +0 -116
  193. services-pulpcore-client/models/pulp_import.py +0 -93
  194. services-pulpcore-client/models/pulp_import_check.py +0 -93
  195. services-pulpcore-client/models/pulp_import_check_response.py +0 -102
  196. services-pulpcore-client/models/pulp_importer.py +0 -91
  197. services-pulpcore-client/models/pulp_importer_response.py +0 -107
  198. services-pulpcore-client/models/purge.py +0 -92
  199. services-pulpcore-client/models/rbac_content_guard.py +0 -96
  200. services-pulpcore-client/models/rbac_content_guard_response.py +0 -136
  201. services-pulpcore-client/models/reclaim_space.py +0 -90
  202. services-pulpcore-client/models/redis_connection_response.py +0 -88
  203. services-pulpcore-client/models/repair.py +0 -88
  204. services-pulpcore-client/models/repository_add_remove_content.py +0 -93
  205. services-pulpcore-client/models/repository_response.py +0 -137
  206. services-pulpcore-client/models/repository_version_response.py +0 -121
  207. services-pulpcore-client/models/role.py +0 -98
  208. services-pulpcore-client/models/role_response.py +0 -118
  209. services-pulpcore-client/models/set_label.py +0 -103
  210. services-pulpcore-client/models/set_label_response.py +0 -103
  211. services-pulpcore-client/models/signing_service_response.py +0 -111
  212. services-pulpcore-client/models/states_enum.py +0 -40
  213. services-pulpcore-client/models/status_response.py +0 -152
  214. services-pulpcore-client/models/storage_class_enum.py +0 -40
  215. services-pulpcore-client/models/storage_response.py +0 -108
  216. services-pulpcore-client/models/task_group_operation_response.py +0 -88
  217. services-pulpcore-client/models/task_group_response.py +0 -150
  218. services-pulpcore-client/models/task_response.py +0 -167
  219. services-pulpcore-client/models/task_schedule_response.py +0 -127
  220. services-pulpcore-client/models/unset_label.py +0 -96
  221. services-pulpcore-client/models/unset_label_response.py +0 -100
  222. services-pulpcore-client/models/upload.py +0 -88
  223. services-pulpcore-client/models/upload_chunk_response.py +0 -94
  224. services-pulpcore-client/models/upload_commit.py +0 -89
  225. services-pulpcore-client/models/upload_detail_response.py +0 -121
  226. services-pulpcore-client/models/upload_response.py +0 -109
  227. services-pulpcore-client/models/upstream_pulp.py +0 -147
  228. services-pulpcore-client/models/upstream_pulp_response.py +0 -158
  229. services-pulpcore-client/models/user.py +0 -106
  230. services-pulpcore-client/models/user_group.py +0 -89
  231. services-pulpcore-client/models/user_group_response.py +0 -97
  232. services-pulpcore-client/models/user_response.py +0 -140
  233. services-pulpcore-client/models/user_role.py +0 -110
  234. services-pulpcore-client/models/user_role_response.py +0 -134
  235. services-pulpcore-client/models/version_response.py +0 -96
  236. services-pulpcore-client/models/worker_response.py +0 -119
  237. services-pulpcore-client/py.typed +0 -0
  238. services-pulpcore-client/rest.py +0 -258
  239. {crc_pulpcore_client-20250819.1.dist-info → crc_pulpcore_client-20250820.1.dist-info}/WHEEL +0 -0
@@ -1,1496 +0,0 @@
1
- # coding: utf-8
2
-
3
- """
4
- Pulp 3 API
5
-
6
- Fetch, Upload, Organize, and Distribute Software Packages
7
-
8
- The version of the OpenAPI document: v3
9
- Contact: pulp-list@redhat.com
10
- Generated by OpenAPI Generator (https://openapi-generator.tech)
11
-
12
- Do not edit the class manually.
13
- """ # noqa: E501
14
-
15
- import warnings
16
- from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
17
- from typing import Any, Dict, List, Optional, Tuple, Union
18
- from typing_extensions import Annotated
19
-
20
- from pydantic import Field, StrictInt, StrictStr, field_validator
21
- from typing import List, Optional
22
- from typing_extensions import Annotated
23
- from services-pulpcore-client.models.paginated_user_role_response_list import PaginatedUserRoleResponseList
24
- from services-pulpcore-client.models.user_role import UserRole
25
- from services-pulpcore-client.models.user_role_response import UserRoleResponse
26
-
27
- from services-pulpcore-client.api_client import ApiClient, RequestSerialized
28
- from services-pulpcore-client.api_response import ApiResponse
29
- from services-pulpcore-client.rest import RESTResponseType
30
-
31
-
32
- class UsersRolesApi:
33
- """NOTE: This class is auto generated by OpenAPI Generator
34
- Ref: https://openapi-generator.tech
35
-
36
- Do not edit the class manually.
37
- """
38
-
39
- def __init__(self, api_client=None) -> None:
40
- if api_client is None:
41
- api_client = ApiClient.get_default()
42
- self.api_client = api_client
43
-
44
-
45
- @validate_call
46
- def create(
47
- self,
48
- auth_user_href: StrictStr,
49
- user_role: UserRole,
50
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
51
- _request_timeout: Union[
52
- None,
53
- Annotated[StrictFloat, Field(gt=0)],
54
- Tuple[
55
- Annotated[StrictFloat, Field(gt=0)],
56
- Annotated[StrictFloat, Field(gt=0)]
57
- ]
58
- ] = None,
59
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
60
- _content_type: Optional[StrictStr] = None,
61
- _headers: Optional[Dict[StrictStr, Any]] = None,
62
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
63
- ) -> UserRoleResponse:
64
- """Create an user role
65
-
66
- ViewSet for UserRole.
67
-
68
- :param auth_user_href: (required)
69
- :type auth_user_href: str
70
- :param user_role: (required)
71
- :type user_role: UserRole
72
- :param x_task_diagnostics: List of profilers to use on tasks.
73
- :type x_task_diagnostics: List[str]
74
- :param _request_timeout: timeout setting for this request. If one
75
- number provided, it will be total request
76
- timeout. It can also be a pair (tuple) of
77
- (connection, read) timeouts.
78
- :type _request_timeout: int, tuple(int, int), optional
79
- :param _request_auth: set to override the auth_settings for an a single
80
- request; this effectively ignores the
81
- authentication in the spec for a single request.
82
- :type _request_auth: dict, optional
83
- :param _content_type: force content-type for the request.
84
- :type _content_type: str, Optional
85
- :param _headers: set to override the headers for a single
86
- request; this effectively ignores the headers
87
- in the spec for a single request.
88
- :type _headers: dict, optional
89
- :param _host_index: set to override the host_index for a single
90
- request; this effectively ignores the host_index
91
- in the spec for a single request.
92
- :type _host_index: int, optional
93
- :return: Returns the result object.
94
- """ # noqa: E501
95
-
96
- _param = self._create_serialize(
97
- auth_user_href=auth_user_href,
98
- user_role=user_role,
99
- x_task_diagnostics=x_task_diagnostics,
100
- _request_auth=_request_auth,
101
- _content_type=_content_type,
102
- _headers=_headers,
103
- _host_index=_host_index
104
- )
105
-
106
- _response_types_map: Dict[str, Optional[str]] = {
107
- '201': "UserRoleResponse",
108
- }
109
- response_data = self.api_client.call_api(
110
- *_param,
111
- _request_timeout=_request_timeout
112
- )
113
- response_data.read()
114
- return self.api_client.response_deserialize(
115
- response_data=response_data,
116
- response_types_map=_response_types_map,
117
- ).data
118
-
119
-
120
- @validate_call
121
- def create_with_http_info(
122
- self,
123
- auth_user_href: StrictStr,
124
- user_role: UserRole,
125
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
126
- _request_timeout: Union[
127
- None,
128
- Annotated[StrictFloat, Field(gt=0)],
129
- Tuple[
130
- Annotated[StrictFloat, Field(gt=0)],
131
- Annotated[StrictFloat, Field(gt=0)]
132
- ]
133
- ] = None,
134
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
135
- _content_type: Optional[StrictStr] = None,
136
- _headers: Optional[Dict[StrictStr, Any]] = None,
137
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
138
- ) -> ApiResponse[UserRoleResponse]:
139
- """Create an user role
140
-
141
- ViewSet for UserRole.
142
-
143
- :param auth_user_href: (required)
144
- :type auth_user_href: str
145
- :param user_role: (required)
146
- :type user_role: UserRole
147
- :param x_task_diagnostics: List of profilers to use on tasks.
148
- :type x_task_diagnostics: List[str]
149
- :param _request_timeout: timeout setting for this request. If one
150
- number provided, it will be total request
151
- timeout. It can also be a pair (tuple) of
152
- (connection, read) timeouts.
153
- :type _request_timeout: int, tuple(int, int), optional
154
- :param _request_auth: set to override the auth_settings for an a single
155
- request; this effectively ignores the
156
- authentication in the spec for a single request.
157
- :type _request_auth: dict, optional
158
- :param _content_type: force content-type for the request.
159
- :type _content_type: str, Optional
160
- :param _headers: set to override the headers for a single
161
- request; this effectively ignores the headers
162
- in the spec for a single request.
163
- :type _headers: dict, optional
164
- :param _host_index: set to override the host_index for a single
165
- request; this effectively ignores the host_index
166
- in the spec for a single request.
167
- :type _host_index: int, optional
168
- :return: Returns the result object.
169
- """ # noqa: E501
170
-
171
- _param = self._create_serialize(
172
- auth_user_href=auth_user_href,
173
- user_role=user_role,
174
- x_task_diagnostics=x_task_diagnostics,
175
- _request_auth=_request_auth,
176
- _content_type=_content_type,
177
- _headers=_headers,
178
- _host_index=_host_index
179
- )
180
-
181
- _response_types_map: Dict[str, Optional[str]] = {
182
- '201': "UserRoleResponse",
183
- }
184
- response_data = self.api_client.call_api(
185
- *_param,
186
- _request_timeout=_request_timeout
187
- )
188
- response_data.read()
189
- return self.api_client.response_deserialize(
190
- response_data=response_data,
191
- response_types_map=_response_types_map,
192
- )
193
-
194
-
195
- @validate_call
196
- def create_without_preload_content(
197
- self,
198
- auth_user_href: StrictStr,
199
- user_role: UserRole,
200
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
201
- _request_timeout: Union[
202
- None,
203
- Annotated[StrictFloat, Field(gt=0)],
204
- Tuple[
205
- Annotated[StrictFloat, Field(gt=0)],
206
- Annotated[StrictFloat, Field(gt=0)]
207
- ]
208
- ] = None,
209
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
210
- _content_type: Optional[StrictStr] = None,
211
- _headers: Optional[Dict[StrictStr, Any]] = None,
212
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
213
- ) -> RESTResponseType:
214
- """Create an user role
215
-
216
- ViewSet for UserRole.
217
-
218
- :param auth_user_href: (required)
219
- :type auth_user_href: str
220
- :param user_role: (required)
221
- :type user_role: UserRole
222
- :param x_task_diagnostics: List of profilers to use on tasks.
223
- :type x_task_diagnostics: List[str]
224
- :param _request_timeout: timeout setting for this request. If one
225
- number provided, it will be total request
226
- timeout. It can also be a pair (tuple) of
227
- (connection, read) timeouts.
228
- :type _request_timeout: int, tuple(int, int), optional
229
- :param _request_auth: set to override the auth_settings for an a single
230
- request; this effectively ignores the
231
- authentication in the spec for a single request.
232
- :type _request_auth: dict, optional
233
- :param _content_type: force content-type for the request.
234
- :type _content_type: str, Optional
235
- :param _headers: set to override the headers for a single
236
- request; this effectively ignores the headers
237
- in the spec for a single request.
238
- :type _headers: dict, optional
239
- :param _host_index: set to override the host_index for a single
240
- request; this effectively ignores the host_index
241
- in the spec for a single request.
242
- :type _host_index: int, optional
243
- :return: Returns the result object.
244
- """ # noqa: E501
245
-
246
- _param = self._create_serialize(
247
- auth_user_href=auth_user_href,
248
- user_role=user_role,
249
- x_task_diagnostics=x_task_diagnostics,
250
- _request_auth=_request_auth,
251
- _content_type=_content_type,
252
- _headers=_headers,
253
- _host_index=_host_index
254
- )
255
-
256
- _response_types_map: Dict[str, Optional[str]] = {
257
- '201': "UserRoleResponse",
258
- }
259
- response_data = self.api_client.call_api(
260
- *_param,
261
- _request_timeout=_request_timeout
262
- )
263
- return response_data.response
264
-
265
-
266
- def _create_serialize(
267
- self,
268
- auth_user_href,
269
- user_role,
270
- x_task_diagnostics,
271
- _request_auth,
272
- _content_type,
273
- _headers,
274
- _host_index,
275
- ) -> RequestSerialized:
276
-
277
- _host = None
278
-
279
- _collection_formats: Dict[str, str] = {
280
- 'X-Task-Diagnostics': 'csv',
281
- }
282
-
283
- _path_params: Dict[str, str] = {}
284
- _query_params: List[Tuple[str, str]] = []
285
- _header_params: Dict[str, Optional[str]] = _headers or {}
286
- _form_params: List[Tuple[str, str]] = []
287
- _files: Dict[
288
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
289
- ] = {}
290
- _body_params: Optional[bytes] = None
291
-
292
- # process the path parameters
293
- if auth_user_href is not None:
294
- _path_params['auth_user_href'] = auth_user_href
295
- # process the query parameters
296
- # process the header parameters
297
- if x_task_diagnostics is not None:
298
- _header_params['X-Task-Diagnostics'] = x_task_diagnostics
299
- # process the form parameters
300
- # process the body parameter
301
- if user_role is not None:
302
- _body_params = user_role
303
-
304
-
305
- # set the HTTP header `Accept`
306
- if 'Accept' not in _header_params:
307
- _header_params['Accept'] = self.api_client.select_header_accept(
308
- [
309
- 'application/json'
310
- ]
311
- )
312
-
313
- # set the HTTP header `Content-Type`
314
- if _content_type:
315
- _header_params['Content-Type'] = _content_type
316
- else:
317
- _default_content_type = (
318
- self.api_client.select_header_content_type(
319
- [
320
- 'application/json',
321
- 'application/x-www-form-urlencoded',
322
- 'multipart/form-data'
323
- ]
324
- )
325
- )
326
- if _default_content_type is not None:
327
- _header_params['Content-Type'] = _default_content_type
328
-
329
- # authentication setting
330
- _auth_settings: List[str] = [
331
- 'json_header_remote_authentication',
332
- 'basicAuth',
333
- 'cookieAuth'
334
- ]
335
-
336
- return self.api_client.param_serialize(
337
- method='POST',
338
- resource_path='{auth_user_href}roles/',
339
- path_params=_path_params,
340
- query_params=_query_params,
341
- header_params=_header_params,
342
- body=_body_params,
343
- post_params=_form_params,
344
- files=_files,
345
- auth_settings=_auth_settings,
346
- collection_formats=_collection_formats,
347
- _host=_host,
348
- _request_auth=_request_auth
349
- )
350
-
351
-
352
-
353
-
354
- @validate_call
355
- def delete(
356
- self,
357
- auth_users_user_role_href: StrictStr,
358
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
359
- _request_timeout: Union[
360
- None,
361
- Annotated[StrictFloat, Field(gt=0)],
362
- Tuple[
363
- Annotated[StrictFloat, Field(gt=0)],
364
- Annotated[StrictFloat, Field(gt=0)]
365
- ]
366
- ] = None,
367
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
368
- _content_type: Optional[StrictStr] = None,
369
- _headers: Optional[Dict[StrictStr, Any]] = None,
370
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
371
- ) -> None:
372
- """Delete an user role
373
-
374
- ViewSet for UserRole.
375
-
376
- :param auth_users_user_role_href: (required)
377
- :type auth_users_user_role_href: str
378
- :param x_task_diagnostics: List of profilers to use on tasks.
379
- :type x_task_diagnostics: List[str]
380
- :param _request_timeout: timeout setting for this request. If one
381
- number provided, it will be total request
382
- timeout. It can also be a pair (tuple) of
383
- (connection, read) timeouts.
384
- :type _request_timeout: int, tuple(int, int), optional
385
- :param _request_auth: set to override the auth_settings for an a single
386
- request; this effectively ignores the
387
- authentication in the spec for a single request.
388
- :type _request_auth: dict, optional
389
- :param _content_type: force content-type for the request.
390
- :type _content_type: str, Optional
391
- :param _headers: set to override the headers for a single
392
- request; this effectively ignores the headers
393
- in the spec for a single request.
394
- :type _headers: dict, optional
395
- :param _host_index: set to override the host_index for a single
396
- request; this effectively ignores the host_index
397
- in the spec for a single request.
398
- :type _host_index: int, optional
399
- :return: Returns the result object.
400
- """ # noqa: E501
401
-
402
- _param = self._delete_serialize(
403
- auth_users_user_role_href=auth_users_user_role_href,
404
- x_task_diagnostics=x_task_diagnostics,
405
- _request_auth=_request_auth,
406
- _content_type=_content_type,
407
- _headers=_headers,
408
- _host_index=_host_index
409
- )
410
-
411
- _response_types_map: Dict[str, Optional[str]] = {
412
- '204': None,
413
- }
414
- response_data = self.api_client.call_api(
415
- *_param,
416
- _request_timeout=_request_timeout
417
- )
418
- response_data.read()
419
- return self.api_client.response_deserialize(
420
- response_data=response_data,
421
- response_types_map=_response_types_map,
422
- ).data
423
-
424
-
425
- @validate_call
426
- def delete_with_http_info(
427
- self,
428
- auth_users_user_role_href: StrictStr,
429
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
430
- _request_timeout: Union[
431
- None,
432
- Annotated[StrictFloat, Field(gt=0)],
433
- Tuple[
434
- Annotated[StrictFloat, Field(gt=0)],
435
- Annotated[StrictFloat, Field(gt=0)]
436
- ]
437
- ] = None,
438
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
439
- _content_type: Optional[StrictStr] = None,
440
- _headers: Optional[Dict[StrictStr, Any]] = None,
441
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
442
- ) -> ApiResponse[None]:
443
- """Delete an user role
444
-
445
- ViewSet for UserRole.
446
-
447
- :param auth_users_user_role_href: (required)
448
- :type auth_users_user_role_href: str
449
- :param x_task_diagnostics: List of profilers to use on tasks.
450
- :type x_task_diagnostics: List[str]
451
- :param _request_timeout: timeout setting for this request. If one
452
- number provided, it will be total request
453
- timeout. It can also be a pair (tuple) of
454
- (connection, read) timeouts.
455
- :type _request_timeout: int, tuple(int, int), optional
456
- :param _request_auth: set to override the auth_settings for an a single
457
- request; this effectively ignores the
458
- authentication in the spec for a single request.
459
- :type _request_auth: dict, optional
460
- :param _content_type: force content-type for the request.
461
- :type _content_type: str, Optional
462
- :param _headers: set to override the headers for a single
463
- request; this effectively ignores the headers
464
- in the spec for a single request.
465
- :type _headers: dict, optional
466
- :param _host_index: set to override the host_index for a single
467
- request; this effectively ignores the host_index
468
- in the spec for a single request.
469
- :type _host_index: int, optional
470
- :return: Returns the result object.
471
- """ # noqa: E501
472
-
473
- _param = self._delete_serialize(
474
- auth_users_user_role_href=auth_users_user_role_href,
475
- x_task_diagnostics=x_task_diagnostics,
476
- _request_auth=_request_auth,
477
- _content_type=_content_type,
478
- _headers=_headers,
479
- _host_index=_host_index
480
- )
481
-
482
- _response_types_map: Dict[str, Optional[str]] = {
483
- '204': None,
484
- }
485
- response_data = self.api_client.call_api(
486
- *_param,
487
- _request_timeout=_request_timeout
488
- )
489
- response_data.read()
490
- return self.api_client.response_deserialize(
491
- response_data=response_data,
492
- response_types_map=_response_types_map,
493
- )
494
-
495
-
496
- @validate_call
497
- def delete_without_preload_content(
498
- self,
499
- auth_users_user_role_href: StrictStr,
500
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
501
- _request_timeout: Union[
502
- None,
503
- Annotated[StrictFloat, Field(gt=0)],
504
- Tuple[
505
- Annotated[StrictFloat, Field(gt=0)],
506
- Annotated[StrictFloat, Field(gt=0)]
507
- ]
508
- ] = None,
509
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
510
- _content_type: Optional[StrictStr] = None,
511
- _headers: Optional[Dict[StrictStr, Any]] = None,
512
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
513
- ) -> RESTResponseType:
514
- """Delete an user role
515
-
516
- ViewSet for UserRole.
517
-
518
- :param auth_users_user_role_href: (required)
519
- :type auth_users_user_role_href: str
520
- :param x_task_diagnostics: List of profilers to use on tasks.
521
- :type x_task_diagnostics: List[str]
522
- :param _request_timeout: timeout setting for this request. If one
523
- number provided, it will be total request
524
- timeout. It can also be a pair (tuple) of
525
- (connection, read) timeouts.
526
- :type _request_timeout: int, tuple(int, int), optional
527
- :param _request_auth: set to override the auth_settings for an a single
528
- request; this effectively ignores the
529
- authentication in the spec for a single request.
530
- :type _request_auth: dict, optional
531
- :param _content_type: force content-type for the request.
532
- :type _content_type: str, Optional
533
- :param _headers: set to override the headers for a single
534
- request; this effectively ignores the headers
535
- in the spec for a single request.
536
- :type _headers: dict, optional
537
- :param _host_index: set to override the host_index for a single
538
- request; this effectively ignores the host_index
539
- in the spec for a single request.
540
- :type _host_index: int, optional
541
- :return: Returns the result object.
542
- """ # noqa: E501
543
-
544
- _param = self._delete_serialize(
545
- auth_users_user_role_href=auth_users_user_role_href,
546
- x_task_diagnostics=x_task_diagnostics,
547
- _request_auth=_request_auth,
548
- _content_type=_content_type,
549
- _headers=_headers,
550
- _host_index=_host_index
551
- )
552
-
553
- _response_types_map: Dict[str, Optional[str]] = {
554
- '204': None,
555
- }
556
- response_data = self.api_client.call_api(
557
- *_param,
558
- _request_timeout=_request_timeout
559
- )
560
- return response_data.response
561
-
562
-
563
- def _delete_serialize(
564
- self,
565
- auth_users_user_role_href,
566
- x_task_diagnostics,
567
- _request_auth,
568
- _content_type,
569
- _headers,
570
- _host_index,
571
- ) -> RequestSerialized:
572
-
573
- _host = None
574
-
575
- _collection_formats: Dict[str, str] = {
576
- 'X-Task-Diagnostics': 'csv',
577
- }
578
-
579
- _path_params: Dict[str, str] = {}
580
- _query_params: List[Tuple[str, str]] = []
581
- _header_params: Dict[str, Optional[str]] = _headers or {}
582
- _form_params: List[Tuple[str, str]] = []
583
- _files: Dict[
584
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
585
- ] = {}
586
- _body_params: Optional[bytes] = None
587
-
588
- # process the path parameters
589
- if auth_users_user_role_href is not None:
590
- _path_params['auth_users_user_role_href'] = auth_users_user_role_href
591
- # process the query parameters
592
- # process the header parameters
593
- if x_task_diagnostics is not None:
594
- _header_params['X-Task-Diagnostics'] = x_task_diagnostics
595
- # process the form parameters
596
- # process the body parameter
597
-
598
-
599
-
600
-
601
- # authentication setting
602
- _auth_settings: List[str] = [
603
- 'json_header_remote_authentication',
604
- 'basicAuth',
605
- 'cookieAuth'
606
- ]
607
-
608
- return self.api_client.param_serialize(
609
- method='DELETE',
610
- resource_path='{auth_users_user_role_href}',
611
- path_params=_path_params,
612
- query_params=_query_params,
613
- header_params=_header_params,
614
- body=_body_params,
615
- post_params=_form_params,
616
- files=_files,
617
- auth_settings=_auth_settings,
618
- collection_formats=_collection_formats,
619
- _host=_host,
620
- _request_auth=_request_auth
621
- )
622
-
623
-
624
-
625
-
626
- @validate_call
627
- def list(
628
- self,
629
- auth_user_href: StrictStr,
630
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
631
- content_object: Annotated[Optional[StrictStr], Field(description="content_object")] = None,
632
- domain: Annotated[Optional[StrictStr], Field(description="Foreign Key referenced by HREF")] = None,
633
- limit: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
634
- offset: Annotated[Optional[StrictInt], Field(description="The initial index from which to return the results.")] = None,
635
- ordering: Annotated[Optional[List[StrictStr]], Field(description="Ordering * `role` - Role * `-role` - Role (descending) * `description` - Description * `-description` - Description (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pk` - Pk * `-pk` - Pk (descending)")] = None,
636
- prn__in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
637
- pulp_href__in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
638
- pulp_id__in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
639
- q: Annotated[Optional[StrictStr], Field(description="Filter results by using NOT, AND and OR operations on other filters")] = None,
640
- role: Optional[StrictStr] = None,
641
- role__contains: Optional[StrictStr] = None,
642
- role__icontains: Optional[StrictStr] = None,
643
- role__in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
644
- role__startswith: Optional[StrictStr] = None,
645
- fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to include in the response.")] = None,
646
- exclude_fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to exclude from the response.")] = None,
647
- _request_timeout: Union[
648
- None,
649
- Annotated[StrictFloat, Field(gt=0)],
650
- Tuple[
651
- Annotated[StrictFloat, Field(gt=0)],
652
- Annotated[StrictFloat, Field(gt=0)]
653
- ]
654
- ] = None,
655
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
656
- _content_type: Optional[StrictStr] = None,
657
- _headers: Optional[Dict[StrictStr, Any]] = None,
658
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
659
- ) -> PaginatedUserRoleResponseList:
660
- """List user roles
661
-
662
- ViewSet for UserRole.
663
-
664
- :param auth_user_href: (required)
665
- :type auth_user_href: str
666
- :param x_task_diagnostics: List of profilers to use on tasks.
667
- :type x_task_diagnostics: List[str]
668
- :param content_object: content_object
669
- :type content_object: str
670
- :param domain: Foreign Key referenced by HREF
671
- :type domain: str
672
- :param limit: Number of results to return per page.
673
- :type limit: int
674
- :param offset: The initial index from which to return the results.
675
- :type offset: int
676
- :param ordering: Ordering * `role` - Role * `-role` - Role (descending) * `description` - Description * `-description` - Description (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pk` - Pk * `-pk` - Pk (descending)
677
- :type ordering: List[str]
678
- :param prn__in: Multiple values may be separated by commas.
679
- :type prn__in: List[str]
680
- :param pulp_href__in: Multiple values may be separated by commas.
681
- :type pulp_href__in: List[str]
682
- :param pulp_id__in: Multiple values may be separated by commas.
683
- :type pulp_id__in: List[str]
684
- :param q: Filter results by using NOT, AND and OR operations on other filters
685
- :type q: str
686
- :param role:
687
- :type role: str
688
- :param role__contains:
689
- :type role__contains: str
690
- :param role__icontains:
691
- :type role__icontains: str
692
- :param role__in: Multiple values may be separated by commas.
693
- :type role__in: List[str]
694
- :param role__startswith:
695
- :type role__startswith: str
696
- :param fields: A list of fields to include in the response.
697
- :type fields: List[str]
698
- :param exclude_fields: A list of fields to exclude from the response.
699
- :type exclude_fields: List[str]
700
- :param _request_timeout: timeout setting for this request. If one
701
- number provided, it will be total request
702
- timeout. It can also be a pair (tuple) of
703
- (connection, read) timeouts.
704
- :type _request_timeout: int, tuple(int, int), optional
705
- :param _request_auth: set to override the auth_settings for an a single
706
- request; this effectively ignores the
707
- authentication in the spec for a single request.
708
- :type _request_auth: dict, optional
709
- :param _content_type: force content-type for the request.
710
- :type _content_type: str, Optional
711
- :param _headers: set to override the headers for a single
712
- request; this effectively ignores the headers
713
- in the spec for a single request.
714
- :type _headers: dict, optional
715
- :param _host_index: set to override the host_index for a single
716
- request; this effectively ignores the host_index
717
- in the spec for a single request.
718
- :type _host_index: int, optional
719
- :return: Returns the result object.
720
- """ # noqa: E501
721
-
722
- _param = self._list_serialize(
723
- auth_user_href=auth_user_href,
724
- x_task_diagnostics=x_task_diagnostics,
725
- content_object=content_object,
726
- domain=domain,
727
- limit=limit,
728
- offset=offset,
729
- ordering=ordering,
730
- prn__in=prn__in,
731
- pulp_href__in=pulp_href__in,
732
- pulp_id__in=pulp_id__in,
733
- q=q,
734
- role=role,
735
- role__contains=role__contains,
736
- role__icontains=role__icontains,
737
- role__in=role__in,
738
- role__startswith=role__startswith,
739
- fields=fields,
740
- exclude_fields=exclude_fields,
741
- _request_auth=_request_auth,
742
- _content_type=_content_type,
743
- _headers=_headers,
744
- _host_index=_host_index
745
- )
746
-
747
- _response_types_map: Dict[str, Optional[str]] = {
748
- '200': "PaginatedUserRoleResponseList",
749
- }
750
- response_data = self.api_client.call_api(
751
- *_param,
752
- _request_timeout=_request_timeout
753
- )
754
- response_data.read()
755
- return self.api_client.response_deserialize(
756
- response_data=response_data,
757
- response_types_map=_response_types_map,
758
- ).data
759
-
760
-
761
- @validate_call
762
- def list_with_http_info(
763
- self,
764
- auth_user_href: StrictStr,
765
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
766
- content_object: Annotated[Optional[StrictStr], Field(description="content_object")] = None,
767
- domain: Annotated[Optional[StrictStr], Field(description="Foreign Key referenced by HREF")] = None,
768
- limit: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
769
- offset: Annotated[Optional[StrictInt], Field(description="The initial index from which to return the results.")] = None,
770
- ordering: Annotated[Optional[List[StrictStr]], Field(description="Ordering * `role` - Role * `-role` - Role (descending) * `description` - Description * `-description` - Description (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pk` - Pk * `-pk` - Pk (descending)")] = None,
771
- prn__in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
772
- pulp_href__in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
773
- pulp_id__in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
774
- q: Annotated[Optional[StrictStr], Field(description="Filter results by using NOT, AND and OR operations on other filters")] = None,
775
- role: Optional[StrictStr] = None,
776
- role__contains: Optional[StrictStr] = None,
777
- role__icontains: Optional[StrictStr] = None,
778
- role__in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
779
- role__startswith: Optional[StrictStr] = None,
780
- fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to include in the response.")] = None,
781
- exclude_fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to exclude from the response.")] = None,
782
- _request_timeout: Union[
783
- None,
784
- Annotated[StrictFloat, Field(gt=0)],
785
- Tuple[
786
- Annotated[StrictFloat, Field(gt=0)],
787
- Annotated[StrictFloat, Field(gt=0)]
788
- ]
789
- ] = None,
790
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
791
- _content_type: Optional[StrictStr] = None,
792
- _headers: Optional[Dict[StrictStr, Any]] = None,
793
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
794
- ) -> ApiResponse[PaginatedUserRoleResponseList]:
795
- """List user roles
796
-
797
- ViewSet for UserRole.
798
-
799
- :param auth_user_href: (required)
800
- :type auth_user_href: str
801
- :param x_task_diagnostics: List of profilers to use on tasks.
802
- :type x_task_diagnostics: List[str]
803
- :param content_object: content_object
804
- :type content_object: str
805
- :param domain: Foreign Key referenced by HREF
806
- :type domain: str
807
- :param limit: Number of results to return per page.
808
- :type limit: int
809
- :param offset: The initial index from which to return the results.
810
- :type offset: int
811
- :param ordering: Ordering * `role` - Role * `-role` - Role (descending) * `description` - Description * `-description` - Description (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pk` - Pk * `-pk` - Pk (descending)
812
- :type ordering: List[str]
813
- :param prn__in: Multiple values may be separated by commas.
814
- :type prn__in: List[str]
815
- :param pulp_href__in: Multiple values may be separated by commas.
816
- :type pulp_href__in: List[str]
817
- :param pulp_id__in: Multiple values may be separated by commas.
818
- :type pulp_id__in: List[str]
819
- :param q: Filter results by using NOT, AND and OR operations on other filters
820
- :type q: str
821
- :param role:
822
- :type role: str
823
- :param role__contains:
824
- :type role__contains: str
825
- :param role__icontains:
826
- :type role__icontains: str
827
- :param role__in: Multiple values may be separated by commas.
828
- :type role__in: List[str]
829
- :param role__startswith:
830
- :type role__startswith: str
831
- :param fields: A list of fields to include in the response.
832
- :type fields: List[str]
833
- :param exclude_fields: A list of fields to exclude from the response.
834
- :type exclude_fields: List[str]
835
- :param _request_timeout: timeout setting for this request. If one
836
- number provided, it will be total request
837
- timeout. It can also be a pair (tuple) of
838
- (connection, read) timeouts.
839
- :type _request_timeout: int, tuple(int, int), optional
840
- :param _request_auth: set to override the auth_settings for an a single
841
- request; this effectively ignores the
842
- authentication in the spec for a single request.
843
- :type _request_auth: dict, optional
844
- :param _content_type: force content-type for the request.
845
- :type _content_type: str, Optional
846
- :param _headers: set to override the headers for a single
847
- request; this effectively ignores the headers
848
- in the spec for a single request.
849
- :type _headers: dict, optional
850
- :param _host_index: set to override the host_index for a single
851
- request; this effectively ignores the host_index
852
- in the spec for a single request.
853
- :type _host_index: int, optional
854
- :return: Returns the result object.
855
- """ # noqa: E501
856
-
857
- _param = self._list_serialize(
858
- auth_user_href=auth_user_href,
859
- x_task_diagnostics=x_task_diagnostics,
860
- content_object=content_object,
861
- domain=domain,
862
- limit=limit,
863
- offset=offset,
864
- ordering=ordering,
865
- prn__in=prn__in,
866
- pulp_href__in=pulp_href__in,
867
- pulp_id__in=pulp_id__in,
868
- q=q,
869
- role=role,
870
- role__contains=role__contains,
871
- role__icontains=role__icontains,
872
- role__in=role__in,
873
- role__startswith=role__startswith,
874
- fields=fields,
875
- exclude_fields=exclude_fields,
876
- _request_auth=_request_auth,
877
- _content_type=_content_type,
878
- _headers=_headers,
879
- _host_index=_host_index
880
- )
881
-
882
- _response_types_map: Dict[str, Optional[str]] = {
883
- '200': "PaginatedUserRoleResponseList",
884
- }
885
- response_data = self.api_client.call_api(
886
- *_param,
887
- _request_timeout=_request_timeout
888
- )
889
- response_data.read()
890
- return self.api_client.response_deserialize(
891
- response_data=response_data,
892
- response_types_map=_response_types_map,
893
- )
894
-
895
-
896
- @validate_call
897
- def list_without_preload_content(
898
- self,
899
- auth_user_href: StrictStr,
900
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
901
- content_object: Annotated[Optional[StrictStr], Field(description="content_object")] = None,
902
- domain: Annotated[Optional[StrictStr], Field(description="Foreign Key referenced by HREF")] = None,
903
- limit: Annotated[Optional[StrictInt], Field(description="Number of results to return per page.")] = None,
904
- offset: Annotated[Optional[StrictInt], Field(description="The initial index from which to return the results.")] = None,
905
- ordering: Annotated[Optional[List[StrictStr]], Field(description="Ordering * `role` - Role * `-role` - Role (descending) * `description` - Description * `-description` - Description (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pk` - Pk * `-pk` - Pk (descending)")] = None,
906
- prn__in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
907
- pulp_href__in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
908
- pulp_id__in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
909
- q: Annotated[Optional[StrictStr], Field(description="Filter results by using NOT, AND and OR operations on other filters")] = None,
910
- role: Optional[StrictStr] = None,
911
- role__contains: Optional[StrictStr] = None,
912
- role__icontains: Optional[StrictStr] = None,
913
- role__in: Annotated[Optional[List[StrictStr]], Field(description="Multiple values may be separated by commas.")] = None,
914
- role__startswith: Optional[StrictStr] = None,
915
- fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to include in the response.")] = None,
916
- exclude_fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to exclude from the response.")] = None,
917
- _request_timeout: Union[
918
- None,
919
- Annotated[StrictFloat, Field(gt=0)],
920
- Tuple[
921
- Annotated[StrictFloat, Field(gt=0)],
922
- Annotated[StrictFloat, Field(gt=0)]
923
- ]
924
- ] = None,
925
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
926
- _content_type: Optional[StrictStr] = None,
927
- _headers: Optional[Dict[StrictStr, Any]] = None,
928
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
929
- ) -> RESTResponseType:
930
- """List user roles
931
-
932
- ViewSet for UserRole.
933
-
934
- :param auth_user_href: (required)
935
- :type auth_user_href: str
936
- :param x_task_diagnostics: List of profilers to use on tasks.
937
- :type x_task_diagnostics: List[str]
938
- :param content_object: content_object
939
- :type content_object: str
940
- :param domain: Foreign Key referenced by HREF
941
- :type domain: str
942
- :param limit: Number of results to return per page.
943
- :type limit: int
944
- :param offset: The initial index from which to return the results.
945
- :type offset: int
946
- :param ordering: Ordering * `role` - Role * `-role` - Role (descending) * `description` - Description * `-description` - Description (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pk` - Pk * `-pk` - Pk (descending)
947
- :type ordering: List[str]
948
- :param prn__in: Multiple values may be separated by commas.
949
- :type prn__in: List[str]
950
- :param pulp_href__in: Multiple values may be separated by commas.
951
- :type pulp_href__in: List[str]
952
- :param pulp_id__in: Multiple values may be separated by commas.
953
- :type pulp_id__in: List[str]
954
- :param q: Filter results by using NOT, AND and OR operations on other filters
955
- :type q: str
956
- :param role:
957
- :type role: str
958
- :param role__contains:
959
- :type role__contains: str
960
- :param role__icontains:
961
- :type role__icontains: str
962
- :param role__in: Multiple values may be separated by commas.
963
- :type role__in: List[str]
964
- :param role__startswith:
965
- :type role__startswith: str
966
- :param fields: A list of fields to include in the response.
967
- :type fields: List[str]
968
- :param exclude_fields: A list of fields to exclude from the response.
969
- :type exclude_fields: List[str]
970
- :param _request_timeout: timeout setting for this request. If one
971
- number provided, it will be total request
972
- timeout. It can also be a pair (tuple) of
973
- (connection, read) timeouts.
974
- :type _request_timeout: int, tuple(int, int), optional
975
- :param _request_auth: set to override the auth_settings for an a single
976
- request; this effectively ignores the
977
- authentication in the spec for a single request.
978
- :type _request_auth: dict, optional
979
- :param _content_type: force content-type for the request.
980
- :type _content_type: str, Optional
981
- :param _headers: set to override the headers for a single
982
- request; this effectively ignores the headers
983
- in the spec for a single request.
984
- :type _headers: dict, optional
985
- :param _host_index: set to override the host_index for a single
986
- request; this effectively ignores the host_index
987
- in the spec for a single request.
988
- :type _host_index: int, optional
989
- :return: Returns the result object.
990
- """ # noqa: E501
991
-
992
- _param = self._list_serialize(
993
- auth_user_href=auth_user_href,
994
- x_task_diagnostics=x_task_diagnostics,
995
- content_object=content_object,
996
- domain=domain,
997
- limit=limit,
998
- offset=offset,
999
- ordering=ordering,
1000
- prn__in=prn__in,
1001
- pulp_href__in=pulp_href__in,
1002
- pulp_id__in=pulp_id__in,
1003
- q=q,
1004
- role=role,
1005
- role__contains=role__contains,
1006
- role__icontains=role__icontains,
1007
- role__in=role__in,
1008
- role__startswith=role__startswith,
1009
- fields=fields,
1010
- exclude_fields=exclude_fields,
1011
- _request_auth=_request_auth,
1012
- _content_type=_content_type,
1013
- _headers=_headers,
1014
- _host_index=_host_index
1015
- )
1016
-
1017
- _response_types_map: Dict[str, Optional[str]] = {
1018
- '200': "PaginatedUserRoleResponseList",
1019
- }
1020
- response_data = self.api_client.call_api(
1021
- *_param,
1022
- _request_timeout=_request_timeout
1023
- )
1024
- return response_data.response
1025
-
1026
-
1027
- def _list_serialize(
1028
- self,
1029
- auth_user_href,
1030
- x_task_diagnostics,
1031
- content_object,
1032
- domain,
1033
- limit,
1034
- offset,
1035
- ordering,
1036
- prn__in,
1037
- pulp_href__in,
1038
- pulp_id__in,
1039
- q,
1040
- role,
1041
- role__contains,
1042
- role__icontains,
1043
- role__in,
1044
- role__startswith,
1045
- fields,
1046
- exclude_fields,
1047
- _request_auth,
1048
- _content_type,
1049
- _headers,
1050
- _host_index,
1051
- ) -> RequestSerialized:
1052
-
1053
- _host = None
1054
-
1055
- _collection_formats: Dict[str, str] = {
1056
- 'X-Task-Diagnostics': 'csv',
1057
- 'ordering': 'csv',
1058
- 'prn__in': 'csv',
1059
- 'pulp_href__in': 'csv',
1060
- 'pulp_id__in': 'csv',
1061
- 'role__in': 'csv',
1062
- 'fields': 'multi',
1063
- 'exclude_fields': 'multi',
1064
- }
1065
-
1066
- _path_params: Dict[str, str] = {}
1067
- _query_params: List[Tuple[str, str]] = []
1068
- _header_params: Dict[str, Optional[str]] = _headers or {}
1069
- _form_params: List[Tuple[str, str]] = []
1070
- _files: Dict[
1071
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1072
- ] = {}
1073
- _body_params: Optional[bytes] = None
1074
-
1075
- # process the path parameters
1076
- if auth_user_href is not None:
1077
- _path_params['auth_user_href'] = auth_user_href
1078
- # process the query parameters
1079
- if content_object is not None:
1080
-
1081
- _query_params.append(('content_object', content_object))
1082
-
1083
- if domain is not None:
1084
-
1085
- _query_params.append(('domain', domain))
1086
-
1087
- if limit is not None:
1088
-
1089
- _query_params.append(('limit', limit))
1090
-
1091
- if offset is not None:
1092
-
1093
- _query_params.append(('offset', offset))
1094
-
1095
- if ordering is not None:
1096
-
1097
- _query_params.append(('ordering', ordering))
1098
-
1099
- if prn__in is not None:
1100
-
1101
- _query_params.append(('prn__in', prn__in))
1102
-
1103
- if pulp_href__in is not None:
1104
-
1105
- _query_params.append(('pulp_href__in', pulp_href__in))
1106
-
1107
- if pulp_id__in is not None:
1108
-
1109
- _query_params.append(('pulp_id__in', pulp_id__in))
1110
-
1111
- if q is not None:
1112
-
1113
- _query_params.append(('q', q))
1114
-
1115
- if role is not None:
1116
-
1117
- _query_params.append(('role', role))
1118
-
1119
- if role__contains is not None:
1120
-
1121
- _query_params.append(('role__contains', role__contains))
1122
-
1123
- if role__icontains is not None:
1124
-
1125
- _query_params.append(('role__icontains', role__icontains))
1126
-
1127
- if role__in is not None:
1128
-
1129
- _query_params.append(('role__in', role__in))
1130
-
1131
- if role__startswith is not None:
1132
-
1133
- _query_params.append(('role__startswith', role__startswith))
1134
-
1135
- if fields is not None:
1136
-
1137
- _query_params.append(('fields', fields))
1138
-
1139
- if exclude_fields is not None:
1140
-
1141
- _query_params.append(('exclude_fields', exclude_fields))
1142
-
1143
- # process the header parameters
1144
- if x_task_diagnostics is not None:
1145
- _header_params['X-Task-Diagnostics'] = x_task_diagnostics
1146
- # process the form parameters
1147
- # process the body parameter
1148
-
1149
-
1150
- # set the HTTP header `Accept`
1151
- if 'Accept' not in _header_params:
1152
- _header_params['Accept'] = self.api_client.select_header_accept(
1153
- [
1154
- 'application/json'
1155
- ]
1156
- )
1157
-
1158
-
1159
- # authentication setting
1160
- _auth_settings: List[str] = [
1161
- 'json_header_remote_authentication',
1162
- 'basicAuth',
1163
- 'cookieAuth'
1164
- ]
1165
-
1166
- return self.api_client.param_serialize(
1167
- method='GET',
1168
- resource_path='{auth_user_href}roles/',
1169
- path_params=_path_params,
1170
- query_params=_query_params,
1171
- header_params=_header_params,
1172
- body=_body_params,
1173
- post_params=_form_params,
1174
- files=_files,
1175
- auth_settings=_auth_settings,
1176
- collection_formats=_collection_formats,
1177
- _host=_host,
1178
- _request_auth=_request_auth
1179
- )
1180
-
1181
-
1182
-
1183
-
1184
- @validate_call
1185
- def read(
1186
- self,
1187
- auth_users_user_role_href: StrictStr,
1188
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
1189
- fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to include in the response.")] = None,
1190
- exclude_fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to exclude from the response.")] = None,
1191
- _request_timeout: Union[
1192
- None,
1193
- Annotated[StrictFloat, Field(gt=0)],
1194
- Tuple[
1195
- Annotated[StrictFloat, Field(gt=0)],
1196
- Annotated[StrictFloat, Field(gt=0)]
1197
- ]
1198
- ] = None,
1199
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1200
- _content_type: Optional[StrictStr] = None,
1201
- _headers: Optional[Dict[StrictStr, Any]] = None,
1202
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1203
- ) -> UserRoleResponse:
1204
- """Inspect an user role
1205
-
1206
- ViewSet for UserRole.
1207
-
1208
- :param auth_users_user_role_href: (required)
1209
- :type auth_users_user_role_href: str
1210
- :param x_task_diagnostics: List of profilers to use on tasks.
1211
- :type x_task_diagnostics: List[str]
1212
- :param fields: A list of fields to include in the response.
1213
- :type fields: List[str]
1214
- :param exclude_fields: A list of fields to exclude from the response.
1215
- :type exclude_fields: List[str]
1216
- :param _request_timeout: timeout setting for this request. If one
1217
- number provided, it will be total request
1218
- timeout. It can also be a pair (tuple) of
1219
- (connection, read) timeouts.
1220
- :type _request_timeout: int, tuple(int, int), optional
1221
- :param _request_auth: set to override the auth_settings for an a single
1222
- request; this effectively ignores the
1223
- authentication in the spec for a single request.
1224
- :type _request_auth: dict, optional
1225
- :param _content_type: force content-type for the request.
1226
- :type _content_type: str, Optional
1227
- :param _headers: set to override the headers for a single
1228
- request; this effectively ignores the headers
1229
- in the spec for a single request.
1230
- :type _headers: dict, optional
1231
- :param _host_index: set to override the host_index for a single
1232
- request; this effectively ignores the host_index
1233
- in the spec for a single request.
1234
- :type _host_index: int, optional
1235
- :return: Returns the result object.
1236
- """ # noqa: E501
1237
-
1238
- _param = self._read_serialize(
1239
- auth_users_user_role_href=auth_users_user_role_href,
1240
- x_task_diagnostics=x_task_diagnostics,
1241
- fields=fields,
1242
- exclude_fields=exclude_fields,
1243
- _request_auth=_request_auth,
1244
- _content_type=_content_type,
1245
- _headers=_headers,
1246
- _host_index=_host_index
1247
- )
1248
-
1249
- _response_types_map: Dict[str, Optional[str]] = {
1250
- '200': "UserRoleResponse",
1251
- }
1252
- response_data = self.api_client.call_api(
1253
- *_param,
1254
- _request_timeout=_request_timeout
1255
- )
1256
- response_data.read()
1257
- return self.api_client.response_deserialize(
1258
- response_data=response_data,
1259
- response_types_map=_response_types_map,
1260
- ).data
1261
-
1262
-
1263
- @validate_call
1264
- def read_with_http_info(
1265
- self,
1266
- auth_users_user_role_href: StrictStr,
1267
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
1268
- fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to include in the response.")] = None,
1269
- exclude_fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to exclude from the response.")] = None,
1270
- _request_timeout: Union[
1271
- None,
1272
- Annotated[StrictFloat, Field(gt=0)],
1273
- Tuple[
1274
- Annotated[StrictFloat, Field(gt=0)],
1275
- Annotated[StrictFloat, Field(gt=0)]
1276
- ]
1277
- ] = None,
1278
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1279
- _content_type: Optional[StrictStr] = None,
1280
- _headers: Optional[Dict[StrictStr, Any]] = None,
1281
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1282
- ) -> ApiResponse[UserRoleResponse]:
1283
- """Inspect an user role
1284
-
1285
- ViewSet for UserRole.
1286
-
1287
- :param auth_users_user_role_href: (required)
1288
- :type auth_users_user_role_href: str
1289
- :param x_task_diagnostics: List of profilers to use on tasks.
1290
- :type x_task_diagnostics: List[str]
1291
- :param fields: A list of fields to include in the response.
1292
- :type fields: List[str]
1293
- :param exclude_fields: A list of fields to exclude from the response.
1294
- :type exclude_fields: List[str]
1295
- :param _request_timeout: timeout setting for this request. If one
1296
- number provided, it will be total request
1297
- timeout. It can also be a pair (tuple) of
1298
- (connection, read) timeouts.
1299
- :type _request_timeout: int, tuple(int, int), optional
1300
- :param _request_auth: set to override the auth_settings for an a single
1301
- request; this effectively ignores the
1302
- authentication in the spec for a single request.
1303
- :type _request_auth: dict, optional
1304
- :param _content_type: force content-type for the request.
1305
- :type _content_type: str, Optional
1306
- :param _headers: set to override the headers for a single
1307
- request; this effectively ignores the headers
1308
- in the spec for a single request.
1309
- :type _headers: dict, optional
1310
- :param _host_index: set to override the host_index for a single
1311
- request; this effectively ignores the host_index
1312
- in the spec for a single request.
1313
- :type _host_index: int, optional
1314
- :return: Returns the result object.
1315
- """ # noqa: E501
1316
-
1317
- _param = self._read_serialize(
1318
- auth_users_user_role_href=auth_users_user_role_href,
1319
- x_task_diagnostics=x_task_diagnostics,
1320
- fields=fields,
1321
- exclude_fields=exclude_fields,
1322
- _request_auth=_request_auth,
1323
- _content_type=_content_type,
1324
- _headers=_headers,
1325
- _host_index=_host_index
1326
- )
1327
-
1328
- _response_types_map: Dict[str, Optional[str]] = {
1329
- '200': "UserRoleResponse",
1330
- }
1331
- response_data = self.api_client.call_api(
1332
- *_param,
1333
- _request_timeout=_request_timeout
1334
- )
1335
- response_data.read()
1336
- return self.api_client.response_deserialize(
1337
- response_data=response_data,
1338
- response_types_map=_response_types_map,
1339
- )
1340
-
1341
-
1342
- @validate_call
1343
- def read_without_preload_content(
1344
- self,
1345
- auth_users_user_role_href: StrictStr,
1346
- x_task_diagnostics: Annotated[Optional[List[StrictStr]], Field(description="List of profilers to use on tasks.")] = None,
1347
- fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to include in the response.")] = None,
1348
- exclude_fields: Annotated[Optional[List[StrictStr]], Field(description="A list of fields to exclude from the response.")] = None,
1349
- _request_timeout: Union[
1350
- None,
1351
- Annotated[StrictFloat, Field(gt=0)],
1352
- Tuple[
1353
- Annotated[StrictFloat, Field(gt=0)],
1354
- Annotated[StrictFloat, Field(gt=0)]
1355
- ]
1356
- ] = None,
1357
- _request_auth: Optional[Dict[StrictStr, Any]] = None,
1358
- _content_type: Optional[StrictStr] = None,
1359
- _headers: Optional[Dict[StrictStr, Any]] = None,
1360
- _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1361
- ) -> RESTResponseType:
1362
- """Inspect an user role
1363
-
1364
- ViewSet for UserRole.
1365
-
1366
- :param auth_users_user_role_href: (required)
1367
- :type auth_users_user_role_href: str
1368
- :param x_task_diagnostics: List of profilers to use on tasks.
1369
- :type x_task_diagnostics: List[str]
1370
- :param fields: A list of fields to include in the response.
1371
- :type fields: List[str]
1372
- :param exclude_fields: A list of fields to exclude from the response.
1373
- :type exclude_fields: List[str]
1374
- :param _request_timeout: timeout setting for this request. If one
1375
- number provided, it will be total request
1376
- timeout. It can also be a pair (tuple) of
1377
- (connection, read) timeouts.
1378
- :type _request_timeout: int, tuple(int, int), optional
1379
- :param _request_auth: set to override the auth_settings for an a single
1380
- request; this effectively ignores the
1381
- authentication in the spec for a single request.
1382
- :type _request_auth: dict, optional
1383
- :param _content_type: force content-type for the request.
1384
- :type _content_type: str, Optional
1385
- :param _headers: set to override the headers for a single
1386
- request; this effectively ignores the headers
1387
- in the spec for a single request.
1388
- :type _headers: dict, optional
1389
- :param _host_index: set to override the host_index for a single
1390
- request; this effectively ignores the host_index
1391
- in the spec for a single request.
1392
- :type _host_index: int, optional
1393
- :return: Returns the result object.
1394
- """ # noqa: E501
1395
-
1396
- _param = self._read_serialize(
1397
- auth_users_user_role_href=auth_users_user_role_href,
1398
- x_task_diagnostics=x_task_diagnostics,
1399
- fields=fields,
1400
- exclude_fields=exclude_fields,
1401
- _request_auth=_request_auth,
1402
- _content_type=_content_type,
1403
- _headers=_headers,
1404
- _host_index=_host_index
1405
- )
1406
-
1407
- _response_types_map: Dict[str, Optional[str]] = {
1408
- '200': "UserRoleResponse",
1409
- }
1410
- response_data = self.api_client.call_api(
1411
- *_param,
1412
- _request_timeout=_request_timeout
1413
- )
1414
- return response_data.response
1415
-
1416
-
1417
- def _read_serialize(
1418
- self,
1419
- auth_users_user_role_href,
1420
- x_task_diagnostics,
1421
- fields,
1422
- exclude_fields,
1423
- _request_auth,
1424
- _content_type,
1425
- _headers,
1426
- _host_index,
1427
- ) -> RequestSerialized:
1428
-
1429
- _host = None
1430
-
1431
- _collection_formats: Dict[str, str] = {
1432
- 'X-Task-Diagnostics': 'csv',
1433
- 'fields': 'multi',
1434
- 'exclude_fields': 'multi',
1435
- }
1436
-
1437
- _path_params: Dict[str, str] = {}
1438
- _query_params: List[Tuple[str, str]] = []
1439
- _header_params: Dict[str, Optional[str]] = _headers or {}
1440
- _form_params: List[Tuple[str, str]] = []
1441
- _files: Dict[
1442
- str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1443
- ] = {}
1444
- _body_params: Optional[bytes] = None
1445
-
1446
- # process the path parameters
1447
- if auth_users_user_role_href is not None:
1448
- _path_params['auth_users_user_role_href'] = auth_users_user_role_href
1449
- # process the query parameters
1450
- if fields is not None:
1451
-
1452
- _query_params.append(('fields', fields))
1453
-
1454
- if exclude_fields is not None:
1455
-
1456
- _query_params.append(('exclude_fields', exclude_fields))
1457
-
1458
- # process the header parameters
1459
- if x_task_diagnostics is not None:
1460
- _header_params['X-Task-Diagnostics'] = x_task_diagnostics
1461
- # process the form parameters
1462
- # process the body parameter
1463
-
1464
-
1465
- # set the HTTP header `Accept`
1466
- if 'Accept' not in _header_params:
1467
- _header_params['Accept'] = self.api_client.select_header_accept(
1468
- [
1469
- 'application/json'
1470
- ]
1471
- )
1472
-
1473
-
1474
- # authentication setting
1475
- _auth_settings: List[str] = [
1476
- 'json_header_remote_authentication',
1477
- 'basicAuth',
1478
- 'cookieAuth'
1479
- ]
1480
-
1481
- return self.api_client.param_serialize(
1482
- method='GET',
1483
- resource_path='{auth_users_user_role_href}',
1484
- path_params=_path_params,
1485
- query_params=_query_params,
1486
- header_params=_header_params,
1487
- body=_body_params,
1488
- post_params=_form_params,
1489
- files=_files,
1490
- auth_settings=_auth_settings,
1491
- collection_formats=_collection_formats,
1492
- _host=_host,
1493
- _request_auth=_request_auth
1494
- )
1495
-
1496
-