|
| 1 | +<!-- markdownlint-disable --> |
| 2 | + |
| 3 | +<a href="https://github.com/ml-tooling/contaxy/blob/main/backend/src/contaxy/clients/auth.py#L0"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a> |
| 4 | + |
| 5 | +# <kbd>module</kbd> `contaxy.clients.auth` |
| 6 | + |
| 7 | + |
| 8 | + |
| 9 | + |
| 10 | + |
| 11 | +--- |
| 12 | + |
| 13 | +<a href="https://github.com/ml-tooling/contaxy/blob/main/backend/src/contaxy/clients/auth.py#L22"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a> |
| 14 | + |
| 15 | +## <kbd>function</kbd> `handle_oauth_error` |
| 16 | + |
| 17 | +```python |
| 18 | +handle_oauth_error(response: Response) → None |
| 19 | +``` |
| 20 | + |
| 21 | + |
| 22 | + |
| 23 | + |
| 24 | + |
| 25 | + |
| 26 | +--- |
| 27 | + |
| 28 | +<a href="https://github.com/ml-tooling/contaxy/blob/main/backend/src/contaxy/clients/auth.py#L31"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a> |
| 29 | + |
| 30 | +## <kbd>class</kbd> `AuthClient` |
| 31 | + |
| 32 | + |
| 33 | + |
| 34 | + |
| 35 | +<a href="https://github.com/ml-tooling/contaxy/blob/main/backend/src/contaxy/clients/auth.py#L32"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a> |
| 36 | + |
| 37 | +### <kbd>method</kbd> `__init__` |
| 38 | + |
| 39 | +```python |
| 40 | +__init__(client: Session) |
| 41 | +``` |
| 42 | + |
| 43 | + |
| 44 | + |
| 45 | + |
| 46 | + |
| 47 | + |
| 48 | + |
| 49 | + |
| 50 | +--- |
| 51 | + |
| 52 | +<a href="https://github.com/ml-tooling/contaxy/blob/main/backend/src/contaxy/clients/auth.py#L64"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a> |
| 53 | + |
| 54 | +### <kbd>method</kbd> `change_password` |
| 55 | + |
| 56 | +```python |
| 57 | +change_password(user_id: str, password: str, request_kwargs: Dict = {}) → None |
| 58 | +``` |
| 59 | + |
| 60 | + |
| 61 | + |
| 62 | + |
| 63 | + |
| 64 | +--- |
| 65 | + |
| 66 | +<a href="https://github.com/ml-tooling/contaxy/blob/main/backend/src/contaxy/clients/auth.py#L35"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a> |
| 67 | + |
| 68 | +### <kbd>method</kbd> `create_token` |
| 69 | + |
| 70 | +```python |
| 71 | +create_token( |
| 72 | + scopes: List[str], |
| 73 | + token_type: TokenType, |
| 74 | + description: Optional[str] = None, |
| 75 | + request_kwargs: Dict = {} |
| 76 | +) → str |
| 77 | +``` |
| 78 | + |
| 79 | + |
| 80 | + |
| 81 | + |
| 82 | + |
| 83 | +--- |
| 84 | + |
| 85 | +<a href="https://github.com/ml-tooling/contaxy/blob/main/backend/src/contaxy/clients/auth.py#L121"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a> |
| 86 | + |
| 87 | +### <kbd>method</kbd> `create_user` |
| 88 | + |
| 89 | +```python |
| 90 | +create_user( |
| 91 | + user_input: UserRegistration, |
| 92 | + technical_user: bool = False, |
| 93 | + request_kwargs: Dict = {} |
| 94 | +) → User |
| 95 | +``` |
| 96 | + |
| 97 | + |
| 98 | + |
| 99 | + |
| 100 | + |
| 101 | +--- |
| 102 | + |
| 103 | +<a href="https://github.com/ml-tooling/contaxy/blob/main/backend/src/contaxy/clients/auth.py#L152"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a> |
| 104 | + |
| 105 | +### <kbd>method</kbd> `delete_user` |
| 106 | + |
| 107 | +```python |
| 108 | +delete_user(user_id: str, request_kwargs: Dict = {}) → None |
| 109 | +``` |
| 110 | + |
| 111 | + |
| 112 | + |
| 113 | + |
| 114 | + |
| 115 | +--- |
| 116 | + |
| 117 | +<a href="https://github.com/ml-tooling/contaxy/blob/main/backend/src/contaxy/clients/auth.py#L136"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a> |
| 118 | + |
| 119 | +### <kbd>method</kbd> `get_user` |
| 120 | + |
| 121 | +```python |
| 122 | +get_user(user_id: str, request_kwargs: Dict = {}) → User |
| 123 | +``` |
| 124 | + |
| 125 | + |
| 126 | + |
| 127 | + |
| 128 | + |
| 129 | +--- |
| 130 | + |
| 131 | +<a href="https://github.com/ml-tooling/contaxy/blob/main/backend/src/contaxy/clients/auth.py#L102"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a> |
| 132 | + |
| 133 | +### <kbd>method</kbd> `introspect_token` |
| 134 | + |
| 135 | +```python |
| 136 | +introspect_token( |
| 137 | + token: str, |
| 138 | + request_kwargs: Dict = {} |
| 139 | +) → OAuthTokenIntrospection |
| 140 | +``` |
| 141 | + |
| 142 | + |
| 143 | + |
| 144 | + |
| 145 | + |
| 146 | +--- |
| 147 | + |
| 148 | +<a href="https://github.com/ml-tooling/contaxy/blob/main/backend/src/contaxy/clients/auth.py#L49"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a> |
| 149 | + |
| 150 | +### <kbd>method</kbd> `list_api_tokens` |
| 151 | + |
| 152 | +```python |
| 153 | +list_api_tokens(request_kwargs: Dict = {}) → List[ApiToken] |
| 154 | +``` |
| 155 | + |
| 156 | + |
| 157 | + |
| 158 | + |
| 159 | + |
| 160 | +--- |
| 161 | + |
| 162 | +<a href="https://github.com/ml-tooling/contaxy/blob/main/backend/src/contaxy/clients/auth.py#L116"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a> |
| 163 | + |
| 164 | +### <kbd>method</kbd> `list_users` |
| 165 | + |
| 166 | +```python |
| 167 | +list_users(request_kwargs: Dict = {}) → List[User] |
| 168 | +``` |
| 169 | + |
| 170 | + |
| 171 | + |
| 172 | + |
| 173 | + |
| 174 | +--- |
| 175 | + |
| 176 | +<a href="https://github.com/ml-tooling/contaxy/blob/main/backend/src/contaxy/clients/auth.py#L74"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a> |
| 177 | + |
| 178 | +### <kbd>method</kbd> `request_token` |
| 179 | + |
| 180 | +```python |
| 181 | +request_token( |
| 182 | + token_request_form: OAuth2TokenRequestFormNew, |
| 183 | + request_kwargs: Dict = {} |
| 184 | +) → OAuthToken |
| 185 | +``` |
| 186 | + |
| 187 | + |
| 188 | + |
| 189 | + |
| 190 | + |
| 191 | +--- |
| 192 | + |
| 193 | +<a href="https://github.com/ml-tooling/contaxy/blob/main/backend/src/contaxy/clients/auth.py#L90"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a> |
| 194 | + |
| 195 | +### <kbd>method</kbd> `revoke_token` |
| 196 | + |
| 197 | +```python |
| 198 | +revoke_token(token: str, request_kwargs: Dict = {}) → None |
| 199 | +``` |
| 200 | + |
| 201 | + |
| 202 | + |
| 203 | + |
| 204 | + |
| 205 | +--- |
| 206 | + |
| 207 | +<a href="https://github.com/ml-tooling/contaxy/blob/main/backend/src/contaxy/clients/auth.py#L141"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a> |
| 208 | + |
| 209 | +### <kbd>method</kbd> `update_user` |
| 210 | + |
| 211 | +```python |
| 212 | +update_user( |
| 213 | + user_id: str, |
| 214 | + user_input: UserInput, |
| 215 | + request_kwargs: Dict = {} |
| 216 | +) → User |
| 217 | +``` |
| 218 | + |
| 219 | + |
| 220 | + |
| 221 | + |
| 222 | + |
| 223 | +--- |
| 224 | + |
| 225 | +<a href="https://github.com/ml-tooling/contaxy/blob/main/backend/src/contaxy/clients/auth.py#L54"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a> |
| 226 | + |
| 227 | +### <kbd>method</kbd> `verify_access` |
| 228 | + |
| 229 | +```python |
| 230 | +verify_access( |
| 231 | + token: str, |
| 232 | + permission: Optional[str] = None, |
| 233 | + disable_cache: bool = False, |
| 234 | + request_kwargs: Dict = {} |
| 235 | +) → AuthorizedAccess |
| 236 | +``` |
| 237 | + |
| 238 | + |
| 239 | + |
| 240 | + |
| 241 | + |
| 242 | + |
| 243 | + |
| 244 | + |
| 245 | +--- |
| 246 | + |
| 247 | +_This file was automatically generated via [lazydocs](https://github.com/ml-tooling/lazydocs)._ |
0 commit comments