kinde_sdk 1.2.1 → 1.2.2
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 +4 -4
- data/Gemfile.lock +128 -0
- data/README.md +12 -434
- data/kinde_api/README.md +98 -27
- data/kinde_api/docs/APIsApi.md +356 -0
- data/kinde_api/docs/AddAPIsRequest.md +20 -0
- data/kinde_api/docs/Api.md +28 -0
- data/kinde_api/docs/ApiApplicationsInner.md +24 -0
- data/kinde_api/docs/Apis.md +24 -0
- data/kinde_api/docs/Applications.md +22 -0
- data/kinde_api/docs/ApplicationsApi.md +368 -0
- data/kinde_api/docs/BusinessApi.md +183 -0
- data/kinde_api/docs/CallbacksApi.md +385 -25
- data/kinde_api/docs/CreateApplicationRequest.md +20 -0
- data/kinde_api/docs/CreateApplicationResponse.md +22 -0
- data/kinde_api/docs/CreateApplicationResponseApplication.md +22 -0
- data/kinde_api/docs/CreateFeatureFlagRequest.md +28 -0
- data/kinde_api/docs/CreateOrganizationRequest.md +3 -1
- data/kinde_api/docs/CreateOrganizationUserPermissionRequest.md +18 -0
- data/kinde_api/docs/EnvironmentsApi.md +23 -23
- data/kinde_api/docs/FeatureFlagsApi.md +19 -29
- data/kinde_api/docs/GetApplicationResponse.md +22 -0
- data/kinde_api/docs/GetApplicationResponseApplication.md +26 -0
- data/kinde_api/docs/GetApplicationsResponse.md +2 -2
- data/kinde_api/docs/{GetOrganizationsUsersResponse.md → GetOrganizationUsersResponse.md} +2 -2
- data/kinde_api/docs/GetOrganizationsUserPermissionsResponse.md +22 -0
- data/kinde_api/docs/GetPermissionsResponse.md +24 -0
- data/kinde_api/docs/GetRolesResponse.md +24 -0
- data/kinde_api/docs/GetSubscriberResponse.md +22 -0
- data/kinde_api/docs/GetSubscribersResponse.md +24 -0
- data/kinde_api/docs/IndustriesApi.md +81 -0
- data/kinde_api/docs/LogoutRedirectUrls.md +18 -0
- data/kinde_api/docs/OAuthApi.md +153 -4
- data/kinde_api/docs/Organization.md +3 -1
- data/kinde_api/docs/OrganizationUserPermission.md +26 -0
- data/kinde_api/docs/OrganizationUserPermissionRolesInner.md +20 -0
- data/kinde_api/docs/OrganizationUserRolePermissions.md +22 -0
- data/kinde_api/docs/OrganizationUserRolePermissionsPermissions.md +18 -0
- data/kinde_api/docs/OrganizationsApi.md +328 -32
- data/kinde_api/docs/PermissionsApi.md +84 -14
- data/kinde_api/docs/ReplaceLogoutRedirectURLsRequest.md +18 -0
- data/kinde_api/docs/ReplaceRedirectCallbackURLsRequest.md +18 -0
- data/kinde_api/docs/Role.md +24 -0
- data/kinde_api/docs/Roles.md +2 -0
- data/kinde_api/docs/RolesApi.md +309 -17
- data/kinde_api/docs/RolesPermissionResponseInner.md +24 -0
- data/kinde_api/docs/Subscriber.md +24 -0
- data/kinde_api/docs/SubscribersApi.md +12 -14
- data/kinde_api/docs/SubscribersSubscriber.md +26 -0
- data/kinde_api/docs/TimezonesApi.md +81 -0
- data/kinde_api/docs/TokenErrorResponse.md +20 -0
- data/kinde_api/docs/TokenIntrospect.md +26 -0
- data/kinde_api/docs/UpdateAPIApplicationsRequest.md +18 -0
- data/kinde_api/docs/UpdateAPIApplicationsRequestApplicationsInner.md +20 -0
- data/kinde_api/docs/UpdateApplicationRequest.md +24 -0
- data/kinde_api/docs/UpdateEnvironementFeatureFlagOverrideRequest.md +18 -0
- data/kinde_api/docs/UpdateOrganizationRequest.md +3 -1
- data/kinde_api/docs/UpdateOrganizationUsersRequest.md +1 -1
- data/kinde_api/docs/UpdateRolePermissionsRequest.md +18 -0
- data/kinde_api/docs/UpdateRolePermissionsRequestPermissionsInner.md +20 -0
- data/kinde_api/docs/UpdateRolePermissionsResponse.md +24 -0
- data/kinde_api/docs/UpdateRolesRequest.md +24 -0
- data/kinde_api/docs/UpdateUserResponse.md +30 -0
- data/kinde_api/docs/User.md +7 -7
- data/kinde_api/docs/UserIdentitiesInner.md +20 -0
- data/kinde_api/docs/UsersApi.md +93 -15
- data/kinde_api/docs/UsersResponse.md +1 -1
- data/kinde_api/docs/UsersResponseUsersInner.md +42 -0
- data/kinde_api/lib/kinde_api/api/apis_api.rb +347 -0
- data/kinde_api/lib/kinde_api/api/applications_api.rb +352 -0
- data/kinde_api/lib/kinde_api/api/business_api.rb +210 -0
- data/kinde_api/lib/kinde_api/api/callbacks_api.rb +394 -31
- data/kinde_api/lib/kinde_api/api/environments_api.rb +22 -18
- data/kinde_api/lib/kinde_api/api/feature_flags_api.rb +20 -61
- data/kinde_api/lib/kinde_api/api/industries_api.rb +85 -0
- data/kinde_api/lib/kinde_api/api/o_auth_api.rb +141 -2
- data/kinde_api/lib/kinde_api/api/organizations_api.rb +318 -25
- data/kinde_api/lib/kinde_api/api/permissions_api.rb +75 -12
- data/kinde_api/lib/kinde_api/api/roles_api.rb +297 -15
- data/kinde_api/lib/kinde_api/api/subscribers_api.rb +8 -11
- data/kinde_api/lib/kinde_api/api/timezones_api.rb +85 -0
- data/kinde_api/lib/kinde_api/api/users_api.rb +87 -11
- data/kinde_api/lib/kinde_api/api_client.rb +14 -7
- data/kinde_api/lib/kinde_api/configuration.rb +81 -5
- data/kinde_api/lib/kinde_api/models/add_apis_request.rb +238 -0
- data/kinde_api/lib/kinde_api/models/add_organization_users_request.rb +2 -0
- data/kinde_api/lib/kinde_api/models/add_organization_users_request_users_inner.rb +2 -0
- data/kinde_api/lib/kinde_api/models/add_organization_users_response.rb +2 -0
- data/kinde_api/lib/kinde_api/models/api.rb +271 -0
- data/kinde_api/lib/kinde_api/models/api_applications_inner.rb +246 -0
- data/kinde_api/lib/kinde_api/models/api_result.rb +2 -0
- data/kinde_api/lib/kinde_api/models/apis.rb +250 -0
- data/kinde_api/lib/kinde_api/models/applications.rb +237 -0
- data/kinde_api/lib/kinde_api/models/connected_apps_access_token.rb +2 -0
- data/kinde_api/lib/kinde_api/models/connected_apps_auth_url.rb +2 -0
- data/kinde_api/lib/kinde_api/models/create_application_request.rb +264 -0
- data/kinde_api/lib/kinde_api/models/create_application_response.rb +239 -0
- data/kinde_api/lib/kinde_api/models/create_application_response_application.rb +240 -0
- data/kinde_api/lib/kinde_api/models/create_feature_flag_request.rb +336 -0
- data/kinde_api/lib/kinde_api/models/create_organization_request.rb +16 -4
- data/kinde_api/lib/kinde_api/models/create_organization_response.rb +2 -0
- data/kinde_api/lib/kinde_api/models/create_organization_response_organization.rb +2 -0
- data/kinde_api/lib/kinde_api/models/{application.rb → create_organization_user_permission_request.rb} +13 -19
- data/kinde_api/lib/kinde_api/models/create_organization_user_role_request.rb +2 -0
- data/kinde_api/lib/kinde_api/models/create_permission_request.rb +2 -0
- data/kinde_api/lib/kinde_api/models/create_role_request.rb +2 -0
- data/kinde_api/lib/kinde_api/models/create_subscriber_success_response.rb +2 -0
- data/kinde_api/lib/kinde_api/models/create_subscriber_success_response_subscriber.rb +2 -0
- data/kinde_api/lib/kinde_api/models/create_user_request.rb +2 -0
- data/kinde_api/lib/kinde_api/models/create_user_request_identities_inner.rb +2 -0
- data/kinde_api/lib/kinde_api/models/create_user_request_identities_inner_details.rb +2 -0
- data/kinde_api/lib/kinde_api/models/create_user_request_profile.rb +2 -0
- data/kinde_api/lib/kinde_api/models/create_user_response.rb +2 -0
- data/kinde_api/lib/kinde_api/models/error.rb +2 -0
- data/kinde_api/lib/kinde_api/models/error_response.rb +2 -0
- data/kinde_api/lib/kinde_api/models/get_application_response.rb +239 -0
- data/kinde_api/lib/kinde_api/models/get_application_response_application.rb +260 -0
- data/kinde_api/lib/kinde_api/models/get_applications_response.rb +10 -8
- data/kinde_api/lib/kinde_api/models/get_environment_feature_flags_response.rb +2 -0
- data/kinde_api/lib/kinde_api/models/get_organization_feature_flags_response.rb +2 -0
- data/kinde_api/lib/kinde_api/models/get_organization_feature_flags_response_feature_flags_value.rb +2 -0
- data/kinde_api/lib/kinde_api/models/{get_organizations_users_response.rb → get_organization_users_response.rb} +5 -3
- data/kinde_api/lib/kinde_api/models/get_organizations_response.rb +2 -0
- data/kinde_api/lib/kinde_api/models/get_organizations_user_permissions_response.rb +241 -0
- data/kinde_api/lib/kinde_api/models/get_organizations_user_roles_response.rb +2 -0
- data/kinde_api/lib/kinde_api/models/get_permissions_response.rb +251 -0
- data/kinde_api/lib/kinde_api/models/get_redirect_callback_urls_response.rb +2 -0
- data/kinde_api/lib/kinde_api/models/get_roles_response.rb +251 -0
- data/kinde_api/lib/kinde_api/models/get_subscriber_response.rb +241 -0
- data/kinde_api/lib/kinde_api/models/get_subscribers_response.rb +251 -0
- data/kinde_api/lib/kinde_api/models/logout_redirect_urls.rb +222 -0
- data/kinde_api/lib/kinde_api/models/organization.rb +15 -4
- data/kinde_api/lib/kinde_api/models/organization_user.rb +2 -0
- data/kinde_api/lib/kinde_api/models/organization_user_permission.rb +257 -0
- data/kinde_api/lib/kinde_api/models/organization_user_permission_roles_inner.rb +228 -0
- data/kinde_api/lib/kinde_api/models/organization_user_role.rb +2 -0
- data/kinde_api/lib/kinde_api/models/organization_user_role_permissions.rb +237 -0
- data/kinde_api/lib/kinde_api/models/organization_user_role_permissions_permissions.rb +219 -0
- data/kinde_api/lib/kinde_api/models/permissions.rb +2 -0
- data/kinde_api/lib/kinde_api/models/redirect_callback_urls.rb +2 -0
- data/kinde_api/lib/kinde_api/models/replace_logout_redirect_urls_request.rb +222 -0
- data/kinde_api/lib/kinde_api/models/replace_redirect_callback_urls_request.rb +222 -0
- data/kinde_api/lib/kinde_api/models/role.rb +246 -0
- data/kinde_api/lib/kinde_api/models/roles.rb +13 -1
- data/kinde_api/lib/kinde_api/models/roles_permission_response_inner.rb +246 -0
- data/kinde_api/lib/kinde_api/models/subscriber.rb +246 -0
- data/kinde_api/lib/kinde_api/models/subscribers_subscriber.rb +255 -0
- data/kinde_api/lib/kinde_api/models/success_response.rb +2 -0
- data/kinde_api/lib/kinde_api/models/token_error_response.rb +230 -0
- data/kinde_api/lib/kinde_api/models/token_introspect.rb +262 -0
- data/kinde_api/lib/kinde_api/models/update_api_applications_request.rb +226 -0
- data/kinde_api/lib/kinde_api/models/update_api_applications_request_applications_inner.rb +235 -0
- data/kinde_api/lib/kinde_api/models/update_application_request.rb +254 -0
- data/kinde_api/lib/kinde_api/models/update_environement_feature_flag_override_request.rb +225 -0
- data/kinde_api/lib/kinde_api/models/update_organization_request.rb +16 -4
- data/kinde_api/lib/kinde_api/models/update_organization_users_request.rb +3 -1
- data/kinde_api/lib/kinde_api/models/update_organization_users_request_users_inner.rb +2 -0
- data/kinde_api/lib/kinde_api/models/update_organization_users_response.rb +2 -0
- data/kinde_api/lib/kinde_api/models/update_role_permissions_request.rb +222 -0
- data/kinde_api/lib/kinde_api/models/update_role_permissions_request_permissions_inner.rb +230 -0
- data/kinde_api/lib/kinde_api/models/update_role_permissions_response.rb +250 -0
- data/kinde_api/lib/kinde_api/models/update_roles_request.rb +260 -0
- data/kinde_api/lib/kinde_api/models/update_user_request.rb +2 -0
- data/kinde_api/lib/kinde_api/models/update_user_response.rb +280 -0
- data/kinde_api/lib/kinde_api/models/user.rb +37 -32
- data/kinde_api/lib/kinde_api/models/user_identities_inner.rb +228 -0
- data/kinde_api/lib/kinde_api/models/user_identity.rb +2 -0
- data/kinde_api/lib/kinde_api/models/user_identity_result.rb +2 -0
- data/kinde_api/lib/kinde_api/models/user_profile.rb +2 -0
- data/kinde_api/lib/kinde_api/models/user_profile_v2.rb +2 -0
- data/kinde_api/lib/kinde_api/models/users_response.rb +3 -1
- data/kinde_api/lib/kinde_api/models/users_response_users_inner.rb +348 -0
- data/kinde_api/lib/kinde_api.rb +47 -2
- data/kinde_api/spec/api/apis_api_spec.rb +95 -0
- data/kinde_api/spec/api/applications_api_spec.rb +98 -0
- data/kinde_api/spec/api/business_api_spec.rb +75 -0
- data/kinde_api/spec/api/callbacks_api_spec.rb +69 -5
- data/kinde_api/spec/api/environments_api_spec.rb +5 -5
- data/kinde_api/spec/api/feature_flags_api_spec.rb +4 -9
- data/kinde_api/spec/api/industries_api_spec.rb +48 -0
- data/kinde_api/spec/api/o_auth_api_spec.rb +28 -1
- data/kinde_api/spec/api/organizations_api_spec.rb +63 -8
- data/kinde_api/spec/api/permissions_api_spec.rb +16 -4
- data/kinde_api/spec/api/roles_api_spec.rb +57 -4
- data/kinde_api/spec/api/subscribers_api_spec.rb +3 -4
- data/kinde_api/spec/api/timezones_api_spec.rb +48 -0
- data/kinde_api/spec/api/users_api_spec.rb +17 -2
- data/kinde_api/spec/api_client_spec.rb +13 -2
- data/kinde_api/spec/models/{application_spec.rb → add_apis_request_spec.rb} +8 -8
- data/kinde_api/spec/models/api_applications_inner_spec.rb +52 -0
- data/kinde_api/spec/models/api_spec.rb +64 -0
- data/kinde_api/spec/models/apis_spec.rb +52 -0
- data/kinde_api/spec/models/applications_spec.rb +46 -0
- data/kinde_api/spec/models/create_application_request_spec.rb +44 -0
- data/kinde_api/spec/models/create_application_response_application_spec.rb +46 -0
- data/kinde_api/spec/models/create_application_response_spec.rb +46 -0
- data/kinde_api/spec/models/create_feature_flag_request_spec.rb +72 -0
- data/kinde_api/spec/models/create_organization_request_spec.rb +6 -0
- data/kinde_api/spec/models/create_organization_user_permission_request_spec.rb +34 -0
- data/kinde_api/spec/models/get_application_response_application_spec.rb +58 -0
- data/kinde_api/spec/models/get_application_response_spec.rb +46 -0
- data/kinde_api/spec/models/get_applications_response_spec.rb +1 -1
- data/kinde_api/spec/models/{get_organizations_users_response_spec.rb → get_organization_users_response_spec.rb} +6 -6
- data/kinde_api/spec/models/get_organizations_user_permissions_response_spec.rb +46 -0
- data/kinde_api/spec/models/get_permissions_response_spec.rb +52 -0
- data/kinde_api/spec/models/get_roles_response_spec.rb +52 -0
- data/kinde_api/spec/models/get_subscriber_response_spec.rb +46 -0
- data/kinde_api/spec/models/get_subscribers_response_spec.rb +52 -0
- data/kinde_api/spec/models/logout_redirect_urls_spec.rb +34 -0
- data/kinde_api/spec/models/organization_spec.rb +6 -0
- data/kinde_api/spec/models/organization_user_permission_roles_inner_spec.rb +40 -0
- data/kinde_api/spec/models/organization_user_permission_spec.rb +58 -0
- data/kinde_api/spec/models/organization_user_role_permissions_permissions_spec.rb +34 -0
- data/kinde_api/spec/models/organization_user_role_permissions_spec.rb +46 -0
- data/kinde_api/spec/models/replace_logout_redirect_urls_request_spec.rb +34 -0
- data/kinde_api/spec/models/replace_redirect_callback_urls_request_spec.rb +34 -0
- data/kinde_api/spec/models/role_spec.rb +52 -0
- data/kinde_api/spec/models/roles_permission_response_inner_spec.rb +52 -0
- data/kinde_api/spec/models/roles_spec.rb +6 -0
- data/kinde_api/spec/models/subscriber_spec.rb +52 -0
- data/kinde_api/spec/models/subscribers_subscriber_spec.rb +58 -0
- data/kinde_api/spec/models/token_error_response_spec.rb +40 -0
- data/kinde_api/spec/models/token_introspect_spec.rb +58 -0
- data/kinde_api/spec/models/update_api_applications_request_applications_inner_spec.rb +40 -0
- data/kinde_api/spec/models/update_api_applications_request_spec.rb +34 -0
- data/kinde_api/spec/models/update_application_request_spec.rb +52 -0
- data/kinde_api/spec/models/update_environement_feature_flag_override_request_spec.rb +34 -0
- data/kinde_api/spec/models/update_organization_request_spec.rb +6 -0
- data/kinde_api/spec/models/update_role_permissions_request_permissions_inner_spec.rb +40 -0
- data/kinde_api/spec/models/update_role_permissions_request_spec.rb +34 -0
- data/kinde_api/spec/models/update_role_permissions_response_spec.rb +52 -0
- data/kinde_api/spec/models/update_roles_request_spec.rb +52 -0
- data/kinde_api/spec/models/update_user_response_spec.rb +70 -0
- data/kinde_api/spec/models/user_identities_inner_spec.rb +40 -0
- data/kinde_api/spec/models/user_spec.rb +9 -9
- data/kinde_api/spec/models/users_response_users_inner_spec.rb +106 -0
- data/kinde_sdk.gemspec +1 -1
- data/lib/kinde_sdk/version.rb +1 -1
- data/spec/kinde_sdk_spec.rb +0 -46
- metadata +193 -12
- data/kinde_api/docs/Application.md +0 -20
|
@@ -4,18 +4,19 @@ All URIs are relative to *https://app.kinde.com*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**create_permission**](PermissionsApi.md#create_permission) | **POST** /api/v1/permissions | Create
|
|
7
|
+
| [**create_permission**](PermissionsApi.md#create_permission) | **POST** /api/v1/permissions | Create Permission |
|
|
8
|
+
| [**delete_permission**](PermissionsApi.md#delete_permission) | **DELETE** /api/v1/permissions/{permission_id} | Delete Permission |
|
|
8
9
|
| [**get_permissions**](PermissionsApi.md#get_permissions) | **GET** /api/v1/permissions | List Permissions |
|
|
9
|
-
| [**update_permissions**](PermissionsApi.md#update_permissions) | **PATCH** /api/v1/permissions/{permission_id} | Update
|
|
10
|
+
| [**update_permissions**](PermissionsApi.md#update_permissions) | **PATCH** /api/v1/permissions/{permission_id} | Update Permission |
|
|
10
11
|
|
|
11
12
|
|
|
12
13
|
## create_permission
|
|
13
14
|
|
|
14
15
|
> <SuccessResponse> create_permission(opts)
|
|
15
16
|
|
|
16
|
-
Create
|
|
17
|
+
Create Permission
|
|
17
18
|
|
|
18
|
-
Create permission.
|
|
19
|
+
Create a new permission.
|
|
19
20
|
|
|
20
21
|
### Examples
|
|
21
22
|
|
|
@@ -34,7 +35,7 @@ opts = {
|
|
|
34
35
|
}
|
|
35
36
|
|
|
36
37
|
begin
|
|
37
|
-
# Create
|
|
38
|
+
# Create Permission
|
|
38
39
|
result = api_instance.create_permission(opts)
|
|
39
40
|
p result
|
|
40
41
|
rescue KindeApi::ApiError => e
|
|
@@ -50,7 +51,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
50
51
|
|
|
51
52
|
```ruby
|
|
52
53
|
begin
|
|
53
|
-
# Create
|
|
54
|
+
# Create Permission
|
|
54
55
|
data, status_code, headers = api_instance.create_permission_with_http_info(opts)
|
|
55
56
|
p status_code # => 2xx
|
|
56
57
|
p headers # => { ... }
|
|
@@ -80,9 +81,78 @@ end
|
|
|
80
81
|
- **Accept**: application/json; charset=utf-8
|
|
81
82
|
|
|
82
83
|
|
|
84
|
+
## delete_permission
|
|
85
|
+
|
|
86
|
+
> <SuccessResponse> delete_permission(permission_id)
|
|
87
|
+
|
|
88
|
+
Delete Permission
|
|
89
|
+
|
|
90
|
+
Delete permission
|
|
91
|
+
|
|
92
|
+
### Examples
|
|
93
|
+
|
|
94
|
+
```ruby
|
|
95
|
+
require 'time'
|
|
96
|
+
require 'kinde_api'
|
|
97
|
+
# setup authorization
|
|
98
|
+
KindeApi.configure do |config|
|
|
99
|
+
# Configure Bearer authorization (JWT): kindeBearerAuth
|
|
100
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
101
|
+
end
|
|
102
|
+
|
|
103
|
+
api_instance = KindeApi::PermissionsApi.new
|
|
104
|
+
permission_id = 'permission_id_example' # String | The identifier for the permission.
|
|
105
|
+
|
|
106
|
+
begin
|
|
107
|
+
# Delete Permission
|
|
108
|
+
result = api_instance.delete_permission(permission_id)
|
|
109
|
+
p result
|
|
110
|
+
rescue KindeApi::ApiError => e
|
|
111
|
+
puts "Error when calling PermissionsApi->delete_permission: #{e}"
|
|
112
|
+
end
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
#### Using the delete_permission_with_http_info variant
|
|
116
|
+
|
|
117
|
+
This returns an Array which contains the response data, status code and headers.
|
|
118
|
+
|
|
119
|
+
> <Array(<SuccessResponse>, Integer, Hash)> delete_permission_with_http_info(permission_id)
|
|
120
|
+
|
|
121
|
+
```ruby
|
|
122
|
+
begin
|
|
123
|
+
# Delete Permission
|
|
124
|
+
data, status_code, headers = api_instance.delete_permission_with_http_info(permission_id)
|
|
125
|
+
p status_code # => 2xx
|
|
126
|
+
p headers # => { ... }
|
|
127
|
+
p data # => <SuccessResponse>
|
|
128
|
+
rescue KindeApi::ApiError => e
|
|
129
|
+
puts "Error when calling PermissionsApi->delete_permission_with_http_info: #{e}"
|
|
130
|
+
end
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
### Parameters
|
|
134
|
+
|
|
135
|
+
| Name | Type | Description | Notes |
|
|
136
|
+
| ---- | ---- | ----------- | ----- |
|
|
137
|
+
| **permission_id** | **String** | The identifier for the permission. | |
|
|
138
|
+
|
|
139
|
+
### Return type
|
|
140
|
+
|
|
141
|
+
[**SuccessResponse**](SuccessResponse.md)
|
|
142
|
+
|
|
143
|
+
### Authorization
|
|
144
|
+
|
|
145
|
+
[kindeBearerAuth](../README.md#kindeBearerAuth)
|
|
146
|
+
|
|
147
|
+
### HTTP request headers
|
|
148
|
+
|
|
149
|
+
- **Content-Type**: Not defined
|
|
150
|
+
- **Accept**: application/json, application/json; charset=utf-8
|
|
151
|
+
|
|
152
|
+
|
|
83
153
|
## get_permissions
|
|
84
154
|
|
|
85
|
-
> <
|
|
155
|
+
> <GetPermissionsResponse> get_permissions(opts)
|
|
86
156
|
|
|
87
157
|
List Permissions
|
|
88
158
|
|
|
@@ -119,7 +189,7 @@ end
|
|
|
119
189
|
|
|
120
190
|
This returns an Array which contains the response data, status code and headers.
|
|
121
191
|
|
|
122
|
-
> <Array(<
|
|
192
|
+
> <Array(<GetPermissionsResponse>, Integer, Hash)> get_permissions_with_http_info(opts)
|
|
123
193
|
|
|
124
194
|
```ruby
|
|
125
195
|
begin
|
|
@@ -127,7 +197,7 @@ begin
|
|
|
127
197
|
data, status_code, headers = api_instance.get_permissions_with_http_info(opts)
|
|
128
198
|
p status_code # => 2xx
|
|
129
199
|
p headers # => { ... }
|
|
130
|
-
p data # => <
|
|
200
|
+
p data # => <GetPermissionsResponse>
|
|
131
201
|
rescue KindeApi::ApiError => e
|
|
132
202
|
puts "Error when calling PermissionsApi->get_permissions_with_http_info: #{e}"
|
|
133
203
|
end
|
|
@@ -143,7 +213,7 @@ end
|
|
|
143
213
|
|
|
144
214
|
### Return type
|
|
145
215
|
|
|
146
|
-
[**
|
|
216
|
+
[**GetPermissionsResponse**](GetPermissionsResponse.md)
|
|
147
217
|
|
|
148
218
|
### Authorization
|
|
149
219
|
|
|
@@ -152,14 +222,14 @@ end
|
|
|
152
222
|
### HTTP request headers
|
|
153
223
|
|
|
154
224
|
- **Content-Type**: Not defined
|
|
155
|
-
- **Accept**: application/json; charset=utf-8
|
|
225
|
+
- **Accept**: application/json, application/json; charset=utf-8
|
|
156
226
|
|
|
157
227
|
|
|
158
228
|
## update_permissions
|
|
159
229
|
|
|
160
230
|
> <SuccessResponse> update_permissions(permission_id, opts)
|
|
161
231
|
|
|
162
|
-
Update
|
|
232
|
+
Update Permission
|
|
163
233
|
|
|
164
234
|
Update permission
|
|
165
235
|
|
|
@@ -181,7 +251,7 @@ opts = {
|
|
|
181
251
|
}
|
|
182
252
|
|
|
183
253
|
begin
|
|
184
|
-
# Update
|
|
254
|
+
# Update Permission
|
|
185
255
|
result = api_instance.update_permissions(permission_id, opts)
|
|
186
256
|
p result
|
|
187
257
|
rescue KindeApi::ApiError => e
|
|
@@ -197,7 +267,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
197
267
|
|
|
198
268
|
```ruby
|
|
199
269
|
begin
|
|
200
|
-
# Update
|
|
270
|
+
# Update Permission
|
|
201
271
|
data, status_code, headers = api_instance.update_permissions_with_http_info(permission_id, opts)
|
|
202
272
|
p status_code # => 2xx
|
|
203
273
|
p headers # => { ... }
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# KindeApi::ReplaceLogoutRedirectURLsRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **urls** | **Array<String>** | Array of logout urls. | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'kinde_api'
|
|
13
|
+
|
|
14
|
+
instance = KindeApi::ReplaceLogoutRedirectURLsRequest.new(
|
|
15
|
+
urls: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# KindeApi::ReplaceRedirectCallbackURLsRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **urls** | **Array<String>** | Array of callback urls. | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'kinde_api'
|
|
13
|
+
|
|
14
|
+
instance = KindeApi::ReplaceRedirectCallbackURLsRequest.new(
|
|
15
|
+
urls: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# KindeApi::Role
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | | [optional] |
|
|
8
|
+
| **key** | **String** | | [optional] |
|
|
9
|
+
| **name** | **String** | | [optional] |
|
|
10
|
+
| **description** | **String** | | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'kinde_api'
|
|
16
|
+
|
|
17
|
+
instance = KindeApi::Role.new(
|
|
18
|
+
id: null,
|
|
19
|
+
key: null,
|
|
20
|
+
name: null,
|
|
21
|
+
description: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
data/kinde_api/docs/Roles.md
CHANGED
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | The role's id. | [optional] |
|
|
7
8
|
| **key** | **String** | The role identifier to use in code. | [optional] |
|
|
8
9
|
| **name** | **String** | The role's name. | [optional] |
|
|
9
10
|
| **description** | **String** | The role's description. | [optional] |
|
|
@@ -14,6 +15,7 @@
|
|
|
14
15
|
require 'kinde_api'
|
|
15
16
|
|
|
16
17
|
instance = KindeApi::Roles.new(
|
|
18
|
+
id: null,
|
|
17
19
|
key: null,
|
|
18
20
|
name: null,
|
|
19
21
|
description: null
|
data/kinde_api/docs/RolesApi.md
CHANGED
|
@@ -4,16 +4,20 @@ All URIs are relative to *https://app.kinde.com*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
| ------ | ------------ | ----------- |
|
|
7
|
-
| [**create_role**](RolesApi.md#create_role) | **POST** /api/v1/role | Create
|
|
7
|
+
| [**create_role**](RolesApi.md#create_role) | **POST** /api/v1/role | Create Role |
|
|
8
|
+
| [**delete_role**](RolesApi.md#delete_role) | **DELETE** /api/v1/roles/{role_id} | Delete Role |
|
|
9
|
+
| [**get_role_permission**](RolesApi.md#get_role_permission) | **GET** /api/v1/roles/{role_id}/permissions | Get Role Permissions |
|
|
8
10
|
| [**get_roles**](RolesApi.md#get_roles) | **GET** /api/v1/roles | List Roles |
|
|
9
|
-
| [**
|
|
11
|
+
| [**remove_role_permission**](RolesApi.md#remove_role_permission) | **DELETE** /api/v1/roles/{role_id}/permissions/{permission_id} | Remove Role Permission |
|
|
12
|
+
| [**update_role_permissions**](RolesApi.md#update_role_permissions) | **PATCH** /api/v1/roles/{role_id}/permissions | Update Role Permissions |
|
|
13
|
+
| [**update_roles**](RolesApi.md#update_roles) | **PATCH** /api/v1/roles/{role_id} | Update Role |
|
|
10
14
|
|
|
11
15
|
|
|
12
16
|
## create_role
|
|
13
17
|
|
|
14
18
|
> <SuccessResponse> create_role(opts)
|
|
15
19
|
|
|
16
|
-
Create
|
|
20
|
+
Create Role
|
|
17
21
|
|
|
18
22
|
Create role.
|
|
19
23
|
|
|
@@ -34,7 +38,7 @@ opts = {
|
|
|
34
38
|
}
|
|
35
39
|
|
|
36
40
|
begin
|
|
37
|
-
# Create
|
|
41
|
+
# Create Role
|
|
38
42
|
result = api_instance.create_role(opts)
|
|
39
43
|
p result
|
|
40
44
|
rescue KindeApi::ApiError => e
|
|
@@ -50,7 +54,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
50
54
|
|
|
51
55
|
```ruby
|
|
52
56
|
begin
|
|
53
|
-
# Create
|
|
57
|
+
# Create Role
|
|
54
58
|
data, status_code, headers = api_instance.create_role_with_http_info(opts)
|
|
55
59
|
p status_code # => 2xx
|
|
56
60
|
p headers # => { ... }
|
|
@@ -80,9 +84,155 @@ end
|
|
|
80
84
|
- **Accept**: application/json; charset=utf-8
|
|
81
85
|
|
|
82
86
|
|
|
87
|
+
## delete_role
|
|
88
|
+
|
|
89
|
+
> <SuccessResponse> delete_role(role_id)
|
|
90
|
+
|
|
91
|
+
Delete Role
|
|
92
|
+
|
|
93
|
+
Delete role
|
|
94
|
+
|
|
95
|
+
### Examples
|
|
96
|
+
|
|
97
|
+
```ruby
|
|
98
|
+
require 'time'
|
|
99
|
+
require 'kinde_api'
|
|
100
|
+
# setup authorization
|
|
101
|
+
KindeApi.configure do |config|
|
|
102
|
+
# Configure Bearer authorization (JWT): kindeBearerAuth
|
|
103
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
104
|
+
end
|
|
105
|
+
|
|
106
|
+
api_instance = KindeApi::RolesApi.new
|
|
107
|
+
role_id = 'role_id_example' # String | The identifier for the role.
|
|
108
|
+
|
|
109
|
+
begin
|
|
110
|
+
# Delete Role
|
|
111
|
+
result = api_instance.delete_role(role_id)
|
|
112
|
+
p result
|
|
113
|
+
rescue KindeApi::ApiError => e
|
|
114
|
+
puts "Error when calling RolesApi->delete_role: #{e}"
|
|
115
|
+
end
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
#### Using the delete_role_with_http_info variant
|
|
119
|
+
|
|
120
|
+
This returns an Array which contains the response data, status code and headers.
|
|
121
|
+
|
|
122
|
+
> <Array(<SuccessResponse>, Integer, Hash)> delete_role_with_http_info(role_id)
|
|
123
|
+
|
|
124
|
+
```ruby
|
|
125
|
+
begin
|
|
126
|
+
# Delete Role
|
|
127
|
+
data, status_code, headers = api_instance.delete_role_with_http_info(role_id)
|
|
128
|
+
p status_code # => 2xx
|
|
129
|
+
p headers # => { ... }
|
|
130
|
+
p data # => <SuccessResponse>
|
|
131
|
+
rescue KindeApi::ApiError => e
|
|
132
|
+
puts "Error when calling RolesApi->delete_role_with_http_info: #{e}"
|
|
133
|
+
end
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
### Parameters
|
|
137
|
+
|
|
138
|
+
| Name | Type | Description | Notes |
|
|
139
|
+
| ---- | ---- | ----------- | ----- |
|
|
140
|
+
| **role_id** | **String** | The identifier for the role. | |
|
|
141
|
+
|
|
142
|
+
### Return type
|
|
143
|
+
|
|
144
|
+
[**SuccessResponse**](SuccessResponse.md)
|
|
145
|
+
|
|
146
|
+
### Authorization
|
|
147
|
+
|
|
148
|
+
[kindeBearerAuth](../README.md#kindeBearerAuth)
|
|
149
|
+
|
|
150
|
+
### HTTP request headers
|
|
151
|
+
|
|
152
|
+
- **Content-Type**: Not defined
|
|
153
|
+
- **Accept**: application/json, application/json; charset=utf-8
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
## get_role_permission
|
|
157
|
+
|
|
158
|
+
> <Array<RolesPermissionResponseInner>> get_role_permission(role_id, opts)
|
|
159
|
+
|
|
160
|
+
Get Role Permissions
|
|
161
|
+
|
|
162
|
+
Get permissions for a role.
|
|
163
|
+
|
|
164
|
+
### Examples
|
|
165
|
+
|
|
166
|
+
```ruby
|
|
167
|
+
require 'time'
|
|
168
|
+
require 'kinde_api'
|
|
169
|
+
# setup authorization
|
|
170
|
+
KindeApi.configure do |config|
|
|
171
|
+
# Configure Bearer authorization (JWT): kindeBearerAuth
|
|
172
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
173
|
+
end
|
|
174
|
+
|
|
175
|
+
api_instance = KindeApi::RolesApi.new
|
|
176
|
+
role_id = 'role_id_example' # String | The role's public id.
|
|
177
|
+
opts = {
|
|
178
|
+
sort: 'name_asc', # String | Field and order to sort the result by.
|
|
179
|
+
page_size: 56, # Integer | Number of results per page. Defaults to 10 if parameter not sent.
|
|
180
|
+
next_token: 'next_token_example' # String | A string to get the next page of results if there are more results.
|
|
181
|
+
}
|
|
182
|
+
|
|
183
|
+
begin
|
|
184
|
+
# Get Role Permissions
|
|
185
|
+
result = api_instance.get_role_permission(role_id, opts)
|
|
186
|
+
p result
|
|
187
|
+
rescue KindeApi::ApiError => e
|
|
188
|
+
puts "Error when calling RolesApi->get_role_permission: #{e}"
|
|
189
|
+
end
|
|
190
|
+
```
|
|
191
|
+
|
|
192
|
+
#### Using the get_role_permission_with_http_info variant
|
|
193
|
+
|
|
194
|
+
This returns an Array which contains the response data, status code and headers.
|
|
195
|
+
|
|
196
|
+
> <Array(<Array<RolesPermissionResponseInner>>, Integer, Hash)> get_role_permission_with_http_info(role_id, opts)
|
|
197
|
+
|
|
198
|
+
```ruby
|
|
199
|
+
begin
|
|
200
|
+
# Get Role Permissions
|
|
201
|
+
data, status_code, headers = api_instance.get_role_permission_with_http_info(role_id, opts)
|
|
202
|
+
p status_code # => 2xx
|
|
203
|
+
p headers # => { ... }
|
|
204
|
+
p data # => <Array<RolesPermissionResponseInner>>
|
|
205
|
+
rescue KindeApi::ApiError => e
|
|
206
|
+
puts "Error when calling RolesApi->get_role_permission_with_http_info: #{e}"
|
|
207
|
+
end
|
|
208
|
+
```
|
|
209
|
+
|
|
210
|
+
### Parameters
|
|
211
|
+
|
|
212
|
+
| Name | Type | Description | Notes |
|
|
213
|
+
| ---- | ---- | ----------- | ----- |
|
|
214
|
+
| **role_id** | **String** | The role's public id. | |
|
|
215
|
+
| **sort** | **String** | Field and order to sort the result by. | [optional] |
|
|
216
|
+
| **page_size** | **Integer** | Number of results per page. Defaults to 10 if parameter not sent. | [optional] |
|
|
217
|
+
| **next_token** | **String** | A string to get the next page of results if there are more results. | [optional] |
|
|
218
|
+
|
|
219
|
+
### Return type
|
|
220
|
+
|
|
221
|
+
[**Array<RolesPermissionResponseInner>**](RolesPermissionResponseInner.md)
|
|
222
|
+
|
|
223
|
+
### Authorization
|
|
224
|
+
|
|
225
|
+
[kindeBearerAuth](../README.md#kindeBearerAuth)
|
|
226
|
+
|
|
227
|
+
### HTTP request headers
|
|
228
|
+
|
|
229
|
+
- **Content-Type**: Not defined
|
|
230
|
+
- **Accept**: application/json, application/json; charset=utf-8
|
|
231
|
+
|
|
232
|
+
|
|
83
233
|
## get_roles
|
|
84
234
|
|
|
85
|
-
> <
|
|
235
|
+
> <GetRolesResponse> get_roles(opts)
|
|
86
236
|
|
|
87
237
|
List Roles
|
|
88
238
|
|
|
@@ -119,7 +269,7 @@ end
|
|
|
119
269
|
|
|
120
270
|
This returns an Array which contains the response data, status code and headers.
|
|
121
271
|
|
|
122
|
-
> <Array(<
|
|
272
|
+
> <Array(<GetRolesResponse>, Integer, Hash)> get_roles_with_http_info(opts)
|
|
123
273
|
|
|
124
274
|
```ruby
|
|
125
275
|
begin
|
|
@@ -127,7 +277,7 @@ begin
|
|
|
127
277
|
data, status_code, headers = api_instance.get_roles_with_http_info(opts)
|
|
128
278
|
p status_code # => 2xx
|
|
129
279
|
p headers # => { ... }
|
|
130
|
-
p data # => <
|
|
280
|
+
p data # => <GetRolesResponse>
|
|
131
281
|
rescue KindeApi::ApiError => e
|
|
132
282
|
puts "Error when calling RolesApi->get_roles_with_http_info: #{e}"
|
|
133
283
|
end
|
|
@@ -143,6 +293,77 @@ end
|
|
|
143
293
|
|
|
144
294
|
### Return type
|
|
145
295
|
|
|
296
|
+
[**GetRolesResponse**](GetRolesResponse.md)
|
|
297
|
+
|
|
298
|
+
### Authorization
|
|
299
|
+
|
|
300
|
+
[kindeBearerAuth](../README.md#kindeBearerAuth)
|
|
301
|
+
|
|
302
|
+
### HTTP request headers
|
|
303
|
+
|
|
304
|
+
- **Content-Type**: Not defined
|
|
305
|
+
- **Accept**: application/json, application/json; charset=utf-8
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
## remove_role_permission
|
|
309
|
+
|
|
310
|
+
> <SuccessResponse> remove_role_permission(role_id, permission_id)
|
|
311
|
+
|
|
312
|
+
Remove Role Permission
|
|
313
|
+
|
|
314
|
+
Remove a permission from a role.
|
|
315
|
+
|
|
316
|
+
### Examples
|
|
317
|
+
|
|
318
|
+
```ruby
|
|
319
|
+
require 'time'
|
|
320
|
+
require 'kinde_api'
|
|
321
|
+
# setup authorization
|
|
322
|
+
KindeApi.configure do |config|
|
|
323
|
+
# Configure Bearer authorization (JWT): kindeBearerAuth
|
|
324
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
325
|
+
end
|
|
326
|
+
|
|
327
|
+
api_instance = KindeApi::RolesApi.new
|
|
328
|
+
role_id = 'role_id_example' # String | The role's public id.
|
|
329
|
+
permission_id = 'permission_id_example' # String | The permission's public id.
|
|
330
|
+
|
|
331
|
+
begin
|
|
332
|
+
# Remove Role Permission
|
|
333
|
+
result = api_instance.remove_role_permission(role_id, permission_id)
|
|
334
|
+
p result
|
|
335
|
+
rescue KindeApi::ApiError => e
|
|
336
|
+
puts "Error when calling RolesApi->remove_role_permission: #{e}"
|
|
337
|
+
end
|
|
338
|
+
```
|
|
339
|
+
|
|
340
|
+
#### Using the remove_role_permission_with_http_info variant
|
|
341
|
+
|
|
342
|
+
This returns an Array which contains the response data, status code and headers.
|
|
343
|
+
|
|
344
|
+
> <Array(<SuccessResponse>, Integer, Hash)> remove_role_permission_with_http_info(role_id, permission_id)
|
|
345
|
+
|
|
346
|
+
```ruby
|
|
347
|
+
begin
|
|
348
|
+
# Remove Role Permission
|
|
349
|
+
data, status_code, headers = api_instance.remove_role_permission_with_http_info(role_id, permission_id)
|
|
350
|
+
p status_code # => 2xx
|
|
351
|
+
p headers # => { ... }
|
|
352
|
+
p data # => <SuccessResponse>
|
|
353
|
+
rescue KindeApi::ApiError => e
|
|
354
|
+
puts "Error when calling RolesApi->remove_role_permission_with_http_info: #{e}"
|
|
355
|
+
end
|
|
356
|
+
```
|
|
357
|
+
|
|
358
|
+
### Parameters
|
|
359
|
+
|
|
360
|
+
| Name | Type | Description | Notes |
|
|
361
|
+
| ---- | ---- | ----------- | ----- |
|
|
362
|
+
| **role_id** | **String** | The role's public id. | |
|
|
363
|
+
| **permission_id** | **String** | The permission's public id. | |
|
|
364
|
+
|
|
365
|
+
### Return type
|
|
366
|
+
|
|
146
367
|
[**SuccessResponse**](SuccessResponse.md)
|
|
147
368
|
|
|
148
369
|
### Authorization
|
|
@@ -152,16 +373,87 @@ end
|
|
|
152
373
|
### HTTP request headers
|
|
153
374
|
|
|
154
375
|
- **Content-Type**: Not defined
|
|
155
|
-
- **Accept**: application/json; charset=utf-8
|
|
376
|
+
- **Accept**: application/json, application/json; charset=utf-8
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
## update_role_permissions
|
|
380
|
+
|
|
381
|
+
> <UpdateRolePermissionsResponse> update_role_permissions(role_id, update_role_permissions_request)
|
|
382
|
+
|
|
383
|
+
Update Role Permissions
|
|
384
|
+
|
|
385
|
+
Update role permissions.
|
|
386
|
+
|
|
387
|
+
### Examples
|
|
388
|
+
|
|
389
|
+
```ruby
|
|
390
|
+
require 'time'
|
|
391
|
+
require 'kinde_api'
|
|
392
|
+
# setup authorization
|
|
393
|
+
KindeApi.configure do |config|
|
|
394
|
+
# Configure Bearer authorization (JWT): kindeBearerAuth
|
|
395
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
396
|
+
end
|
|
397
|
+
|
|
398
|
+
api_instance = KindeApi::RolesApi.new
|
|
399
|
+
role_id = 'role_id_example' # String | The identifier for the role.
|
|
400
|
+
update_role_permissions_request = KindeApi::UpdateRolePermissionsRequest.new # UpdateRolePermissionsRequest |
|
|
401
|
+
|
|
402
|
+
begin
|
|
403
|
+
# Update Role Permissions
|
|
404
|
+
result = api_instance.update_role_permissions(role_id, update_role_permissions_request)
|
|
405
|
+
p result
|
|
406
|
+
rescue KindeApi::ApiError => e
|
|
407
|
+
puts "Error when calling RolesApi->update_role_permissions: #{e}"
|
|
408
|
+
end
|
|
409
|
+
```
|
|
410
|
+
|
|
411
|
+
#### Using the update_role_permissions_with_http_info variant
|
|
412
|
+
|
|
413
|
+
This returns an Array which contains the response data, status code and headers.
|
|
414
|
+
|
|
415
|
+
> <Array(<UpdateRolePermissionsResponse>, Integer, Hash)> update_role_permissions_with_http_info(role_id, update_role_permissions_request)
|
|
416
|
+
|
|
417
|
+
```ruby
|
|
418
|
+
begin
|
|
419
|
+
# Update Role Permissions
|
|
420
|
+
data, status_code, headers = api_instance.update_role_permissions_with_http_info(role_id, update_role_permissions_request)
|
|
421
|
+
p status_code # => 2xx
|
|
422
|
+
p headers # => { ... }
|
|
423
|
+
p data # => <UpdateRolePermissionsResponse>
|
|
424
|
+
rescue KindeApi::ApiError => e
|
|
425
|
+
puts "Error when calling RolesApi->update_role_permissions_with_http_info: #{e}"
|
|
426
|
+
end
|
|
427
|
+
```
|
|
428
|
+
|
|
429
|
+
### Parameters
|
|
430
|
+
|
|
431
|
+
| Name | Type | Description | Notes |
|
|
432
|
+
| ---- | ---- | ----------- | ----- |
|
|
433
|
+
| **role_id** | **String** | The identifier for the role. | |
|
|
434
|
+
| **update_role_permissions_request** | [**UpdateRolePermissionsRequest**](UpdateRolePermissionsRequest.md) | | |
|
|
435
|
+
|
|
436
|
+
### Return type
|
|
437
|
+
|
|
438
|
+
[**UpdateRolePermissionsResponse**](UpdateRolePermissionsResponse.md)
|
|
439
|
+
|
|
440
|
+
### Authorization
|
|
441
|
+
|
|
442
|
+
[kindeBearerAuth](../README.md#kindeBearerAuth)
|
|
443
|
+
|
|
444
|
+
### HTTP request headers
|
|
445
|
+
|
|
446
|
+
- **Content-Type**: application/json
|
|
447
|
+
- **Accept**: application/json, application/json; charset=utf-8
|
|
156
448
|
|
|
157
449
|
|
|
158
450
|
## update_roles
|
|
159
451
|
|
|
160
452
|
> <SuccessResponse> update_roles(role_id, opts)
|
|
161
453
|
|
|
162
|
-
Update
|
|
454
|
+
Update Role
|
|
163
455
|
|
|
164
|
-
Update role
|
|
456
|
+
Update a role
|
|
165
457
|
|
|
166
458
|
### Examples
|
|
167
459
|
|
|
@@ -175,13 +467,13 @@ KindeApi.configure do |config|
|
|
|
175
467
|
end
|
|
176
468
|
|
|
177
469
|
api_instance = KindeApi::RolesApi.new
|
|
178
|
-
role_id =
|
|
470
|
+
role_id = 'role_id_example' # String | The identifier for the role.
|
|
179
471
|
opts = {
|
|
180
|
-
|
|
472
|
+
update_roles_request: KindeApi::UpdateRolesRequest.new({name: 'name_example', key: 'key_example'}) # UpdateRolesRequest | Role details.
|
|
181
473
|
}
|
|
182
474
|
|
|
183
475
|
begin
|
|
184
|
-
# Update
|
|
476
|
+
# Update Role
|
|
185
477
|
result = api_instance.update_roles(role_id, opts)
|
|
186
478
|
p result
|
|
187
479
|
rescue KindeApi::ApiError => e
|
|
@@ -197,7 +489,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
197
489
|
|
|
198
490
|
```ruby
|
|
199
491
|
begin
|
|
200
|
-
# Update
|
|
492
|
+
# Update Role
|
|
201
493
|
data, status_code, headers = api_instance.update_roles_with_http_info(role_id, opts)
|
|
202
494
|
p status_code # => 2xx
|
|
203
495
|
p headers # => { ... }
|
|
@@ -211,8 +503,8 @@ end
|
|
|
211
503
|
|
|
212
504
|
| Name | Type | Description | Notes |
|
|
213
505
|
| ---- | ---- | ----------- | ----- |
|
|
214
|
-
| **role_id** | **
|
|
215
|
-
| **
|
|
506
|
+
| **role_id** | **String** | The identifier for the role. | |
|
|
507
|
+
| **update_roles_request** | [**UpdateRolesRequest**](UpdateRolesRequest.md) | Role details. | [optional] |
|
|
216
508
|
|
|
217
509
|
### Return type
|
|
218
510
|
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# KindeApi::RolesPermissionResponseInner
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | | [optional] |
|
|
8
|
+
| **key** | **String** | | [optional] |
|
|
9
|
+
| **name** | **String** | | [optional] |
|
|
10
|
+
| **description** | **String** | | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'kinde_api'
|
|
16
|
+
|
|
17
|
+
instance = KindeApi::RolesPermissionResponseInner.new(
|
|
18
|
+
id: null,
|
|
19
|
+
key: null,
|
|
20
|
+
name: null,
|
|
21
|
+
description: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|