kinde_sdk 1.0.0
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.
- checksums.yaml +7 -0
- data/Gemfile +15 -0
- data/Gemfile.lock +119 -0
- data/LICENSE +21 -0
- data/README.md +342 -0
- data/Rakefile +10 -0
- data/kinde_api/.gitignore +39 -0
- data/kinde_api/.rspec +2 -0
- data/kinde_api/README.md +103 -0
- data/kinde_api/docs/AddOrganizationUsers200Response.md +22 -0
- data/kinde_api/docs/AddOrganizationUsersRequest.md +18 -0
- data/kinde_api/docs/ApiResult.md +18 -0
- data/kinde_api/docs/ConnectedAppsAccessToken.md +20 -0
- data/kinde_api/docs/ConnectedAppsApi.md +219 -0
- data/kinde_api/docs/ConnectedAppsAuthUrl.md +20 -0
- data/kinde_api/docs/CreateOrganization201Response.md +20 -0
- data/kinde_api/docs/CreateOrganizationRequest.md +20 -0
- data/kinde_api/docs/CreateUser200Response.md +22 -0
- data/kinde_api/docs/CreateUserRequest.md +20 -0
- data/kinde_api/docs/CreateUserRequestIdentitiesInner.md +20 -0
- data/kinde_api/docs/CreateUserRequestIdentitiesInnerDetails.md +18 -0
- data/kinde_api/docs/CreateUserRequestProfile.md +20 -0
- data/kinde_api/docs/EnvironmentsApi.md +216 -0
- data/kinde_api/docs/Error.md +20 -0
- data/kinde_api/docs/ErrorResponse.md +18 -0
- data/kinde_api/docs/FeatureFlagsApi.md +239 -0
- data/kinde_api/docs/GetOrganizationUsers200Response.md +24 -0
- data/kinde_api/docs/GetOrganizations200Response.md +24 -0
- data/kinde_api/docs/GetUsers200Response.md +24 -0
- data/kinde_api/docs/OAuthApi.md +141 -0
- data/kinde_api/docs/Organization.md +22 -0
- data/kinde_api/docs/OrganizationUser.md +26 -0
- data/kinde_api/docs/OrganizationsApi.md +671 -0
- data/kinde_api/docs/RemoveOrganizationUsers200Response.md +20 -0
- data/kinde_api/docs/RemoveOrganizationUsersRequest.md +18 -0
- data/kinde_api/docs/SuccessResponse.md +20 -0
- data/kinde_api/docs/UpdateUserRequest.md +22 -0
- data/kinde_api/docs/User.md +28 -0
- data/kinde_api/docs/UserIdentity.md +20 -0
- data/kinde_api/docs/UserIdentityResult.md +20 -0
- data/kinde_api/docs/UserProfile.md +26 -0
- data/kinde_api/docs/UserProfileV2.md +30 -0
- data/kinde_api/docs/UsersApi.md +603 -0
- data/kinde_api/lib/kinde_api/api/connected_apps_api.rb +221 -0
- data/kinde_api/lib/kinde_api/api/environments_api.rb +212 -0
- data/kinde_api/lib/kinde_api/api/feature_flags_api.rb +309 -0
- data/kinde_api/lib/kinde_api/api/o_auth_api.rb +136 -0
- data/kinde_api/lib/kinde_api/api/organizations_api.rb +634 -0
- data/kinde_api/lib/kinde_api/api/users_api.rb +560 -0
- data/kinde_api/lib/kinde_api/api_client.rb +397 -0
- data/kinde_api/lib/kinde_api/api_error.rb +58 -0
- data/kinde_api/lib/kinde_api/configuration.rb +295 -0
- data/kinde_api/lib/kinde_api/models/add_organization_users200_response.rb +239 -0
- data/kinde_api/lib/kinde_api/models/add_organization_users_request.rb +220 -0
- data/kinde_api/lib/kinde_api/models/api_result.rb +218 -0
- data/kinde_api/lib/kinde_api/models/connected_apps_access_token.rb +228 -0
- data/kinde_api/lib/kinde_api/models/connected_apps_auth_url.rb +228 -0
- data/kinde_api/lib/kinde_api/models/create_organization201_response.rb +228 -0
- data/kinde_api/lib/kinde_api/models/create_organization_request.rb +252 -0
- data/kinde_api/lib/kinde_api/models/create_user200_response.rb +239 -0
- data/kinde_api/lib/kinde_api/models/create_user_request.rb +229 -0
- data/kinde_api/lib/kinde_api/models/create_user_request_identities_inner.rb +228 -0
- data/kinde_api/lib/kinde_api/models/create_user_request_identities_inner_details.rb +219 -0
- data/kinde_api/lib/kinde_api/models/create_user_request_profile.rb +229 -0
- data/kinde_api/lib/kinde_api/models/error.rb +228 -0
- data/kinde_api/lib/kinde_api/models/error_response.rb +219 -0
- data/kinde_api/lib/kinde_api/models/get_organization_users200_response.rb +249 -0
- data/kinde_api/lib/kinde_api/models/get_organizations200_response.rb +249 -0
- data/kinde_api/lib/kinde_api/models/get_users200_response.rb +249 -0
- data/kinde_api/lib/kinde_api/models/organization.rb +235 -0
- data/kinde_api/lib/kinde_api/models/organization_user.rb +253 -0
- data/kinde_api/lib/kinde_api/models/remove_organization_users200_response.rb +228 -0
- data/kinde_api/lib/kinde_api/models/remove_organization_users_request.rb +220 -0
- data/kinde_api/lib/kinde_api/models/success_response.rb +226 -0
- data/kinde_api/lib/kinde_api/models/update_user_request.rb +238 -0
- data/kinde_api/lib/kinde_api/models/user.rb +269 -0
- data/kinde_api/lib/kinde_api/models/user_identity.rb +227 -0
- data/kinde_api/lib/kinde_api/models/user_identity_result.rb +229 -0
- data/kinde_api/lib/kinde_api/models/user_profile.rb +259 -0
- data/kinde_api/lib/kinde_api/models/user_profile_v2.rb +279 -0
- data/kinde_api/lib/kinde_api/version.rb +15 -0
- data/kinde_api/lib/kinde_api.rb +73 -0
- data/kinde_api/spec/api/connected_apps_api_spec.rb +72 -0
- data/kinde_api/spec/api/environments_api_spec.rb +71 -0
- data/kinde_api/spec/api/feature_flags_api_spec.rb +82 -0
- data/kinde_api/spec/api/o_auth_api_spec.rb +57 -0
- data/kinde_api/spec/api/organizations_api_spec.rb +154 -0
- data/kinde_api/spec/api/users_api_spec.rb +141 -0
- data/kinde_api/spec/api_client_spec.rb +229 -0
- data/kinde_api/spec/configuration_spec.rb +42 -0
- data/kinde_api/spec/models/add_organization_users200_response_spec.rb +46 -0
- data/kinde_api/spec/models/add_organization_users_request_spec.rb +34 -0
- data/kinde_api/spec/models/api_result_spec.rb +34 -0
- data/kinde_api/spec/models/connected_apps_access_token_spec.rb +40 -0
- data/kinde_api/spec/models/connected_apps_auth_url_spec.rb +40 -0
- data/kinde_api/spec/models/create_organization201_response_spec.rb +40 -0
- data/kinde_api/spec/models/create_organization_request_spec.rb +44 -0
- data/kinde_api/spec/models/create_user200_response_spec.rb +46 -0
- data/kinde_api/spec/models/create_user_request_identities_inner_details_spec.rb +34 -0
- data/kinde_api/spec/models/create_user_request_identities_inner_spec.rb +40 -0
- data/kinde_api/spec/models/create_user_request_profile_spec.rb +40 -0
- data/kinde_api/spec/models/create_user_request_spec.rb +40 -0
- data/kinde_api/spec/models/error_response_spec.rb +34 -0
- data/kinde_api/spec/models/error_spec.rb +40 -0
- data/kinde_api/spec/models/get_organization_users200_response_spec.rb +52 -0
- data/kinde_api/spec/models/get_organizations200_response_spec.rb +52 -0
- data/kinde_api/spec/models/get_users200_response_spec.rb +52 -0
- data/kinde_api/spec/models/organization_spec.rb +46 -0
- data/kinde_api/spec/models/organization_user_spec.rb +58 -0
- data/kinde_api/spec/models/remove_organization_users200_response_spec.rb +40 -0
- data/kinde_api/spec/models/remove_organization_users_request_spec.rb +34 -0
- data/kinde_api/spec/models/success_response_spec.rb +40 -0
- data/kinde_api/spec/models/update_user_request_spec.rb +46 -0
- data/kinde_api/spec/models/user_identity_result_spec.rb +40 -0
- data/kinde_api/spec/models/user_identity_spec.rb +40 -0
- data/kinde_api/spec/models/user_profile_spec.rb +58 -0
- data/kinde_api/spec/models/user_profile_v2_spec.rb +70 -0
- data/kinde_api/spec/models/user_spec.rb +64 -0
- data/kinde_api/spec/spec_helper.rb +111 -0
- data/kinde_sdk.gemspec +33 -0
- data/lib/kinde_sdk/client.rb +49 -0
- data/lib/kinde_sdk/configuration.rb +50 -0
- data/lib/kinde_sdk/version.rb +3 -0
- data/lib/kinde_sdk.rb +109 -0
- data/openapitools.json +7 -0
- data/spec/kinde_sdk_spec.rb +105 -0
- data/spec/spec_helper.rb +82 -0
- metadata +291 -0
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# KindeApi::AddOrganizationUsers200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **code** | **String** | Response code. | [optional] |
|
|
8
|
+
| **message** | **String** | Response message. | [optional] |
|
|
9
|
+
| **users_added** | **Array<String>** | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'kinde_api'
|
|
15
|
+
|
|
16
|
+
instance = KindeApi::AddOrganizationUsers200Response.new(
|
|
17
|
+
code: null,
|
|
18
|
+
message: null,
|
|
19
|
+
users_added: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# KindeApi::AddOrganizationUsersRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **users** | **Array<String>** | List of user ids to be added to the organization. | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'kinde_api'
|
|
13
|
+
|
|
14
|
+
instance = KindeApi::AddOrganizationUsersRequest.new(
|
|
15
|
+
users: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# KindeApi::ApiResult
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **result** | **String** | The result of the api operation. | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'kinde_api'
|
|
13
|
+
|
|
14
|
+
instance = KindeApi::ApiResult.new(
|
|
15
|
+
result: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# KindeApi::ConnectedAppsAccessToken
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **access_token** | **String** | The access token to access a third-party provider. | [optional] |
|
|
8
|
+
| **access_token_expiry** | **String** | The date and time that the access token expires. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'kinde_api'
|
|
14
|
+
|
|
15
|
+
instance = KindeApi::ConnectedAppsAccessToken.new(
|
|
16
|
+
access_token: null,
|
|
17
|
+
access_token_expiry: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,219 @@
|
|
|
1
|
+
# KindeApi::ConnectedAppsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://app.kinde.com*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**get_connected_app_auth_url**](ConnectedAppsApi.md#get_connected_app_auth_url) | **GET** /api/v1/connected_apps/auth_url | Get Connected App URL |
|
|
8
|
+
| [**get_connected_app_token**](ConnectedAppsApi.md#get_connected_app_token) | **GET** /api/v1/connected_apps/token | Get Connected App Token |
|
|
9
|
+
| [**revoke_connected_app_token**](ConnectedAppsApi.md#revoke_connected_app_token) | **POST** /api/v1/connected_apps/revoke | Revoke Connected App Token |
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
## get_connected_app_auth_url
|
|
13
|
+
|
|
14
|
+
> <ConnectedAppsAuthUrl> get_connected_app_auth_url(key_code_ref, user_id)
|
|
15
|
+
|
|
16
|
+
Get Connected App URL
|
|
17
|
+
|
|
18
|
+
Get a URL that authenticates and authorizes a user to a third-party connected app.
|
|
19
|
+
|
|
20
|
+
### Examples
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
require 'time'
|
|
24
|
+
require 'kinde_api'
|
|
25
|
+
# setup authorization
|
|
26
|
+
KindeApi.configure do |config|
|
|
27
|
+
# Configure Bearer authorization (JWT): kindeBearerAuth
|
|
28
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
api_instance = KindeApi::ConnectedAppsApi.new
|
|
32
|
+
key_code_ref = 'key_code_ref_example' # String | The unique key code reference of the connected app to authenticate against.
|
|
33
|
+
user_id = 56 # Integer | The id of the user that needs to authenticate to the third-party connected app.
|
|
34
|
+
|
|
35
|
+
begin
|
|
36
|
+
# Get Connected App URL
|
|
37
|
+
result = api_instance.get_connected_app_auth_url(key_code_ref, user_id)
|
|
38
|
+
p result
|
|
39
|
+
rescue KindeApi::ApiError => e
|
|
40
|
+
puts "Error when calling ConnectedAppsApi->get_connected_app_auth_url: #{e}"
|
|
41
|
+
end
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
#### Using the get_connected_app_auth_url_with_http_info variant
|
|
45
|
+
|
|
46
|
+
This returns an Array which contains the response data, status code and headers.
|
|
47
|
+
|
|
48
|
+
> <Array(<ConnectedAppsAuthUrl>, Integer, Hash)> get_connected_app_auth_url_with_http_info(key_code_ref, user_id)
|
|
49
|
+
|
|
50
|
+
```ruby
|
|
51
|
+
begin
|
|
52
|
+
# Get Connected App URL
|
|
53
|
+
data, status_code, headers = api_instance.get_connected_app_auth_url_with_http_info(key_code_ref, user_id)
|
|
54
|
+
p status_code # => 2xx
|
|
55
|
+
p headers # => { ... }
|
|
56
|
+
p data # => <ConnectedAppsAuthUrl>
|
|
57
|
+
rescue KindeApi::ApiError => e
|
|
58
|
+
puts "Error when calling ConnectedAppsApi->get_connected_app_auth_url_with_http_info: #{e}"
|
|
59
|
+
end
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
### Parameters
|
|
63
|
+
|
|
64
|
+
| Name | Type | Description | Notes |
|
|
65
|
+
| ---- | ---- | ----------- | ----- |
|
|
66
|
+
| **key_code_ref** | **String** | The unique key code reference of the connected app to authenticate against. | |
|
|
67
|
+
| **user_id** | **Integer** | The id of the user that needs to authenticate to the third-party connected app. | |
|
|
68
|
+
|
|
69
|
+
### Return type
|
|
70
|
+
|
|
71
|
+
[**ConnectedAppsAuthUrl**](ConnectedAppsAuthUrl.md)
|
|
72
|
+
|
|
73
|
+
### Authorization
|
|
74
|
+
|
|
75
|
+
[kindeBearerAuth](../README.md#kindeBearerAuth)
|
|
76
|
+
|
|
77
|
+
### HTTP request headers
|
|
78
|
+
|
|
79
|
+
- **Content-Type**: Not defined
|
|
80
|
+
- **Accept**: application/json
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
## get_connected_app_token
|
|
84
|
+
|
|
85
|
+
> <ConnectedAppsAccessToken> get_connected_app_token(session_id)
|
|
86
|
+
|
|
87
|
+
Get Connected App Token
|
|
88
|
+
|
|
89
|
+
Get an access token that can be used to call the third-party provider linked to the connected app.
|
|
90
|
+
|
|
91
|
+
### Examples
|
|
92
|
+
|
|
93
|
+
```ruby
|
|
94
|
+
require 'time'
|
|
95
|
+
require 'kinde_api'
|
|
96
|
+
# setup authorization
|
|
97
|
+
KindeApi.configure do |config|
|
|
98
|
+
# Configure Bearer authorization (JWT): kindeBearerAuth
|
|
99
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
100
|
+
end
|
|
101
|
+
|
|
102
|
+
api_instance = KindeApi::ConnectedAppsApi.new
|
|
103
|
+
session_id = 'session_id_example' # String | The unique sesssion id reprensenting the login session of a user.
|
|
104
|
+
|
|
105
|
+
begin
|
|
106
|
+
# Get Connected App Token
|
|
107
|
+
result = api_instance.get_connected_app_token(session_id)
|
|
108
|
+
p result
|
|
109
|
+
rescue KindeApi::ApiError => e
|
|
110
|
+
puts "Error when calling ConnectedAppsApi->get_connected_app_token: #{e}"
|
|
111
|
+
end
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
#### Using the get_connected_app_token_with_http_info variant
|
|
115
|
+
|
|
116
|
+
This returns an Array which contains the response data, status code and headers.
|
|
117
|
+
|
|
118
|
+
> <Array(<ConnectedAppsAccessToken>, Integer, Hash)> get_connected_app_token_with_http_info(session_id)
|
|
119
|
+
|
|
120
|
+
```ruby
|
|
121
|
+
begin
|
|
122
|
+
# Get Connected App Token
|
|
123
|
+
data, status_code, headers = api_instance.get_connected_app_token_with_http_info(session_id)
|
|
124
|
+
p status_code # => 2xx
|
|
125
|
+
p headers # => { ... }
|
|
126
|
+
p data # => <ConnectedAppsAccessToken>
|
|
127
|
+
rescue KindeApi::ApiError => e
|
|
128
|
+
puts "Error when calling ConnectedAppsApi->get_connected_app_token_with_http_info: #{e}"
|
|
129
|
+
end
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
### Parameters
|
|
133
|
+
|
|
134
|
+
| Name | Type | Description | Notes |
|
|
135
|
+
| ---- | ---- | ----------- | ----- |
|
|
136
|
+
| **session_id** | **String** | The unique sesssion id reprensenting the login session of a user. | |
|
|
137
|
+
|
|
138
|
+
### Return type
|
|
139
|
+
|
|
140
|
+
[**ConnectedAppsAccessToken**](ConnectedAppsAccessToken.md)
|
|
141
|
+
|
|
142
|
+
### Authorization
|
|
143
|
+
|
|
144
|
+
[kindeBearerAuth](../README.md#kindeBearerAuth)
|
|
145
|
+
|
|
146
|
+
### HTTP request headers
|
|
147
|
+
|
|
148
|
+
- **Content-Type**: Not defined
|
|
149
|
+
- **Accept**: application/json
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
## revoke_connected_app_token
|
|
153
|
+
|
|
154
|
+
> <ApiResult> revoke_connected_app_token(session_id)
|
|
155
|
+
|
|
156
|
+
Revoke Connected App Token
|
|
157
|
+
|
|
158
|
+
Revoke the tokens linked to the connected app session.
|
|
159
|
+
|
|
160
|
+
### Examples
|
|
161
|
+
|
|
162
|
+
```ruby
|
|
163
|
+
require 'time'
|
|
164
|
+
require 'kinde_api'
|
|
165
|
+
# setup authorization
|
|
166
|
+
KindeApi.configure do |config|
|
|
167
|
+
# Configure Bearer authorization (JWT): kindeBearerAuth
|
|
168
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
169
|
+
end
|
|
170
|
+
|
|
171
|
+
api_instance = KindeApi::ConnectedAppsApi.new
|
|
172
|
+
session_id = 'session_id_example' # String | The unique sesssion id reprensenting the login session of a user.
|
|
173
|
+
|
|
174
|
+
begin
|
|
175
|
+
# Revoke Connected App Token
|
|
176
|
+
result = api_instance.revoke_connected_app_token(session_id)
|
|
177
|
+
p result
|
|
178
|
+
rescue KindeApi::ApiError => e
|
|
179
|
+
puts "Error when calling ConnectedAppsApi->revoke_connected_app_token: #{e}"
|
|
180
|
+
end
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
#### Using the revoke_connected_app_token_with_http_info variant
|
|
184
|
+
|
|
185
|
+
This returns an Array which contains the response data, status code and headers.
|
|
186
|
+
|
|
187
|
+
> <Array(<ApiResult>, Integer, Hash)> revoke_connected_app_token_with_http_info(session_id)
|
|
188
|
+
|
|
189
|
+
```ruby
|
|
190
|
+
begin
|
|
191
|
+
# Revoke Connected App Token
|
|
192
|
+
data, status_code, headers = api_instance.revoke_connected_app_token_with_http_info(session_id)
|
|
193
|
+
p status_code # => 2xx
|
|
194
|
+
p headers # => { ... }
|
|
195
|
+
p data # => <ApiResult>
|
|
196
|
+
rescue KindeApi::ApiError => e
|
|
197
|
+
puts "Error when calling ConnectedAppsApi->revoke_connected_app_token_with_http_info: #{e}"
|
|
198
|
+
end
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
### Parameters
|
|
202
|
+
|
|
203
|
+
| Name | Type | Description | Notes |
|
|
204
|
+
| ---- | ---- | ----------- | ----- |
|
|
205
|
+
| **session_id** | **String** | The unique sesssion id reprensenting the login session of a user. | |
|
|
206
|
+
|
|
207
|
+
### Return type
|
|
208
|
+
|
|
209
|
+
[**ApiResult**](ApiResult.md)
|
|
210
|
+
|
|
211
|
+
### Authorization
|
|
212
|
+
|
|
213
|
+
[kindeBearerAuth](../README.md#kindeBearerAuth)
|
|
214
|
+
|
|
215
|
+
### HTTP request headers
|
|
216
|
+
|
|
217
|
+
- **Content-Type**: Not defined
|
|
218
|
+
- **Accept**: application/json
|
|
219
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# KindeApi::ConnectedAppsAuthUrl
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **url** | **String** | A URL that is used to authenticate an end-user against a connected app. | [optional] |
|
|
8
|
+
| **session_id** | **String** | A unique identifier for the login session. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'kinde_api'
|
|
14
|
+
|
|
15
|
+
instance = KindeApi::ConnectedAppsAuthUrl.new(
|
|
16
|
+
url: null,
|
|
17
|
+
session_id: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# KindeApi::CreateOrganization201Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **code** | **String** | Response code. | [optional] |
|
|
8
|
+
| **message** | **String** | Response message. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'kinde_api'
|
|
14
|
+
|
|
15
|
+
instance = KindeApi::CreateOrganization201Response.new(
|
|
16
|
+
code: null,
|
|
17
|
+
message: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# KindeApi::CreateOrganizationRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | The organization's name. | [optional] |
|
|
8
|
+
| **feature_flags** | **Hash<String, String>** | The organization's feature flag settings. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'kinde_api'
|
|
14
|
+
|
|
15
|
+
instance = KindeApi::CreateOrganizationRequest.new(
|
|
16
|
+
name: null,
|
|
17
|
+
feature_flags: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# KindeApi::CreateUser200Response
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique id of the user in Kinde. | [optional] |
|
|
8
|
+
| **created** | **Boolean** | True if the user was successfully created. | [optional] |
|
|
9
|
+
| **identities** | [**Array<UserIdentity>**](UserIdentity.md) | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'kinde_api'
|
|
15
|
+
|
|
16
|
+
instance = KindeApi::CreateUser200Response.new(
|
|
17
|
+
id: null,
|
|
18
|
+
created: null,
|
|
19
|
+
identities: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# KindeApi::CreateUserRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **profile** | [**CreateUserRequestProfile**](CreateUserRequestProfile.md) | | [optional] |
|
|
8
|
+
| **identities** | [**Array<CreateUserRequestIdentitiesInner>**](CreateUserRequestIdentitiesInner.md) | Array of identities to assign to the created user | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'kinde_api'
|
|
14
|
+
|
|
15
|
+
instance = KindeApi::CreateUserRequest.new(
|
|
16
|
+
profile: null,
|
|
17
|
+
identities: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# KindeApi::CreateUserRequestIdentitiesInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | The type of identity to create, for e.g. email. | [optional] |
|
|
8
|
+
| **details** | [**CreateUserRequestIdentitiesInnerDetails**](CreateUserRequestIdentitiesInnerDetails.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'kinde_api'
|
|
14
|
+
|
|
15
|
+
instance = KindeApi::CreateUserRequestIdentitiesInner.new(
|
|
16
|
+
type: null,
|
|
17
|
+
details: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# KindeApi::CreateUserRequestIdentitiesInnerDetails
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **email** | **String** | The email address of the user. | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'kinde_api'
|
|
13
|
+
|
|
14
|
+
instance = KindeApi::CreateUserRequestIdentitiesInnerDetails.new(
|
|
15
|
+
email: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# KindeApi::CreateUserRequestProfile
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **given_name** | **String** | User's first name. | [optional] |
|
|
8
|
+
| **family_name** | **String** | User's last name. | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'kinde_api'
|
|
14
|
+
|
|
15
|
+
instance = KindeApi::CreateUserRequestProfile.new(
|
|
16
|
+
given_name: null,
|
|
17
|
+
family_name: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,216 @@
|
|
|
1
|
+
# KindeApi::EnvironmentsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://app.kinde.com*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**delete_environement_feature_flag_override**](EnvironmentsApi.md#delete_environement_feature_flag_override) | **DELETE** /api/v1/environment/feature_flags/{feature_flag_key} | Delete environment feature flag override |
|
|
8
|
+
| [**delete_environement_feature_flag_overrides**](EnvironmentsApi.md#delete_environement_feature_flag_overrides) | **DELETE** /api/v1/environment/feature_flags/ | Delete all environment feature flag overrides |
|
|
9
|
+
| [**update_environement_feature_flag_override**](EnvironmentsApi.md#update_environement_feature_flag_override) | **PATCH** /api/v1/environment/feature_flags/{feature_flag_key} | Update environment feature flag override |
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
## delete_environement_feature_flag_override
|
|
13
|
+
|
|
14
|
+
> <SuccessResponse> delete_environement_feature_flag_override(feature_flag_key)
|
|
15
|
+
|
|
16
|
+
Delete environment feature flag override
|
|
17
|
+
|
|
18
|
+
Delete environment feature flag override.
|
|
19
|
+
|
|
20
|
+
### Examples
|
|
21
|
+
|
|
22
|
+
```ruby
|
|
23
|
+
require 'time'
|
|
24
|
+
require 'kinde_api'
|
|
25
|
+
# setup authorization
|
|
26
|
+
KindeApi.configure do |config|
|
|
27
|
+
# Configure Bearer authorization (JWT): kindeBearerAuth
|
|
28
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
29
|
+
end
|
|
30
|
+
|
|
31
|
+
api_instance = KindeApi::EnvironmentsApi.new
|
|
32
|
+
feature_flag_key = 'feature_flag_key_example' # String | The identifier for the feature flag.
|
|
33
|
+
|
|
34
|
+
begin
|
|
35
|
+
# Delete environment feature flag override
|
|
36
|
+
result = api_instance.delete_environement_feature_flag_override(feature_flag_key)
|
|
37
|
+
p result
|
|
38
|
+
rescue KindeApi::ApiError => e
|
|
39
|
+
puts "Error when calling EnvironmentsApi->delete_environement_feature_flag_override: #{e}"
|
|
40
|
+
end
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
#### Using the delete_environement_feature_flag_override_with_http_info variant
|
|
44
|
+
|
|
45
|
+
This returns an Array which contains the response data, status code and headers.
|
|
46
|
+
|
|
47
|
+
> <Array(<SuccessResponse>, Integer, Hash)> delete_environement_feature_flag_override_with_http_info(feature_flag_key)
|
|
48
|
+
|
|
49
|
+
```ruby
|
|
50
|
+
begin
|
|
51
|
+
# Delete environment feature flag override
|
|
52
|
+
data, status_code, headers = api_instance.delete_environement_feature_flag_override_with_http_info(feature_flag_key)
|
|
53
|
+
p status_code # => 2xx
|
|
54
|
+
p headers # => { ... }
|
|
55
|
+
p data # => <SuccessResponse>
|
|
56
|
+
rescue KindeApi::ApiError => e
|
|
57
|
+
puts "Error when calling EnvironmentsApi->delete_environement_feature_flag_override_with_http_info: #{e}"
|
|
58
|
+
end
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
### Parameters
|
|
62
|
+
|
|
63
|
+
| Name | Type | Description | Notes |
|
|
64
|
+
| ---- | ---- | ----------- | ----- |
|
|
65
|
+
| **feature_flag_key** | **String** | The identifier for the feature flag. | |
|
|
66
|
+
|
|
67
|
+
### Return type
|
|
68
|
+
|
|
69
|
+
[**SuccessResponse**](SuccessResponse.md)
|
|
70
|
+
|
|
71
|
+
### Authorization
|
|
72
|
+
|
|
73
|
+
[kindeBearerAuth](../README.md#kindeBearerAuth)
|
|
74
|
+
|
|
75
|
+
### HTTP request headers
|
|
76
|
+
|
|
77
|
+
- **Content-Type**: Not defined
|
|
78
|
+
- **Accept**: application/json
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
## delete_environement_feature_flag_overrides
|
|
82
|
+
|
|
83
|
+
> <SuccessResponse> delete_environement_feature_flag_overrides
|
|
84
|
+
|
|
85
|
+
Delete all environment feature flag overrides
|
|
86
|
+
|
|
87
|
+
Delete all environment feature flag overrides.
|
|
88
|
+
|
|
89
|
+
### Examples
|
|
90
|
+
|
|
91
|
+
```ruby
|
|
92
|
+
require 'time'
|
|
93
|
+
require 'kinde_api'
|
|
94
|
+
# setup authorization
|
|
95
|
+
KindeApi.configure do |config|
|
|
96
|
+
# Configure Bearer authorization (JWT): kindeBearerAuth
|
|
97
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
98
|
+
end
|
|
99
|
+
|
|
100
|
+
api_instance = KindeApi::EnvironmentsApi.new
|
|
101
|
+
|
|
102
|
+
begin
|
|
103
|
+
# Delete all environment feature flag overrides
|
|
104
|
+
result = api_instance.delete_environement_feature_flag_overrides
|
|
105
|
+
p result
|
|
106
|
+
rescue KindeApi::ApiError => e
|
|
107
|
+
puts "Error when calling EnvironmentsApi->delete_environement_feature_flag_overrides: #{e}"
|
|
108
|
+
end
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
#### Using the delete_environement_feature_flag_overrides_with_http_info variant
|
|
112
|
+
|
|
113
|
+
This returns an Array which contains the response data, status code and headers.
|
|
114
|
+
|
|
115
|
+
> <Array(<SuccessResponse>, Integer, Hash)> delete_environement_feature_flag_overrides_with_http_info
|
|
116
|
+
|
|
117
|
+
```ruby
|
|
118
|
+
begin
|
|
119
|
+
# Delete all environment feature flag overrides
|
|
120
|
+
data, status_code, headers = api_instance.delete_environement_feature_flag_overrides_with_http_info
|
|
121
|
+
p status_code # => 2xx
|
|
122
|
+
p headers # => { ... }
|
|
123
|
+
p data # => <SuccessResponse>
|
|
124
|
+
rescue KindeApi::ApiError => e
|
|
125
|
+
puts "Error when calling EnvironmentsApi->delete_environement_feature_flag_overrides_with_http_info: #{e}"
|
|
126
|
+
end
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
### Parameters
|
|
130
|
+
|
|
131
|
+
This endpoint does not need any parameter.
|
|
132
|
+
|
|
133
|
+
### Return type
|
|
134
|
+
|
|
135
|
+
[**SuccessResponse**](SuccessResponse.md)
|
|
136
|
+
|
|
137
|
+
### Authorization
|
|
138
|
+
|
|
139
|
+
[kindeBearerAuth](../README.md#kindeBearerAuth)
|
|
140
|
+
|
|
141
|
+
### HTTP request headers
|
|
142
|
+
|
|
143
|
+
- **Content-Type**: Not defined
|
|
144
|
+
- **Accept**: application/json
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
## update_environement_feature_flag_override
|
|
148
|
+
|
|
149
|
+
> <SuccessResponse> update_environement_feature_flag_override(feature_flag_key, value)
|
|
150
|
+
|
|
151
|
+
Update environment feature flag override
|
|
152
|
+
|
|
153
|
+
Update environment feature flag override.
|
|
154
|
+
|
|
155
|
+
### Examples
|
|
156
|
+
|
|
157
|
+
```ruby
|
|
158
|
+
require 'time'
|
|
159
|
+
require 'kinde_api'
|
|
160
|
+
# setup authorization
|
|
161
|
+
KindeApi.configure do |config|
|
|
162
|
+
# Configure Bearer authorization (JWT): kindeBearerAuth
|
|
163
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
164
|
+
end
|
|
165
|
+
|
|
166
|
+
api_instance = KindeApi::EnvironmentsApi.new
|
|
167
|
+
feature_flag_key = 'feature_flag_key_example' # String | The identifier for the feature flag.
|
|
168
|
+
value = 'value_example' # String | The override value for the feature flag.
|
|
169
|
+
|
|
170
|
+
begin
|
|
171
|
+
# Update environment feature flag override
|
|
172
|
+
result = api_instance.update_environement_feature_flag_override(feature_flag_key, value)
|
|
173
|
+
p result
|
|
174
|
+
rescue KindeApi::ApiError => e
|
|
175
|
+
puts "Error when calling EnvironmentsApi->update_environement_feature_flag_override: #{e}"
|
|
176
|
+
end
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
#### Using the update_environement_feature_flag_override_with_http_info variant
|
|
180
|
+
|
|
181
|
+
This returns an Array which contains the response data, status code and headers.
|
|
182
|
+
|
|
183
|
+
> <Array(<SuccessResponse>, Integer, Hash)> update_environement_feature_flag_override_with_http_info(feature_flag_key, value)
|
|
184
|
+
|
|
185
|
+
```ruby
|
|
186
|
+
begin
|
|
187
|
+
# Update environment feature flag override
|
|
188
|
+
data, status_code, headers = api_instance.update_environement_feature_flag_override_with_http_info(feature_flag_key, value)
|
|
189
|
+
p status_code # => 2xx
|
|
190
|
+
p headers # => { ... }
|
|
191
|
+
p data # => <SuccessResponse>
|
|
192
|
+
rescue KindeApi::ApiError => e
|
|
193
|
+
puts "Error when calling EnvironmentsApi->update_environement_feature_flag_override_with_http_info: #{e}"
|
|
194
|
+
end
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
### Parameters
|
|
198
|
+
|
|
199
|
+
| Name | Type | Description | Notes |
|
|
200
|
+
| ---- | ---- | ----------- | ----- |
|
|
201
|
+
| **feature_flag_key** | **String** | The identifier for the feature flag. | |
|
|
202
|
+
| **value** | **String** | The override value for the feature flag. | |
|
|
203
|
+
|
|
204
|
+
### Return type
|
|
205
|
+
|
|
206
|
+
[**SuccessResponse**](SuccessResponse.md)
|
|
207
|
+
|
|
208
|
+
### Authorization
|
|
209
|
+
|
|
210
|
+
[kindeBearerAuth](../README.md#kindeBearerAuth)
|
|
211
|
+
|
|
212
|
+
### HTTP request headers
|
|
213
|
+
|
|
214
|
+
- **Content-Type**: Not defined
|
|
215
|
+
- **Accept**: application/json
|
|
216
|
+
|