ory-keto-client 0.0.0.alpha58 → 0.4.0.alpha1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +1 -1
- data/README.md +19 -5
- data/docs/AddOryAccessControlPolicyRoleMembersBody.md +7 -8
- data/docs/AuthorizationResult.md +7 -8
- data/docs/EnginesApi.md +129 -319
- data/docs/HealthApi.md +15 -50
- data/docs/HealthNotReadyStatus.md +7 -8
- data/docs/HealthStatus.md +7 -8
- data/docs/InlineResponse500.md +17 -18
- data/docs/OryAccessControlPolicy.md +19 -20
- data/docs/OryAccessControlPolicyAllowedInput.md +13 -14
- data/docs/OryAccessControlPolicyRole.md +9 -10
- data/docs/Version.md +7 -8
- data/docs/VersionApi.md +9 -26
- data/lib/ory-keto-client.rb +16 -2
- data/lib/ory-keto-client/api/engines_api.rb +35 -46
- data/lib/ory-keto-client/api/health_api.rb +8 -10
- data/lib/ory-keto-client/api/version_api.rb +5 -6
- data/lib/ory-keto-client/api_client.rb +46 -50
- data/lib/ory-keto-client/api_error.rb +2 -2
- data/lib/ory-keto-client/configuration.rb +7 -34
- data/lib/ory-keto-client/models/add_ory_access_control_policy_role_members_body.rb +8 -20
- data/lib/ory-keto-client/models/add_ory_access_control_policy_role_members_internal_server_error_body.rb +2 -2
- data/lib/ory-keto-client/models/authorization_result.rb +8 -20
- data/lib/ory-keto-client/models/delete_ory_access_control_policy_internal_server_error_body.rb +3 -3
- data/lib/ory-keto-client/models/delete_ory_access_control_policy_role_internal_server_error_body.rb +2 -2
- data/lib/ory-keto-client/models/do_ory_access_control_policies_allow_internal_server_error_body.rb +3 -3
- data/lib/ory-keto-client/models/get_ory_access_control_policy_internal_server_error_body.rb +3 -3
- data/lib/ory-keto-client/models/get_ory_access_control_policy_not_found_body.rb +3 -3
- data/lib/ory-keto-client/models/get_ory_access_control_policy_role_internal_server_error_body.rb +2 -2
- data/lib/ory-keto-client/models/get_ory_access_control_policy_role_not_found_body.rb +3 -3
- data/lib/ory-keto-client/models/health_not_ready_status.rb +8 -20
- data/lib/ory-keto-client/models/health_status.rb +8 -20
- data/lib/ory-keto-client/models/inline_response500.rb +9 -21
- data/lib/ory-keto-client/models/is_instance_alive_internal_server_error_body.rb +2 -2
- data/lib/ory-keto-client/models/list_ory_access_control_policies_internal_server_error_body.rb +3 -3
- data/lib/ory-keto-client/models/list_ory_access_control_policy_roles_internal_server_error_body.rb +3 -3
- data/lib/ory-keto-client/models/ory_access_control_policy.rb +12 -22
- data/lib/ory-keto-client/models/ory_access_control_policy_allowed_input.rb +12 -22
- data/lib/ory-keto-client/models/ory_access_control_policy_role.rb +8 -20
- data/lib/ory-keto-client/models/remove_ory_access_control_policy_role_members_internal_server_error_body.rb +2 -2
- data/lib/ory-keto-client/models/upsert_ory_access_control_policy_internal_server_error_body.rb +3 -3
- data/lib/ory-keto-client/models/upsert_ory_access_control_policy_role_internal_server_error_body.rb +2 -2
- data/lib/ory-keto-client/models/version.rb +9 -20
- data/lib/ory-keto-client/version.rb +3 -3
- data/ory-keto-client.gemspec +5 -4
- data/spec/api_client_spec.rb +4 -4
- data/spec/configuration_spec.rb +3 -3
- data/spec/spec_helper.rb +3 -3
- metadata +79 -59
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 780ff8799190eaa86ada2def3d824f70e296b000b51f62e4966b81b744c47fac
|
4
|
+
data.tar.gz: 7bc84653964cce9405e8aca6b3c5daf166c6f417b0b98aa942547765b1b4b725
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1427eeb482e51f9c1745915624222c8eeffe4736eda25a0664702e0325246feb4e473e540d2bb6d2b83aa45b04e5b3022f539c6c93210440560002a10495084a
|
7
|
+
data.tar.gz: '07639d4f4b71da60e22450213fd2a4ddaa12aef084743135012eda2562fcc58b3dccce78195dd6856bde5c6cf4122a2295c53711802b7a71213dad3a1af39cd2'
|
data/Gemfile
CHANGED
data/README.md
CHANGED
@@ -6,8 +6,8 @@ Ory Keto is a cloud native access control server providing best-practice pattern
|
|
6
6
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
|
-
- API version:
|
10
|
-
- Package version: v0.
|
9
|
+
- API version: Latest
|
10
|
+
- Package version: v0.4.0-alpha.1
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [https://www.ory.sh](https://www.ory.sh)
|
13
13
|
|
@@ -24,16 +24,16 @@ gem build ory-keto-client.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./ory-keto-client-v0.
|
27
|
+
gem install ./ory-keto-client-v0.4.0-alpha.1.gem
|
28
28
|
```
|
29
29
|
|
30
|
-
(for development, run `gem install --dev ./ory-keto-client-v0.
|
30
|
+
(for development, run `gem install --dev ./ory-keto-client-v0.4.0-alpha.1.gem` to install the development dependencies)
|
31
31
|
|
32
32
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
33
33
|
|
34
34
|
Finally add this to the Gemfile:
|
35
35
|
|
36
|
-
gem 'ory-keto-client', '~> v0.
|
36
|
+
gem 'ory-keto-client', '~> v0.4.0-alpha.1'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -99,13 +99,27 @@ Class | Method | HTTP request | Description
|
|
99
99
|
## Documentation for Models
|
100
100
|
|
101
101
|
- [OryHydraClient::AddOryAccessControlPolicyRoleMembersBody](docs/AddOryAccessControlPolicyRoleMembersBody.md)
|
102
|
+
- [OryHydraClient::AddOryAccessControlPolicyRoleMembersInternalServerErrorBody](docs/AddOryAccessControlPolicyRoleMembersInternalServerErrorBody.md)
|
102
103
|
- [OryHydraClient::AuthorizationResult](docs/AuthorizationResult.md)
|
104
|
+
- [OryHydraClient::DeleteOryAccessControlPolicyInternalServerErrorBody](docs/DeleteOryAccessControlPolicyInternalServerErrorBody.md)
|
105
|
+
- [OryHydraClient::DeleteOryAccessControlPolicyRoleInternalServerErrorBody](docs/DeleteOryAccessControlPolicyRoleInternalServerErrorBody.md)
|
106
|
+
- [OryHydraClient::DoOryAccessControlPoliciesAllowInternalServerErrorBody](docs/DoOryAccessControlPoliciesAllowInternalServerErrorBody.md)
|
107
|
+
- [OryHydraClient::GetOryAccessControlPolicyInternalServerErrorBody](docs/GetOryAccessControlPolicyInternalServerErrorBody.md)
|
108
|
+
- [OryHydraClient::GetOryAccessControlPolicyNotFoundBody](docs/GetOryAccessControlPolicyNotFoundBody.md)
|
109
|
+
- [OryHydraClient::GetOryAccessControlPolicyRoleInternalServerErrorBody](docs/GetOryAccessControlPolicyRoleInternalServerErrorBody.md)
|
110
|
+
- [OryHydraClient::GetOryAccessControlPolicyRoleNotFoundBody](docs/GetOryAccessControlPolicyRoleNotFoundBody.md)
|
103
111
|
- [OryHydraClient::HealthNotReadyStatus](docs/HealthNotReadyStatus.md)
|
104
112
|
- [OryHydraClient::HealthStatus](docs/HealthStatus.md)
|
105
113
|
- [OryHydraClient::InlineResponse500](docs/InlineResponse500.md)
|
114
|
+
- [OryHydraClient::IsInstanceAliveInternalServerErrorBody](docs/IsInstanceAliveInternalServerErrorBody.md)
|
115
|
+
- [OryHydraClient::ListOryAccessControlPoliciesInternalServerErrorBody](docs/ListOryAccessControlPoliciesInternalServerErrorBody.md)
|
116
|
+
- [OryHydraClient::ListOryAccessControlPolicyRolesInternalServerErrorBody](docs/ListOryAccessControlPolicyRolesInternalServerErrorBody.md)
|
106
117
|
- [OryHydraClient::OryAccessControlPolicy](docs/OryAccessControlPolicy.md)
|
107
118
|
- [OryHydraClient::OryAccessControlPolicyAllowedInput](docs/OryAccessControlPolicyAllowedInput.md)
|
108
119
|
- [OryHydraClient::OryAccessControlPolicyRole](docs/OryAccessControlPolicyRole.md)
|
120
|
+
- [OryHydraClient::RemoveOryAccessControlPolicyRoleMembersInternalServerErrorBody](docs/RemoveOryAccessControlPolicyRoleMembersInternalServerErrorBody.md)
|
121
|
+
- [OryHydraClient::UpsertOryAccessControlPolicyInternalServerErrorBody](docs/UpsertOryAccessControlPolicyInternalServerErrorBody.md)
|
122
|
+
- [OryHydraClient::UpsertOryAccessControlPolicyRoleInternalServerErrorBody](docs/UpsertOryAccessControlPolicyRoleInternalServerErrorBody.md)
|
109
123
|
- [OryHydraClient::Version](docs/Version.md)
|
110
124
|
|
111
125
|
|
@@ -2,17 +2,16 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
|
6
|
-
|
7
|
-
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**members** | **Array<String>** | The members to be added. | [optional]
|
8
8
|
|
9
|
-
##
|
9
|
+
## Code Sample
|
10
10
|
|
11
11
|
```ruby
|
12
|
-
require '
|
12
|
+
require 'OryHydraClient'
|
13
13
|
|
14
|
-
instance = OryHydraClient::AddOryAccessControlPolicyRoleMembersBody.new(
|
15
|
-
members: null
|
16
|
-
)
|
14
|
+
instance = OryHydraClient::AddOryAccessControlPolicyRoleMembersBody.new(members: null)
|
17
15
|
```
|
18
16
|
|
17
|
+
|
data/docs/AuthorizationResult.md
CHANGED
@@ -2,17 +2,16 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
|
6
|
-
|
7
|
-
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**allowed** | **Boolean** | Allowed is true if the request should be allowed and false otherwise. |
|
8
8
|
|
9
|
-
##
|
9
|
+
## Code Sample
|
10
10
|
|
11
11
|
```ruby
|
12
|
-
require '
|
12
|
+
require 'OryHydraClient'
|
13
13
|
|
14
|
-
instance = OryHydraClient::AuthorizationResult.new(
|
15
|
-
allowed: null
|
16
|
-
)
|
14
|
+
instance = OryHydraClient::AuthorizationResult.new(allowed: null)
|
17
15
|
```
|
18
16
|
|
17
|
+
|
data/docs/EnginesApi.md
CHANGED
@@ -2,33 +2,34 @@
|
|
2
2
|
|
3
3
|
All URIs are relative to *http://localhost*
|
4
4
|
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**add_ory_access_control_policy_role_members**](EnginesApi.md#add_ory_access_control_policy_role_members) | **PUT** /engines/acp/ory/{flavor}/roles/{id}/members | Add a member to an ORY Access Control Policy Role
|
8
|
+
[**delete_ory_access_control_policy**](EnginesApi.md#delete_ory_access_control_policy) | **DELETE** /engines/acp/ory/{flavor}/policies/{id} |
|
9
|
+
[**delete_ory_access_control_policy_role**](EnginesApi.md#delete_ory_access_control_policy_role) | **DELETE** /engines/acp/ory/{flavor}/roles/{id} | Delete an ORY Access Control Policy Role
|
10
|
+
[**do_ory_access_control_policies_allow**](EnginesApi.md#do_ory_access_control_policies_allow) | **POST** /engines/acp/ory/{flavor}/allowed | Check if a request is allowed
|
11
|
+
[**get_ory_access_control_policy**](EnginesApi.md#get_ory_access_control_policy) | **GET** /engines/acp/ory/{flavor}/policies/{id} |
|
12
|
+
[**get_ory_access_control_policy_role**](EnginesApi.md#get_ory_access_control_policy_role) | **GET** /engines/acp/ory/{flavor}/roles/{id} | Get an ORY Access Control Policy Role
|
13
|
+
[**list_ory_access_control_policies**](EnginesApi.md#list_ory_access_control_policies) | **GET** /engines/acp/ory/{flavor}/policies |
|
14
|
+
[**list_ory_access_control_policy_roles**](EnginesApi.md#list_ory_access_control_policy_roles) | **GET** /engines/acp/ory/{flavor}/roles | List ORY Access Control Policy Roles
|
15
|
+
[**remove_ory_access_control_policy_role_members**](EnginesApi.md#remove_ory_access_control_policy_role_members) | **DELETE** /engines/acp/ory/{flavor}/roles/{id}/members/{member} | Remove a member from an ORY Access Control Policy Role
|
16
|
+
[**upsert_ory_access_control_policy**](EnginesApi.md#upsert_ory_access_control_policy) | **PUT** /engines/acp/ory/{flavor}/policies |
|
17
|
+
[**upsert_ory_access_control_policy_role**](EnginesApi.md#upsert_ory_access_control_policy_role) | **PUT** /engines/acp/ory/{flavor}/roles | Upsert an ORY Access Control Policy Role
|
18
|
+
|
18
19
|
|
19
20
|
|
20
21
|
## add_ory_access_control_policy_role_members
|
21
22
|
|
22
|
-
>
|
23
|
+
> OryAccessControlPolicyRole add_ory_access_control_policy_role_members(flavor, id, opts)
|
23
24
|
|
24
25
|
Add a member to an ORY Access Control Policy Role
|
25
26
|
|
26
27
|
Roles group several subjects into one. Rules can be assigned to ORY Access Control Policy (OACP) by using the Role ID as subject in the OACP.
|
27
28
|
|
28
|
-
###
|
29
|
+
### Example
|
29
30
|
|
30
31
|
```ruby
|
31
|
-
|
32
|
+
# load the gem
|
32
33
|
require 'ory-keto-client'
|
33
34
|
|
34
35
|
api_instance = OryHydraClient::EnginesApi.new
|
@@ -39,39 +40,22 @@ opts = {
|
|
39
40
|
}
|
40
41
|
|
41
42
|
begin
|
42
|
-
#
|
43
|
+
#Add a member to an ORY Access Control Policy Role
|
43
44
|
result = api_instance.add_ory_access_control_policy_role_members(flavor, id, opts)
|
44
45
|
p result
|
45
46
|
rescue OryHydraClient::ApiError => e
|
46
|
-
puts "
|
47
|
-
end
|
48
|
-
```
|
49
|
-
|
50
|
-
#### Using the add_ory_access_control_policy_role_members_with_http_info variant
|
51
|
-
|
52
|
-
This returns an Array which contains the response data, status code and headers.
|
53
|
-
|
54
|
-
> <Array(<OryAccessControlPolicyRole>, Integer, Hash)> add_ory_access_control_policy_role_members_with_http_info(flavor, id, opts)
|
55
|
-
|
56
|
-
```ruby
|
57
|
-
begin
|
58
|
-
# Add a member to an ORY Access Control Policy Role
|
59
|
-
data, status_code, headers = api_instance.add_ory_access_control_policy_role_members_with_http_info(flavor, id, opts)
|
60
|
-
p status_code # => 2xx
|
61
|
-
p headers # => { ... }
|
62
|
-
p data # => <OryAccessControlPolicyRole>
|
63
|
-
rescue OryHydraClient::ApiError => e
|
64
|
-
puts "Error when calling EnginesApi->add_ory_access_control_policy_role_members_with_http_info: #{e}"
|
47
|
+
puts "Exception when calling EnginesApi->add_ory_access_control_policy_role_members: #{e}"
|
65
48
|
end
|
66
49
|
```
|
67
50
|
|
68
51
|
### Parameters
|
69
52
|
|
70
|
-
|
71
|
-
|
72
|
-
|
|
73
|
-
|
74
|
-
|
53
|
+
|
54
|
+
Name | Type | Description | Notes
|
55
|
+
------------- | ------------- | ------------- | -------------
|
56
|
+
**flavor** | **String**| The ORY Access Control Policy flavor. Can be \"regex\", \"glob\", and \"exact\". |
|
57
|
+
**id** | **String**| The ID of the ORY Access Control Policy Role. |
|
58
|
+
**body** | [**AddOryAccessControlPolicyRoleMembersBody**](AddOryAccessControlPolicyRoleMembersBody.md)| | [optional]
|
75
59
|
|
76
60
|
### Return type
|
77
61
|
|
@@ -95,10 +79,10 @@ No authorization required
|
|
95
79
|
|
96
80
|
Delete an ORY Access Control Policy
|
97
81
|
|
98
|
-
###
|
82
|
+
### Example
|
99
83
|
|
100
84
|
```ruby
|
101
|
-
|
85
|
+
# load the gem
|
102
86
|
require 'ory-keto-client'
|
103
87
|
|
104
88
|
api_instance = OryHydraClient::EnginesApi.new
|
@@ -106,37 +90,19 @@ flavor = 'flavor_example' # String | The ORY Access Control Policy flavor. Can b
|
|
106
90
|
id = 'id_example' # String | The ID of the ORY Access Control Policy Role.
|
107
91
|
|
108
92
|
begin
|
109
|
-
|
110
93
|
api_instance.delete_ory_access_control_policy(flavor, id)
|
111
94
|
rescue OryHydraClient::ApiError => e
|
112
|
-
puts "
|
113
|
-
end
|
114
|
-
```
|
115
|
-
|
116
|
-
#### Using the delete_ory_access_control_policy_with_http_info variant
|
117
|
-
|
118
|
-
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
119
|
-
|
120
|
-
> <Array(nil, Integer, Hash)> delete_ory_access_control_policy_with_http_info(flavor, id)
|
121
|
-
|
122
|
-
```ruby
|
123
|
-
begin
|
124
|
-
|
125
|
-
data, status_code, headers = api_instance.delete_ory_access_control_policy_with_http_info(flavor, id)
|
126
|
-
p status_code # => 2xx
|
127
|
-
p headers # => { ... }
|
128
|
-
p data # => nil
|
129
|
-
rescue OryHydraClient::ApiError => e
|
130
|
-
puts "Error when calling EnginesApi->delete_ory_access_control_policy_with_http_info: #{e}"
|
95
|
+
puts "Exception when calling EnginesApi->delete_ory_access_control_policy: #{e}"
|
131
96
|
end
|
132
97
|
```
|
133
98
|
|
134
99
|
### Parameters
|
135
100
|
|
136
|
-
|
137
|
-
|
138
|
-
|
|
139
|
-
|
101
|
+
|
102
|
+
Name | Type | Description | Notes
|
103
|
+
------------- | ------------- | ------------- | -------------
|
104
|
+
**flavor** | **String**| The ORY Access Control Policy flavor. Can be \"regex\", \"glob\", and \"exact\". |
|
105
|
+
**id** | **String**| The ID of the ORY Access Control Policy Role. |
|
140
106
|
|
141
107
|
### Return type
|
142
108
|
|
@@ -160,10 +126,10 @@ Delete an ORY Access Control Policy Role
|
|
160
126
|
|
161
127
|
Roles group several subjects into one. Rules can be assigned to ORY Access Control Policy (OACP) by using the Role ID as subject in the OACP.
|
162
128
|
|
163
|
-
###
|
129
|
+
### Example
|
164
130
|
|
165
131
|
```ruby
|
166
|
-
|
132
|
+
# load the gem
|
167
133
|
require 'ory-keto-client'
|
168
134
|
|
169
135
|
api_instance = OryHydraClient::EnginesApi.new
|
@@ -171,37 +137,20 @@ flavor = 'flavor_example' # String | The ORY Access Control Policy flavor. Can b
|
|
171
137
|
id = 'id_example' # String | The ID of the ORY Access Control Policy Role.
|
172
138
|
|
173
139
|
begin
|
174
|
-
#
|
140
|
+
#Delete an ORY Access Control Policy Role
|
175
141
|
api_instance.delete_ory_access_control_policy_role(flavor, id)
|
176
142
|
rescue OryHydraClient::ApiError => e
|
177
|
-
puts "
|
178
|
-
end
|
179
|
-
```
|
180
|
-
|
181
|
-
#### Using the delete_ory_access_control_policy_role_with_http_info variant
|
182
|
-
|
183
|
-
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
184
|
-
|
185
|
-
> <Array(nil, Integer, Hash)> delete_ory_access_control_policy_role_with_http_info(flavor, id)
|
186
|
-
|
187
|
-
```ruby
|
188
|
-
begin
|
189
|
-
# Delete an ORY Access Control Policy Role
|
190
|
-
data, status_code, headers = api_instance.delete_ory_access_control_policy_role_with_http_info(flavor, id)
|
191
|
-
p status_code # => 2xx
|
192
|
-
p headers # => { ... }
|
193
|
-
p data # => nil
|
194
|
-
rescue OryHydraClient::ApiError => e
|
195
|
-
puts "Error when calling EnginesApi->delete_ory_access_control_policy_role_with_http_info: #{e}"
|
143
|
+
puts "Exception when calling EnginesApi->delete_ory_access_control_policy_role: #{e}"
|
196
144
|
end
|
197
145
|
```
|
198
146
|
|
199
147
|
### Parameters
|
200
148
|
|
201
|
-
|
202
|
-
|
203
|
-
|
|
204
|
-
|
149
|
+
|
150
|
+
Name | Type | Description | Notes
|
151
|
+
------------- | ------------- | ------------- | -------------
|
152
|
+
**flavor** | **String**| The ORY Access Control Policy flavor. Can be \"regex\", \"glob\", and \"exact\". |
|
153
|
+
**id** | **String**| The ID of the ORY Access Control Policy Role. |
|
205
154
|
|
206
155
|
### Return type
|
207
156
|
|
@@ -219,16 +168,16 @@ No authorization required
|
|
219
168
|
|
220
169
|
## do_ory_access_control_policies_allow
|
221
170
|
|
222
|
-
>
|
171
|
+
> AuthorizationResult do_ory_access_control_policies_allow(flavor, opts)
|
223
172
|
|
224
173
|
Check if a request is allowed
|
225
174
|
|
226
175
|
Use this endpoint to check if a request is allowed or not. If the request is allowed, a 200 response with `{\"allowed\":\"true\"}` will be sent. If the request is denied, a 403 response with `{\"allowed\":\"false\"}` will be sent instead.
|
227
176
|
|
228
|
-
###
|
177
|
+
### Example
|
229
178
|
|
230
179
|
```ruby
|
231
|
-
|
180
|
+
# load the gem
|
232
181
|
require 'ory-keto-client'
|
233
182
|
|
234
183
|
api_instance = OryHydraClient::EnginesApi.new
|
@@ -238,38 +187,21 @@ opts = {
|
|
238
187
|
}
|
239
188
|
|
240
189
|
begin
|
241
|
-
#
|
190
|
+
#Check if a request is allowed
|
242
191
|
result = api_instance.do_ory_access_control_policies_allow(flavor, opts)
|
243
192
|
p result
|
244
193
|
rescue OryHydraClient::ApiError => e
|
245
|
-
puts "
|
246
|
-
end
|
247
|
-
```
|
248
|
-
|
249
|
-
#### Using the do_ory_access_control_policies_allow_with_http_info variant
|
250
|
-
|
251
|
-
This returns an Array which contains the response data, status code and headers.
|
252
|
-
|
253
|
-
> <Array(<AuthorizationResult>, Integer, Hash)> do_ory_access_control_policies_allow_with_http_info(flavor, opts)
|
254
|
-
|
255
|
-
```ruby
|
256
|
-
begin
|
257
|
-
# Check if a request is allowed
|
258
|
-
data, status_code, headers = api_instance.do_ory_access_control_policies_allow_with_http_info(flavor, opts)
|
259
|
-
p status_code # => 2xx
|
260
|
-
p headers # => { ... }
|
261
|
-
p data # => <AuthorizationResult>
|
262
|
-
rescue OryHydraClient::ApiError => e
|
263
|
-
puts "Error when calling EnginesApi->do_ory_access_control_policies_allow_with_http_info: #{e}"
|
194
|
+
puts "Exception when calling EnginesApi->do_ory_access_control_policies_allow: #{e}"
|
264
195
|
end
|
265
196
|
```
|
266
197
|
|
267
198
|
### Parameters
|
268
199
|
|
269
|
-
|
270
|
-
|
271
|
-
|
|
272
|
-
|
200
|
+
|
201
|
+
Name | Type | Description | Notes
|
202
|
+
------------- | ------------- | ------------- | -------------
|
203
|
+
**flavor** | **String**| The ORY Access Control Policy flavor. Can be \"regex\", \"glob\", and \"exact\". |
|
204
|
+
**body** | [**OryAccessControlPolicyAllowedInput**](OryAccessControlPolicyAllowedInput.md)| | [optional]
|
273
205
|
|
274
206
|
### Return type
|
275
207
|
|
@@ -287,16 +219,16 @@ No authorization required
|
|
287
219
|
|
288
220
|
## get_ory_access_control_policy
|
289
221
|
|
290
|
-
>
|
222
|
+
> OryAccessControlPolicy get_ory_access_control_policy(flavor, id)
|
291
223
|
|
292
224
|
|
293
225
|
|
294
226
|
Get an ORY Access Control Policy
|
295
227
|
|
296
|
-
###
|
228
|
+
### Example
|
297
229
|
|
298
230
|
```ruby
|
299
|
-
|
231
|
+
# load the gem
|
300
232
|
require 'ory-keto-client'
|
301
233
|
|
302
234
|
api_instance = OryHydraClient::EnginesApi.new
|
@@ -304,38 +236,20 @@ flavor = 'flavor_example' # String | The ORY Access Control Policy flavor. Can b
|
|
304
236
|
id = 'id_example' # String | The ID of the ORY Access Control Policy Role.
|
305
237
|
|
306
238
|
begin
|
307
|
-
|
308
239
|
result = api_instance.get_ory_access_control_policy(flavor, id)
|
309
240
|
p result
|
310
241
|
rescue OryHydraClient::ApiError => e
|
311
|
-
puts "
|
312
|
-
end
|
313
|
-
```
|
314
|
-
|
315
|
-
#### Using the get_ory_access_control_policy_with_http_info variant
|
316
|
-
|
317
|
-
This returns an Array which contains the response data, status code and headers.
|
318
|
-
|
319
|
-
> <Array(<OryAccessControlPolicy>, Integer, Hash)> get_ory_access_control_policy_with_http_info(flavor, id)
|
320
|
-
|
321
|
-
```ruby
|
322
|
-
begin
|
323
|
-
|
324
|
-
data, status_code, headers = api_instance.get_ory_access_control_policy_with_http_info(flavor, id)
|
325
|
-
p status_code # => 2xx
|
326
|
-
p headers # => { ... }
|
327
|
-
p data # => <OryAccessControlPolicy>
|
328
|
-
rescue OryHydraClient::ApiError => e
|
329
|
-
puts "Error when calling EnginesApi->get_ory_access_control_policy_with_http_info: #{e}"
|
242
|
+
puts "Exception when calling EnginesApi->get_ory_access_control_policy: #{e}"
|
330
243
|
end
|
331
244
|
```
|
332
245
|
|
333
246
|
### Parameters
|
334
247
|
|
335
|
-
|
336
|
-
|
337
|
-
|
|
338
|
-
|
248
|
+
|
249
|
+
Name | Type | Description | Notes
|
250
|
+
------------- | ------------- | ------------- | -------------
|
251
|
+
**flavor** | **String**| The ORY Access Control Policy flavor. Can be \"regex\", \"glob\", and \"exact\". |
|
252
|
+
**id** | **String**| The ID of the ORY Access Control Policy Role. |
|
339
253
|
|
340
254
|
### Return type
|
341
255
|
|
@@ -353,16 +267,16 @@ No authorization required
|
|
353
267
|
|
354
268
|
## get_ory_access_control_policy_role
|
355
269
|
|
356
|
-
>
|
270
|
+
> OryAccessControlPolicyRole get_ory_access_control_policy_role(flavor, id)
|
357
271
|
|
358
272
|
Get an ORY Access Control Policy Role
|
359
273
|
|
360
274
|
Roles group several subjects into one. Rules can be assigned to ORY Access Control Policy (OACP) by using the Role ID as subject in the OACP.
|
361
275
|
|
362
|
-
###
|
276
|
+
### Example
|
363
277
|
|
364
278
|
```ruby
|
365
|
-
|
279
|
+
# load the gem
|
366
280
|
require 'ory-keto-client'
|
367
281
|
|
368
282
|
api_instance = OryHydraClient::EnginesApi.new
|
@@ -370,38 +284,21 @@ flavor = 'flavor_example' # String | The ORY Access Control Policy flavor. Can b
|
|
370
284
|
id = 'id_example' # String | The ID of the ORY Access Control Policy Role.
|
371
285
|
|
372
286
|
begin
|
373
|
-
#
|
287
|
+
#Get an ORY Access Control Policy Role
|
374
288
|
result = api_instance.get_ory_access_control_policy_role(flavor, id)
|
375
289
|
p result
|
376
290
|
rescue OryHydraClient::ApiError => e
|
377
|
-
puts "
|
378
|
-
end
|
379
|
-
```
|
380
|
-
|
381
|
-
#### Using the get_ory_access_control_policy_role_with_http_info variant
|
382
|
-
|
383
|
-
This returns an Array which contains the response data, status code and headers.
|
384
|
-
|
385
|
-
> <Array(<OryAccessControlPolicyRole>, Integer, Hash)> get_ory_access_control_policy_role_with_http_info(flavor, id)
|
386
|
-
|
387
|
-
```ruby
|
388
|
-
begin
|
389
|
-
# Get an ORY Access Control Policy Role
|
390
|
-
data, status_code, headers = api_instance.get_ory_access_control_policy_role_with_http_info(flavor, id)
|
391
|
-
p status_code # => 2xx
|
392
|
-
p headers # => { ... }
|
393
|
-
p data # => <OryAccessControlPolicyRole>
|
394
|
-
rescue OryHydraClient::ApiError => e
|
395
|
-
puts "Error when calling EnginesApi->get_ory_access_control_policy_role_with_http_info: #{e}"
|
291
|
+
puts "Exception when calling EnginesApi->get_ory_access_control_policy_role: #{e}"
|
396
292
|
end
|
397
293
|
```
|
398
294
|
|
399
295
|
### Parameters
|
400
296
|
|
401
|
-
|
402
|
-
|
403
|
-
|
|
404
|
-
|
297
|
+
|
298
|
+
Name | Type | Description | Notes
|
299
|
+
------------- | ------------- | ------------- | -------------
|
300
|
+
**flavor** | **String**| The ORY Access Control Policy flavor. Can be \"regex\", \"glob\", and \"exact\". |
|
301
|
+
**id** | **String**| The ID of the ORY Access Control Policy Role. |
|
405
302
|
|
406
303
|
### Return type
|
407
304
|
|
@@ -419,65 +316,47 @@ No authorization required
|
|
419
316
|
|
420
317
|
## list_ory_access_control_policies
|
421
318
|
|
422
|
-
>
|
319
|
+
> Array<OryAccessControlPolicy> list_ory_access_control_policies(flavor, opts)
|
423
320
|
|
424
321
|
|
425
322
|
|
426
323
|
List ORY Access Control Policies
|
427
324
|
|
428
|
-
###
|
325
|
+
### Example
|
429
326
|
|
430
327
|
```ruby
|
431
|
-
|
328
|
+
# load the gem
|
432
329
|
require 'ory-keto-client'
|
433
330
|
|
434
331
|
api_instance = OryHydraClient::EnginesApi.new
|
435
332
|
flavor = 'flavor_example' # String | The ORY Access Control Policy flavor. Can be \"regex\", \"glob\", and \"exact\"
|
436
333
|
opts = {
|
437
|
-
limit:
|
438
|
-
offset:
|
334
|
+
limit: 56, # Integer | The maximum amount of policies returned.
|
335
|
+
offset: 56, # Integer | The offset from where to start looking.
|
439
336
|
subject: 'subject_example', # String | The subject for whom the policies are to be listed.
|
440
337
|
resource: 'resource_example', # String | The resource for which the policies are to be listed.
|
441
338
|
action: 'action_example' # String | The action for which policies are to be listed.
|
442
339
|
}
|
443
340
|
|
444
341
|
begin
|
445
|
-
|
446
342
|
result = api_instance.list_ory_access_control_policies(flavor, opts)
|
447
343
|
p result
|
448
344
|
rescue OryHydraClient::ApiError => e
|
449
|
-
puts "
|
450
|
-
end
|
451
|
-
```
|
452
|
-
|
453
|
-
#### Using the list_ory_access_control_policies_with_http_info variant
|
454
|
-
|
455
|
-
This returns an Array which contains the response data, status code and headers.
|
456
|
-
|
457
|
-
> <Array(<Array<OryAccessControlPolicy>>, Integer, Hash)> list_ory_access_control_policies_with_http_info(flavor, opts)
|
458
|
-
|
459
|
-
```ruby
|
460
|
-
begin
|
461
|
-
|
462
|
-
data, status_code, headers = api_instance.list_ory_access_control_policies_with_http_info(flavor, opts)
|
463
|
-
p status_code # => 2xx
|
464
|
-
p headers # => { ... }
|
465
|
-
p data # => <Array<OryAccessControlPolicy>>
|
466
|
-
rescue OryHydraClient::ApiError => e
|
467
|
-
puts "Error when calling EnginesApi->list_ory_access_control_policies_with_http_info: #{e}"
|
345
|
+
puts "Exception when calling EnginesApi->list_ory_access_control_policies: #{e}"
|
468
346
|
end
|
469
347
|
```
|
470
348
|
|
471
349
|
### Parameters
|
472
350
|
|
473
|
-
|
474
|
-
|
475
|
-
|
|
476
|
-
|
477
|
-
|
478
|
-
|
479
|
-
|
480
|
-
|
351
|
+
|
352
|
+
Name | Type | Description | Notes
|
353
|
+
------------- | ------------- | ------------- | -------------
|
354
|
+
**flavor** | **String**| The ORY Access Control Policy flavor. Can be \"regex\", \"glob\", and \"exact\" |
|
355
|
+
**limit** | **Integer**| The maximum amount of policies returned. | [optional]
|
356
|
+
**offset** | **Integer**| The offset from where to start looking. | [optional]
|
357
|
+
**subject** | **String**| The subject for whom the policies are to be listed. | [optional]
|
358
|
+
**resource** | **String**| The resource for which the policies are to be listed. | [optional]
|
359
|
+
**action** | **String**| The action for which policies are to be listed. | [optional]
|
481
360
|
|
482
361
|
### Return type
|
483
362
|
|
@@ -495,61 +374,44 @@ No authorization required
|
|
495
374
|
|
496
375
|
## list_ory_access_control_policy_roles
|
497
376
|
|
498
|
-
>
|
377
|
+
> Array<OryAccessControlPolicyRole> list_ory_access_control_policy_roles(flavor, opts)
|
499
378
|
|
500
379
|
List ORY Access Control Policy Roles
|
501
380
|
|
502
381
|
Roles group several subjects into one. Rules can be assigned to ORY Access Control Policy (OACP) by using the Role ID as subject in the OACP.
|
503
382
|
|
504
|
-
###
|
383
|
+
### Example
|
505
384
|
|
506
385
|
```ruby
|
507
|
-
|
386
|
+
# load the gem
|
508
387
|
require 'ory-keto-client'
|
509
388
|
|
510
389
|
api_instance = OryHydraClient::EnginesApi.new
|
511
390
|
flavor = 'flavor_example' # String | The ORY Access Control Policy flavor. Can be \"regex\", \"glob\", and \"exact\"
|
512
391
|
opts = {
|
513
|
-
limit:
|
514
|
-
offset:
|
392
|
+
limit: 56, # Integer | The maximum amount of policies returned.
|
393
|
+
offset: 56, # Integer | The offset from where to start looking.
|
515
394
|
member: 'member_example' # String | The member for which the roles are to be listed.
|
516
395
|
}
|
517
396
|
|
518
397
|
begin
|
519
|
-
#
|
398
|
+
#List ORY Access Control Policy Roles
|
520
399
|
result = api_instance.list_ory_access_control_policy_roles(flavor, opts)
|
521
400
|
p result
|
522
401
|
rescue OryHydraClient::ApiError => e
|
523
|
-
puts "
|
524
|
-
end
|
525
|
-
```
|
526
|
-
|
527
|
-
#### Using the list_ory_access_control_policy_roles_with_http_info variant
|
528
|
-
|
529
|
-
This returns an Array which contains the response data, status code and headers.
|
530
|
-
|
531
|
-
> <Array(<Array<OryAccessControlPolicyRole>>, Integer, Hash)> list_ory_access_control_policy_roles_with_http_info(flavor, opts)
|
532
|
-
|
533
|
-
```ruby
|
534
|
-
begin
|
535
|
-
# List ORY Access Control Policy Roles
|
536
|
-
data, status_code, headers = api_instance.list_ory_access_control_policy_roles_with_http_info(flavor, opts)
|
537
|
-
p status_code # => 2xx
|
538
|
-
p headers # => { ... }
|
539
|
-
p data # => <Array<OryAccessControlPolicyRole>>
|
540
|
-
rescue OryHydraClient::ApiError => e
|
541
|
-
puts "Error when calling EnginesApi->list_ory_access_control_policy_roles_with_http_info: #{e}"
|
402
|
+
puts "Exception when calling EnginesApi->list_ory_access_control_policy_roles: #{e}"
|
542
403
|
end
|
543
404
|
```
|
544
405
|
|
545
406
|
### Parameters
|
546
407
|
|
547
|
-
|
548
|
-
|
549
|
-
|
|
550
|
-
|
551
|
-
|
552
|
-
|
408
|
+
|
409
|
+
Name | Type | Description | Notes
|
410
|
+
------------- | ------------- | ------------- | -------------
|
411
|
+
**flavor** | **String**| The ORY Access Control Policy flavor. Can be \"regex\", \"glob\", and \"exact\" |
|
412
|
+
**limit** | **Integer**| The maximum amount of policies returned. | [optional]
|
413
|
+
**offset** | **Integer**| The offset from where to start looking. | [optional]
|
414
|
+
**member** | **String**| The member for which the roles are to be listed. | [optional]
|
553
415
|
|
554
416
|
### Return type
|
555
417
|
|
@@ -573,10 +435,10 @@ Remove a member from an ORY Access Control Policy Role
|
|
573
435
|
|
574
436
|
Roles group several subjects into one. Rules can be assigned to ORY Access Control Policy (OACP) by using the Role ID as subject in the OACP.
|
575
437
|
|
576
|
-
###
|
438
|
+
### Example
|
577
439
|
|
578
440
|
```ruby
|
579
|
-
|
441
|
+
# load the gem
|
580
442
|
require 'ory-keto-client'
|
581
443
|
|
582
444
|
api_instance = OryHydraClient::EnginesApi.new
|
@@ -585,38 +447,21 @@ id = 'id_example' # String | The ID of the ORY Access Control Policy Role.
|
|
585
447
|
member = 'member_example' # String | The member to be removed.
|
586
448
|
|
587
449
|
begin
|
588
|
-
#
|
450
|
+
#Remove a member from an ORY Access Control Policy Role
|
589
451
|
api_instance.remove_ory_access_control_policy_role_members(flavor, id, member)
|
590
452
|
rescue OryHydraClient::ApiError => e
|
591
|
-
puts "
|
592
|
-
end
|
593
|
-
```
|
594
|
-
|
595
|
-
#### Using the remove_ory_access_control_policy_role_members_with_http_info variant
|
596
|
-
|
597
|
-
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
598
|
-
|
599
|
-
> <Array(nil, Integer, Hash)> remove_ory_access_control_policy_role_members_with_http_info(flavor, id, member)
|
600
|
-
|
601
|
-
```ruby
|
602
|
-
begin
|
603
|
-
# Remove a member from an ORY Access Control Policy Role
|
604
|
-
data, status_code, headers = api_instance.remove_ory_access_control_policy_role_members_with_http_info(flavor, id, member)
|
605
|
-
p status_code # => 2xx
|
606
|
-
p headers # => { ... }
|
607
|
-
p data # => nil
|
608
|
-
rescue OryHydraClient::ApiError => e
|
609
|
-
puts "Error when calling EnginesApi->remove_ory_access_control_policy_role_members_with_http_info: #{e}"
|
453
|
+
puts "Exception when calling EnginesApi->remove_ory_access_control_policy_role_members: #{e}"
|
610
454
|
end
|
611
455
|
```
|
612
456
|
|
613
457
|
### Parameters
|
614
458
|
|
615
|
-
|
616
|
-
|
617
|
-
|
|
618
|
-
|
619
|
-
|
459
|
+
|
460
|
+
Name | Type | Description | Notes
|
461
|
+
------------- | ------------- | ------------- | -------------
|
462
|
+
**flavor** | **String**| The ORY Access Control Policy flavor. Can be \"regex\", \"glob\", and \"exact\". |
|
463
|
+
**id** | **String**| The ID of the ORY Access Control Policy Role. |
|
464
|
+
**member** | **String**| The member to be removed. |
|
620
465
|
|
621
466
|
### Return type
|
622
467
|
|
@@ -634,16 +479,16 @@ No authorization required
|
|
634
479
|
|
635
480
|
## upsert_ory_access_control_policy
|
636
481
|
|
637
|
-
>
|
482
|
+
> OryAccessControlPolicy upsert_ory_access_control_policy(flavor, opts)
|
638
483
|
|
639
484
|
|
640
485
|
|
641
486
|
Upsert an ORY Access Control Policy
|
642
487
|
|
643
|
-
###
|
488
|
+
### Example
|
644
489
|
|
645
490
|
```ruby
|
646
|
-
|
491
|
+
# load the gem
|
647
492
|
require 'ory-keto-client'
|
648
493
|
|
649
494
|
api_instance = OryHydraClient::EnginesApi.new
|
@@ -653,38 +498,20 @@ opts = {
|
|
653
498
|
}
|
654
499
|
|
655
500
|
begin
|
656
|
-
|
657
501
|
result = api_instance.upsert_ory_access_control_policy(flavor, opts)
|
658
502
|
p result
|
659
503
|
rescue OryHydraClient::ApiError => e
|
660
|
-
puts "
|
661
|
-
end
|
662
|
-
```
|
663
|
-
|
664
|
-
#### Using the upsert_ory_access_control_policy_with_http_info variant
|
665
|
-
|
666
|
-
This returns an Array which contains the response data, status code and headers.
|
667
|
-
|
668
|
-
> <Array(<OryAccessControlPolicy>, Integer, Hash)> upsert_ory_access_control_policy_with_http_info(flavor, opts)
|
669
|
-
|
670
|
-
```ruby
|
671
|
-
begin
|
672
|
-
|
673
|
-
data, status_code, headers = api_instance.upsert_ory_access_control_policy_with_http_info(flavor, opts)
|
674
|
-
p status_code # => 2xx
|
675
|
-
p headers # => { ... }
|
676
|
-
p data # => <OryAccessControlPolicy>
|
677
|
-
rescue OryHydraClient::ApiError => e
|
678
|
-
puts "Error when calling EnginesApi->upsert_ory_access_control_policy_with_http_info: #{e}"
|
504
|
+
puts "Exception when calling EnginesApi->upsert_ory_access_control_policy: #{e}"
|
679
505
|
end
|
680
506
|
```
|
681
507
|
|
682
508
|
### Parameters
|
683
509
|
|
684
|
-
|
685
|
-
|
686
|
-
|
|
687
|
-
|
510
|
+
|
511
|
+
Name | Type | Description | Notes
|
512
|
+
------------- | ------------- | ------------- | -------------
|
513
|
+
**flavor** | **String**| The ORY Access Control Policy flavor. Can be \"regex\", \"glob\", and \"exact\". |
|
514
|
+
**body** | [**OryAccessControlPolicy**](OryAccessControlPolicy.md)| | [optional]
|
688
515
|
|
689
516
|
### Return type
|
690
517
|
|
@@ -702,16 +529,16 @@ No authorization required
|
|
702
529
|
|
703
530
|
## upsert_ory_access_control_policy_role
|
704
531
|
|
705
|
-
>
|
532
|
+
> OryAccessControlPolicyRole upsert_ory_access_control_policy_role(flavor, opts)
|
706
533
|
|
707
534
|
Upsert an ORY Access Control Policy Role
|
708
535
|
|
709
536
|
Roles group several subjects into one. Rules can be assigned to ORY Access Control Policy (OACP) by using the Role ID as subject in the OACP.
|
710
537
|
|
711
|
-
###
|
538
|
+
### Example
|
712
539
|
|
713
540
|
```ruby
|
714
|
-
|
541
|
+
# load the gem
|
715
542
|
require 'ory-keto-client'
|
716
543
|
|
717
544
|
api_instance = OryHydraClient::EnginesApi.new
|
@@ -721,38 +548,21 @@ opts = {
|
|
721
548
|
}
|
722
549
|
|
723
550
|
begin
|
724
|
-
#
|
551
|
+
#Upsert an ORY Access Control Policy Role
|
725
552
|
result = api_instance.upsert_ory_access_control_policy_role(flavor, opts)
|
726
553
|
p result
|
727
554
|
rescue OryHydraClient::ApiError => e
|
728
|
-
puts "
|
729
|
-
end
|
730
|
-
```
|
731
|
-
|
732
|
-
#### Using the upsert_ory_access_control_policy_role_with_http_info variant
|
733
|
-
|
734
|
-
This returns an Array which contains the response data, status code and headers.
|
735
|
-
|
736
|
-
> <Array(<OryAccessControlPolicyRole>, Integer, Hash)> upsert_ory_access_control_policy_role_with_http_info(flavor, opts)
|
737
|
-
|
738
|
-
```ruby
|
739
|
-
begin
|
740
|
-
# Upsert an ORY Access Control Policy Role
|
741
|
-
data, status_code, headers = api_instance.upsert_ory_access_control_policy_role_with_http_info(flavor, opts)
|
742
|
-
p status_code # => 2xx
|
743
|
-
p headers # => { ... }
|
744
|
-
p data # => <OryAccessControlPolicyRole>
|
745
|
-
rescue OryHydraClient::ApiError => e
|
746
|
-
puts "Error when calling EnginesApi->upsert_ory_access_control_policy_role_with_http_info: #{e}"
|
555
|
+
puts "Exception when calling EnginesApi->upsert_ory_access_control_policy_role: #{e}"
|
747
556
|
end
|
748
557
|
```
|
749
558
|
|
750
559
|
### Parameters
|
751
560
|
|
752
|
-
|
753
|
-
|
754
|
-
|
|
755
|
-
|
561
|
+
|
562
|
+
Name | Type | Description | Notes
|
563
|
+
------------- | ------------- | ------------- | -------------
|
564
|
+
**flavor** | **String**| The ORY Access Control Policy flavor. Can be \"regex\", \"glob\", and \"exact\". |
|
565
|
+
**body** | [**OryAccessControlPolicyRole**](OryAccessControlPolicyRole.md)| | [optional]
|
756
566
|
|
757
567
|
### Return type
|
758
568
|
|