Skip to content

Commit 85a45ad

Browse files
author
Itai Levi
authored
[TIC-357] Rust library updates (#17)
* feat(org): add arguments to update_org_request (#16) * [TIC-365] Add `create_access_token` request (#15) * feat(create_access_token): create access token service, request/response models * feat(create_access_token): add AccessTokenService, errors for errored response * feat(auth): add access_token function to auth * chore: add comment for what the api is * docs(access_token): add docs for new access_token api, create_access_token * [TIC-364] Add missing argument for `update_user_metadata` request (#13) * feat(user): add argument to update_user_metadata request * docs(update_user_metadata): add missing fields to docs * fix(UpdateMetadataRequest.md): small typo fix * feat(org): add delete_org request (#12) * [TIC-358] Add `clear_password` request (#9) * feat(user): add clear_password request * docs(UserServiceApi.md): add docs for clear_user_password * Bump version number
1 parent 4cfd0c8 commit 85a45ad

22 files changed

+586
-230
lines changed

‎Cargo.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "propelauth"
3-
version = "0.4.0"
3+
version = "0.5.0"
44
authors = ["support@propelauth.com"]
55
description = "A Rust crate for managing authentication and authorization with support for multi-tenant / B2B products, powered by PropelAuth"
66
keywords = ["authentication", "auth", "authorization", "b2b", "tenant"]

‎docs/AccessTokenServiceApi.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# \AccessTokenServiceApi
2+
3+
All URIs are relative to _http://localhost_
4+
5+
| Method | HTTP request | Description |
6+
| ----------------------------------------------------------------------- | ------------------------------------- | ----------- |
7+
| [**create_access_Token**](AccessTokenServiceApi.md#create_access_token) | **POST** /api/backend/v1/access_token |
8+
9+
## create_access_Token
10+
11+
> crate::models::CreateAccessTokenResponse create_access_token(create_access_token_params)
12+
13+
### Parameters
14+
15+
| Name | Type | Description | Notes |
16+
| -------------------------- | -------------------------------------------------------------------------- | ----------- | ----- |
17+
| create_access_token_params | [**crate::models::CreateAccessTokenRequest**](CreateAccessTokenRequest.md) | | |
18+
19+
### Return type
20+
21+
[**crate::models::CreateAccessTokenResponse**](CreateAccessTokenResponse.md)
22+
23+
### Authorization
24+
25+
[BearerAuth](../README.md#BearerAuth)
26+
27+
### HTTP request headers
28+
29+
- **Content-Type**: Not defined
30+
- **Accept**: application/json
31+
32+
[[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)

‎docs/CreateAccessTokenRequest.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# CreateAccessTokenRequest
2+
3+
## Properties
4+
5+
| Name | Type | Description | Notes |
6+
| --------------------------- | -------------------- | ----------- | ----- |
7+
| **user_id** | **String** | |
8+
| **duration_in_minutes** | **u64** | |
9+
| **active_org_id** | **Option\<String\>** | |
10+
| **with_active_org_support** | **bool** | |
11+
12+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

‎docs/CreateAccessTokenResponse.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# CreateAccessTokenResponse
2+
3+
## Properties
4+
5+
| Name | Type | Description | Notes |
6+
| ---------------- | ---------- | ----------- | ----- |
7+
| **access_token** | **String** | |
8+
9+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

‎docs/OrgServiceApi.md‎

Lines changed: 75 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,30 @@
11
# \OrgServiceApi
22

3-
All URIs are relative to *http://localhost*
4-
5-
Method | HTTP request | Description
6-
------------- | ------------- | -------------
7-
[**add_user_to_org**](OrgServiceApi.md#add_user_to_org) | **POST** /api/backend/v1/org/add_user |
8-
[**allow_org_to_enable_saml**](OrgServiceApi.md#allow_org_to_enable_saml) | **POST** /api/backend/v1/org/{org_id}/allow_saml |
9-
[**change_user_role_in_org**](OrgServiceApi.md#change_user_role_in_org) | **POST** /api/backend/v1/org/change_role |
10-
[**create_org**](OrgServiceApi.md#create_org) | **POST** /api/backend/v1/org/ |
11-
[**disallow_saml**](OrgServiceApi.md#disallow_saml) | **POST** /api/backend/v1/org/{org_id}/disallow_saml |
12-
[**fetch_org**](OrgServiceApi.md#fetch_org) | **GET** /api/backend/v1/org/{org_id} |
13-
[**fetch_orgs_by_query**](OrgServiceApi.md#fetch_orgs_by_query) | **GET** /api/backend/v1/org/query |
14-
[**fetch_users_in_org**](OrgServiceApi.md#fetch_users_in_org) | **GET** /api/backend/v1/user/org/{org_id} |
15-
[**remove_user_from_org**](OrgServiceApi.md#remove_user_from_org) | **POST** /api/backend/v1/org/remove_user |
16-
[**update_org**](OrgServiceApi.md#update_org) | **PUT** /api/backend/v1/org/{org_id} |
17-
18-
3+
All URIs are relative to _http://localhost_
4+
5+
| Method | HTTP request | Description |
6+
| ------------------------------------------------------------------------- | --------------------------------------------------- | ----------- |
7+
| [**add_user_to_org**](OrgServiceApi.md#add_user_to_org) | **POST** /api/backend/v1/org/add_user |
8+
| [**allow_org_to_enable_saml**](OrgServiceApi.md#allow_org_to_enable_saml) | **POST** /api/backend/v1/org/{org_id}/allow_saml |
9+
| [**change_user_role_in_org**](OrgServiceApi.md#change_user_role_in_org) | **POST** /api/backend/v1/org/change_role |
10+
| [**create_org**](OrgServiceApi.md#create_org) | **POST** /api/backend/v1/org/ |
11+
| [**disallow_saml**](OrgServiceApi.md#disallow_saml) | **POST** /api/backend/v1/org/{org_id}/disallow_saml |
12+
| [**fetch_org**](OrgServiceApi.md#fetch_org) | **GET** /api/backend/v1/org/{org_id} |
13+
| [**fetch_orgs_by_query**](OrgServiceApi.md#fetch_orgs_by_query) | **GET** /api/backend/v1/org/query |
14+
| [**fetch_users_in_org**](OrgServiceApi.md#fetch_users_in_org) | **GET** /api/backend/v1/user/org/{org_id} |
15+
| [**remove_user_from_org**](OrgServiceApi.md#remove_user_from_org) | **POST** /api/backend/v1/org/remove_user |
16+
| [**update_org**](OrgServiceApi.md#update_org) | **PUT** /api/backend/v1/org/{org_id} |
17+
| [**delete_org**](OrgServiceApi.md#delete_org) | **DELETE** /api/backend/v1/org/{org_id} |
1918

2019
## add_user_to_org
2120

2221
> crate::models::SuccessfulResponse add_user_to_org(add_user_to_org_request)
2322
24-
2523
### Parameters
2624

27-
28-
Name | Type | Description | Required | Notes
29-
------------- | ------------- | ------------- | ------------- | -------------
30-
**add_user_to_org_request** | [**AddUserToOrgRequest**](AddUserToOrgRequest.md) | | [required] |
25+
| Name | Type | Description | Required | Notes |
26+
| --------------------------- | ------------------------------------------------- | ----------- | ---------- | ----- |
27+
| **add_user_to_org_request** | [**AddUserToOrgRequest**](AddUserToOrgRequest.md) | | [required] |
3128

3229
### Return type
3330

@@ -44,18 +41,15 @@ Name | Type | Description | Required | Notes
4441

4542
[[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)
4643

47-
4844
## allow_org_to_enable_saml
4945

5046
> crate::models::SuccessfulResponse allow_org_to_enable_saml(org_id)
5147
52-
5348
### Parameters
5449

55-
56-
Name | Type | Description | Required | Notes
57-
------------- | ------------- | ------------- | ------------- | -------------
58-
**org_id** | **String** | | [required] |
50+
| Name | Type | Description | Required | Notes |
51+
| ---------- | ---------- | ----------- | ---------- | ----- |
52+
| **org_id** | **String** | | [required] |
5953

6054
### Return type
6155

@@ -72,18 +66,15 @@ Name | Type | Description | Required | Notes
7266

7367
[[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)
7468

75-
7669
## change_user_role_in_org
7770

7871
> crate::models::SuccessfulResponse change_user_role_in_org(change_user_role_in_org_request)
7972
80-
8173
### Parameters
8274

83-
84-
Name | Type | Description | Required | Notes
85-
------------- | ------------- | ------------- | ------------- | -------------
86-
**change_user_role_in_org_request** | [**ChangeUserRoleInOrgRequest**](ChangeUserRoleInOrgRequest.md) | | [required] |
75+
| Name | Type | Description | Required | Notes |
76+
| ----------------------------------- | --------------------------------------------------------------- | ----------- | ---------- | ----- |
77+
| **change_user_role_in_org_request** | [**ChangeUserRoleInOrgRequest**](ChangeUserRoleInOrgRequest.md) | | [required] |
8778

8879
### Return type
8980

@@ -100,18 +91,15 @@ Name | Type | Description | Required | Notes
10091

10192
[[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)
10293

103-
10494
## create_org
10595

10696
> crate::models::CreateOrgResponse create_org(create_org_request)
10797
108-
10998
### Parameters
11099

111-
112-
Name | Type | Description | Required | Notes
113-
------------- | ------------- | ------------- | ------------- | -------------
114-
**create_org_request** | [**CreateOrgRequest**](CreateOrgRequest.md) | | [required] |
100+
| Name | Type | Description | Required | Notes |
101+
| ---------------------- | ------------------------------------------- | ----------- | ---------- | ----- |
102+
| **create_org_request** | [**CreateOrgRequest**](CreateOrgRequest.md) | | [required] |
115103

116104
### Return type
117105

@@ -128,18 +116,15 @@ Name | Type | Description | Required | Notes
128116

129117
[[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)
130118

131-
132119
## disallow_saml
133120

134121
> crate::models::SuccessfulResponse disallow_saml(org_id)
135122
136-
137123
### Parameters
138124

139-
140-
Name | Type | Description | Required | Notes
141-
------------- | ------------- | ------------- | ------------- | -------------
142-
**org_id** | **String** | | [required] |
125+
| Name | Type | Description | Required | Notes |
126+
| ---------- | ---------- | ----------- | ---------- | ----- |
127+
| **org_id** | **String** | | [required] |
143128

144129
### Return type
145130

@@ -156,18 +141,15 @@ Name | Type | Description | Required | Notes
156141

157142
[[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)
158143

159-
160144
## fetch_org
161145

162146
> crate::models::FetchOrgResponse fetch_org(org_id)
163147
164-
165148
### Parameters
166149

167-
168-
Name | Type | Description | Required | Notes
169-
------------- | ------------- | ------------- | ------------- | -------------
170-
**org_id** | **String** | | [required] |
150+
| Name | Type | Description | Required | Notes |
151+
| ---------- | ---------- | ----------- | ---------- | ----- |
152+
| **org_id** | **String** | | [required] |
171153

172154
### Return type
173155

@@ -184,20 +166,17 @@ Name | Type | Description | Required | Notes
184166

185167
[[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)
186168

187-
188169
## fetch_orgs_by_query
189170

190171
> crate::models::FetchOrgsResponse fetch_orgs_by_query(page_size, page_number, order_by)
191172
192-
193173
### Parameters
194174

195-
196-
Name | Type | Description | Required | Notes
197-
------------- | ------------- | ------------- | ------------- | -------------
198-
**page_size** | Option<**i64**> | | |
199-
**page_number** | Option<**i64**> | | |
200-
**order_by** | Option<[**FetchOrgOrderBy**](.md)> | | |
175+
| Name | Type | Description | Required | Notes |
176+
| --------------- | ---------------------------------- | ----------- | -------- | ----- |
177+
| **page_size** | Option<**i64**> | | |
178+
| **page_number** | Option<**i64**> | | |
179+
| **order_by** | Option<[**FetchOrgOrderBy**](.md)> | | |
201180

202181
### Return type
203182

@@ -214,21 +193,18 @@ Name | Type | Description | Required | Notes
214193

215194
[[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)
216195

217-
218196
## fetch_users_in_org
219197

220198
> crate::models::UserPagedResponse fetch_users_in_org(org_id, page_size, page_number, include_orgs)
221199
222-
223200
### Parameters
224201

225-
226-
Name | Type | Description | Required | Notes
227-
------------- | ------------- | ------------- | ------------- | -------------
228-
**org_id** | **String** | | [required] |
229-
**page_size** | Option<**i64**> | | |
230-
**page_number** | Option<**i64**> | | |
231-
**include_orgs** | Option<**bool**> | Defaults to false | |
202+
| Name | Type | Description | Required | Notes |
203+
| ---------------- | ---------------- | ----------------- | ---------- | ----- |
204+
| **org_id** | **String** | | [required] |
205+
| **page_size** | Option<**i64**> | | |
206+
| **page_number** | Option<**i64**> | | |
207+
| **include_orgs** | Option<**bool**> | Defaults to false | |
232208

233209
### Return type
234210

@@ -245,18 +221,15 @@ Name | Type | Description | Required | Notes
245221

246222
[[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)
247223

248-
249224
## remove_user_from_org
250225

251226
> crate::models::SuccessfulResponse remove_user_from_org(remove_user_from_org_request)
252227
253-
254228
### Parameters
255229

256-
257-
Name | Type | Description | Required | Notes
258-
------------- | ------------- | ------------- | ------------- | -------------
259-
**remove_user_from_org_request** | [**RemoveUserFromOrgRequest**](RemoveUserFromOrgRequest.md) | | [required] |
230+
| Name | Type | Description | Required | Notes |
231+
| -------------------------------- | ----------------------------------------------------------- | ----------- | ---------- | ----- |
232+
| **remove_user_from_org_request** | [**RemoveUserFromOrgRequest**](RemoveUserFromOrgRequest.md) | | [required] |
260233

261234
### Return type
262235

@@ -273,19 +246,16 @@ Name | Type | Description | Required | Notes
273246

274247
[[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)
275248

276-
277249
## update_org
278250

279251
> crate::models::SuccessfulResponse update_org(org_id, update_org_request)
280252
281-
282253
### Parameters
283254

284-
285-
Name | Type | Description | Required | Notes
286-
------------- | ------------- | ------------- | ------------- | -------------
287-
**org_id** | **String** | | [required] |
288-
**update_org_request** | [**UpdateOrgRequest**](UpdateOrgRequest.md) | | [required] |
255+
| Name | Type | Description | Required | Notes |
256+
| ---------------------- | ------------------------------------------- | ----------- | ---------- | ----- |
257+
| **org_id** | **String** | | [required] |
258+
| **update_org_request** | [**UpdateOrgRequest**](UpdateOrgRequest.md) | | [required] |
289259

290260
### Return type
291261

@@ -302,3 +272,27 @@ Name | Type | Description | Required | Notes
302272

303273
[[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)
304274

275+
## delete_org
276+
277+
> crate::models::SuccessfulResponse delete_org(org_id)
278+
279+
### Parameters
280+
281+
| Name | Type | Description | Required | Notes |
282+
| ---------- | ---------- | ----------- | ---------- | ----- |
283+
| **org_id** | **String** | | [required] |
284+
285+
### Return type
286+
287+
[**crate::models::SuccessfulResponse**](SuccessfulResponse.md)
288+
289+
### Authorization
290+
291+
[BearerAuth](../README.md#BearerAuth)
292+
293+
### HTTP request headers
294+
295+
- **Content-Type**: Not defined
296+
- **Accept**: application/json
297+
298+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models)

‎docs/UpdateMetadataRequest.md‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,14 @@
22

33
## Properties
44

5-
Name | Type | Description | Notes
6-
------------ | ------------- | ------------- | -------------
7-
**username** | Option<**String**> | | [optional]
8-
**first_name** | Option<**String**> | | [optional]
9-
**last_name** | Option<**String**> | | [optional]
10-
**picture_url** | Option<**String**> | | [optional]
5+
| Name | Type | Description | Notes |
6+
| ---------------------------- | ---------------------------------- | ----------- | ---------- |
7+
| **username** | Option<**String**> | | [optional] |
8+
| **first_name** | Option<**String**> | | [optional] |
9+
| **last_name** | Option<**String**> | | [optional] |
10+
| **picture_url** | Option<**String**> | | [optional] |
11+
| **metadata** | Option<**HashMap<String, Value>**> | | [optional] |
12+
| **properties** | Option<**HashMap<String, Value>**> | | [optional] |
13+
| **update_password_required** | Option<**bool**> | | [optional] |
1114

1215
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
13-
14-

0 commit comments

Comments
 (0)