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