ory-hydra-client 1.4.10 → 1.7.0
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 +20 -6
- data/docs/AdminApi.md +4 -2
- data/docs/CompletedRequest.md +1 -1
- data/docs/ConsentRequest.md +1 -1
- data/docs/ConsentRequestSession.md +2 -2
- data/docs/ContainerWaitOKBodyError.md +17 -0
- data/docs/JSONWebKey.md +12 -12
- data/docs/LoginRequest.md +7 -7
- data/docs/OAuth2Client.md +3 -1
- data/docs/OAuth2TokenIntrospection.md +2 -2
- data/docs/Oauth2TokenResponse.md +6 -6
- data/docs/OpenIDConnectContext.md +1 -1
- data/docs/PluginConfig.md +47 -0
- data/docs/PluginConfigArgs.md +23 -0
- data/docs/PluginConfigInterface.md +19 -0
- data/docs/PluginConfigLinux.md +21 -0
- data/docs/PluginConfigNetwork.md +17 -0
- data/docs/PluginConfigRootfs.md +19 -0
- data/docs/PluginConfigUser.md +19 -0
- data/docs/PluginDevice.md +23 -0
- data/docs/PluginEnv.md +23 -0
- data/docs/PluginInterfaceType.md +21 -0
- data/docs/PluginMount.md +29 -0
- data/docs/PluginSettings.md +23 -0
- data/docs/PreviousConsentSession.md +3 -3
- data/docs/RejectRequest.md +5 -5
- data/docs/VolumeUsageData.md +19 -0
- data/lib/ory-hydra-client.rb +16 -2
- data/lib/ory-hydra-client/api/admin_api.rb +7 -4
- data/lib/ory-hydra-client/api/public_api.rb +2 -2
- data/lib/ory-hydra-client/api_client.rb +9 -7
- data/lib/ory-hydra-client/api_error.rb +2 -2
- data/lib/ory-hydra-client/configuration.rb +2 -2
- data/lib/ory-hydra-client/models/accept_consent_request.rb +2 -2
- data/lib/ory-hydra-client/models/accept_login_request.rb +2 -2
- data/lib/ory-hydra-client/models/completed_request.rb +7 -2
- data/lib/ory-hydra-client/models/consent_request.rb +7 -2
- data/lib/ory-hydra-client/models/consent_request_session.rb +6 -10
- data/lib/ory-hydra-client/models/container_wait_ok_body_error.rb +208 -0
- data/lib/ory-hydra-client/models/flush_inactive_o_auth2_tokens_request.rb +2 -2
- data/lib/ory-hydra-client/models/generic_error.rb +2 -2
- data/lib/ory-hydra-client/models/health_not_ready_status.rb +2 -3
- data/lib/ory-hydra-client/models/health_status.rb +2 -2
- data/lib/ory-hydra-client/models/json_web_key.rb +3 -15
- data/lib/ory-hydra-client/models/json_web_key_set.rb +3 -3
- data/lib/ory-hydra-client/models/json_web_key_set_generator_request.rb +2 -2
- data/lib/ory-hydra-client/models/login_request.rb +37 -2
- data/lib/ory-hydra-client/models/logout_request.rb +2 -2
- data/lib/ory-hydra-client/models/o_auth2_client.rb +14 -4
- data/lib/ory-hydra-client/models/o_auth2_token_introspection.rb +5 -7
- data/lib/ory-hydra-client/models/oauth2_token_response.rb +3 -9
- data/lib/ory-hydra-client/models/open_id_connect_context.rb +4 -6
- data/lib/ory-hydra-client/models/plugin_config.rb +422 -0
- data/lib/ory-hydra-client/models/plugin_config_args.rb +262 -0
- data/lib/ory-hydra-client/models/plugin_config_interface.rb +230 -0
- data/lib/ory-hydra-client/models/plugin_config_linux.rb +247 -0
- data/lib/ory-hydra-client/models/plugin_config_network.rb +213 -0
- data/lib/ory-hydra-client/models/plugin_config_rootfs.rb +220 -0
- data/lib/ory-hydra-client/models/plugin_config_user.rb +218 -0
- data/lib/ory-hydra-client/models/plugin_device.rb +260 -0
- data/lib/ory-hydra-client/models/plugin_env.rb +260 -0
- data/lib/ory-hydra-client/models/plugin_interface_type.rb +243 -0
- data/lib/ory-hydra-client/models/plugin_mount.rb +307 -0
- data/lib/ory-hydra-client/models/plugin_settings.rb +265 -0
- data/lib/ory-hydra-client/models/previous_consent_session.rb +3 -6
- data/lib/ory-hydra-client/models/reject_request.rb +7 -7
- data/lib/ory-hydra-client/models/userinfo_response.rb +3 -3
- data/lib/ory-hydra-client/models/version.rb +2 -3
- data/lib/ory-hydra-client/models/volume_usage_data.rb +228 -0
- data/lib/ory-hydra-client/models/well_known.rb +2 -2
- data/lib/ory-hydra-client/version.rb +3 -3
- data/ory-hydra-client.gemspec +2 -2
- data/spec/models/container_wait_ok_body_error_spec.rb +41 -0
- data/spec/models/plugin_config_args_spec.rb +59 -0
- data/spec/models/plugin_config_interface_spec.rb +47 -0
- data/spec/models/plugin_config_linux_spec.rb +53 -0
- data/spec/models/plugin_config_network_spec.rb +41 -0
- data/spec/models/plugin_config_rootfs_spec.rb +47 -0
- data/spec/models/plugin_config_spec.rb +131 -0
- data/spec/models/plugin_config_user_spec.rb +47 -0
- data/spec/models/plugin_device_spec.rb +59 -0
- data/spec/models/plugin_env_spec.rb +59 -0
- data/spec/models/plugin_interface_type_spec.rb +53 -0
- data/spec/models/plugin_mount_spec.rb +77 -0
- data/spec/models/plugin_settings_spec.rb +59 -0
- data/spec/models/volume_usage_data_spec.rb +47 -0
- metadata +74 -18
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c007ddcc60ff352b57b7ac7b39f7a000a519f5a8621e9d7fe9be264e454479d6
|
4
|
+
data.tar.gz: ab434717edaa5a73839ccd6896894a5c4cb2b1c127cc6359cd4a61618dde92e7
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 63707a05220d3ab5a00792ccf8f1b41c5eeaa58ed8f0e76dddd81c0a22deae62d38b2cf8e44f1434287341b950ba6dd43725def373d319d7985ae231e5be7426
|
7
|
+
data.tar.gz: 75be376911622c9d01947bfd4c5b3cfd9207ee879a7674950cb766fbfa9bbffc5d4620c92e077a5c9a1aac165e62c0cfcc280763d5c512309edcd8fe06f64991
|
data/Gemfile
CHANGED
data/README.md
CHANGED
@@ -6,8 +6,8 @@ Welcome to the ORY Hydra HTTP API documentation. You will find documentation for
|
|
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: v1.
|
9
|
+
- API version: v1.7.0
|
10
|
+
- Package version: v1.7.0
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
|
13
13
|
## Installation
|
@@ -23,16 +23,16 @@ gem build ory-hydra-client.gemspec
|
|
23
23
|
Then either install the gem locally:
|
24
24
|
|
25
25
|
```shell
|
26
|
-
gem install ./ory-hydra-client-v1.
|
26
|
+
gem install ./ory-hydra-client-v1.7.0.gem
|
27
27
|
```
|
28
28
|
|
29
|
-
(for development, run `gem install --dev ./ory-hydra-client-v1.
|
29
|
+
(for development, run `gem install --dev ./ory-hydra-client-v1.7.0.gem` to install the development dependencies)
|
30
30
|
|
31
31
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
32
|
|
33
33
|
Finally add this to the Gemfile:
|
34
34
|
|
35
|
-
gem 'ory-hydra-client', '~> v1.
|
35
|
+
gem 'ory-hydra-client', '~> v1.7.0'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -124,6 +124,7 @@ Class | Method | HTTP request | Description
|
|
124
124
|
- [OryHydraClient::CompletedRequest](docs/CompletedRequest.md)
|
125
125
|
- [OryHydraClient::ConsentRequest](docs/ConsentRequest.md)
|
126
126
|
- [OryHydraClient::ConsentRequestSession](docs/ConsentRequestSession.md)
|
127
|
+
- [OryHydraClient::ContainerWaitOKBodyError](docs/ContainerWaitOKBodyError.md)
|
127
128
|
- [OryHydraClient::FlushInactiveOAuth2TokensRequest](docs/FlushInactiveOAuth2TokensRequest.md)
|
128
129
|
- [OryHydraClient::GenericError](docs/GenericError.md)
|
129
130
|
- [OryHydraClient::HealthNotReadyStatus](docs/HealthNotReadyStatus.md)
|
@@ -137,10 +138,23 @@ Class | Method | HTTP request | Description
|
|
137
138
|
- [OryHydraClient::OAuth2TokenIntrospection](docs/OAuth2TokenIntrospection.md)
|
138
139
|
- [OryHydraClient::Oauth2TokenResponse](docs/Oauth2TokenResponse.md)
|
139
140
|
- [OryHydraClient::OpenIDConnectContext](docs/OpenIDConnectContext.md)
|
141
|
+
- [OryHydraClient::PluginConfig](docs/PluginConfig.md)
|
142
|
+
- [OryHydraClient::PluginConfigArgs](docs/PluginConfigArgs.md)
|
143
|
+
- [OryHydraClient::PluginConfigInterface](docs/PluginConfigInterface.md)
|
144
|
+
- [OryHydraClient::PluginConfigLinux](docs/PluginConfigLinux.md)
|
145
|
+
- [OryHydraClient::PluginConfigNetwork](docs/PluginConfigNetwork.md)
|
146
|
+
- [OryHydraClient::PluginConfigRootfs](docs/PluginConfigRootfs.md)
|
147
|
+
- [OryHydraClient::PluginConfigUser](docs/PluginConfigUser.md)
|
148
|
+
- [OryHydraClient::PluginDevice](docs/PluginDevice.md)
|
149
|
+
- [OryHydraClient::PluginEnv](docs/PluginEnv.md)
|
150
|
+
- [OryHydraClient::PluginInterfaceType](docs/PluginInterfaceType.md)
|
151
|
+
- [OryHydraClient::PluginMount](docs/PluginMount.md)
|
152
|
+
- [OryHydraClient::PluginSettings](docs/PluginSettings.md)
|
140
153
|
- [OryHydraClient::PreviousConsentSession](docs/PreviousConsentSession.md)
|
141
154
|
- [OryHydraClient::RejectRequest](docs/RejectRequest.md)
|
142
155
|
- [OryHydraClient::UserinfoResponse](docs/UserinfoResponse.md)
|
143
156
|
- [OryHydraClient::Version](docs/Version.md)
|
157
|
+
- [OryHydraClient::VolumeUsageData](docs/VolumeUsageData.md)
|
144
158
|
- [OryHydraClient::WellKnown](docs/WellKnown.md)
|
145
159
|
|
146
160
|
|
@@ -156,7 +170,7 @@ Class | Method | HTTP request | Description
|
|
156
170
|
|
157
171
|
- **Type**: OAuth
|
158
172
|
- **Flow**: accessCode
|
159
|
-
- **Authorization URL**: /oauth2/auth
|
173
|
+
- **Authorization URL**: https://hydra.demo.ory.sh/oauth2/auth
|
160
174
|
- **Scopes**:
|
161
175
|
- offline: A scope required when requesting refresh tokens (alias for `offline_access`)
|
162
176
|
- offline_access: A scope required when requesting refresh tokens
|
data/docs/AdminApi.md
CHANGED
@@ -958,7 +958,7 @@ No authorization required
|
|
958
958
|
|
959
959
|
Lists all consent sessions of a subject
|
960
960
|
|
961
|
-
This endpoint lists all subject's granted consent sessions, including client and granted scope. The \"Link\" header is also included in successful responses, which contains one or more links for pagination, formatted like so: '<https://hydra-url/admin/oauth2/auth/sessions/consent?subject={user}&limit={limit}&offset={offset}>; rel=\"{page}\"', where page is one of the following applicable pages: 'first', 'next', 'last', and 'previous'. Multiple links can be included in this header, and will be separated by a comma.
|
961
|
+
This endpoint lists all subject's granted consent sessions, including client and granted scope. If the subject is unknown or has not granted any consent sessions yet, the endpoint returns an empty JSON array with status code 200 OK. The \"Link\" header is also included in successful responses, which contains one or more links for pagination, formatted like so: '<https://hydra-url/admin/oauth2/auth/sessions/consent?subject={user}&limit={limit}&offset={offset}>; rel=\"{page}\"', where page is one of the following applicable pages: 'first', 'next', 'last', and 'previous'. Multiple links can be included in this header, and will be separated by a comma.
|
962
962
|
|
963
963
|
### Example
|
964
964
|
|
@@ -1256,7 +1256,8 @@ require 'ory-hydra-client'
|
|
1256
1256
|
api_instance = OryHydraClient::AdminApi.new
|
1257
1257
|
subject = 'subject_example' # String | The subject (Subject) who's consent sessions should be deleted.
|
1258
1258
|
opts = {
|
1259
|
-
client: 'client_example' # String | If set, deletes only those consent sessions by the Subject that have been granted to the specified OAuth 2.0 Client ID
|
1259
|
+
client: 'client_example', # String | If set, deletes only those consent sessions by the Subject that have been granted to the specified OAuth 2.0 Client ID
|
1260
|
+
all: true # Boolean | If set to `?all=true`, deletes all consent sessions by the Subject that have been granted.
|
1260
1261
|
}
|
1261
1262
|
|
1262
1263
|
begin
|
@@ -1274,6 +1275,7 @@ Name | Type | Description | Notes
|
|
1274
1275
|
------------- | ------------- | ------------- | -------------
|
1275
1276
|
**subject** | **String**| The subject (Subject) who's consent sessions should be deleted. |
|
1276
1277
|
**client** | **String**| If set, deletes only those consent sessions by the Subject that have been granted to the specified OAuth 2.0 Client ID | [optional]
|
1278
|
+
**all** | **Boolean**| If set to `?all=true`, deletes all consent sessions by the Subject that have been granted. | [optional]
|
1277
1279
|
|
1278
1280
|
### Return type
|
1279
1281
|
|
data/docs/CompletedRequest.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**redirect_to** | **String** | RedirectURL is the URL which you should redirect the user to once the authentication process is completed. |
|
7
|
+
**redirect_to** | **String** | RedirectURL is the URL which you should redirect the user to once the authentication process is completed. |
|
8
8
|
|
9
9
|
## Code Sample
|
10
10
|
|
data/docs/ConsentRequest.md
CHANGED
@@ -5,7 +5,7 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**acr** | **String** | ACR represents the Authentication AuthorizationContext Class Reference value for this authentication session. You can use it to express that, for example, a user authenticated using two factor authentication. | [optional]
|
8
|
-
**challenge** | **String** | Challenge is the identifier (\"authorization challenge\") of the consent authorization request. It is used to identify the session. |
|
8
|
+
**challenge** | **String** | Challenge is the identifier (\"authorization challenge\") of the consent authorization request. It is used to identify the session. |
|
9
9
|
**client** | [**OAuth2Client**](OAuth2Client.md) | | [optional]
|
10
10
|
**context** | [**Object**](.md) | | [optional]
|
11
11
|
**login_challenge** | **String** | LoginChallenge is the login challenge this consent challenge belongs to. It can be used to associate a login and consent request in the login & consent app. | [optional]
|
@@ -4,8 +4,8 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**access_token** | **
|
8
|
-
**id_token** | **
|
7
|
+
**access_token** | [**Object**](.md) | AccessToken sets session data for the access and refresh token, as well as any future tokens issued by the refresh grant. Keep in mind that this data will be available to anyone performing OAuth 2.0 Challenge Introspection. If only your services can perform OAuth 2.0 Challenge Introspection, this is usually fine. But if third parties can access that endpoint as well, sensitive data from the session might be exposed to them. Use with care! | [optional]
|
8
|
+
**id_token** | [**Object**](.md) | IDToken sets session data for the OpenID Connect ID token. Keep in mind that the session'id payloads are readable by anyone that has access to the ID Challenge. Use with care! | [optional]
|
9
9
|
|
10
10
|
## Code Sample
|
11
11
|
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# OryHydraClient::ContainerWaitOKBodyError
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**message** | **String** | Details of an error | [optional]
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'OryHydraClient'
|
13
|
+
|
14
|
+
instance = OryHydraClient::ContainerWaitOKBodyError.new(message: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
data/docs/JSONWebKey.md
CHANGED
@@ -5,22 +5,22 @@
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**alg** | **String** | The \"alg\" (algorithm) parameter identifies the algorithm intended for use with the key. The values used should either be registered in the IANA \"JSON Web Signature and Encryption Algorithms\" registry established by [JWA] or be a value that contains a Collision- Resistant Name. |
|
8
|
-
**crv** | **String** |
|
9
|
-
**d** | **String** |
|
10
|
-
**dp** | **String** |
|
11
|
-
**dq** | **String** |
|
12
|
-
**e** | **String** |
|
13
|
-
**k** | **String** |
|
8
|
+
**crv** | **String** | | [optional]
|
9
|
+
**d** | **String** | | [optional]
|
10
|
+
**dp** | **String** | | [optional]
|
11
|
+
**dq** | **String** | | [optional]
|
12
|
+
**e** | **String** | | [optional]
|
13
|
+
**k** | **String** | | [optional]
|
14
14
|
**kid** | **String** | The \"kid\" (key ID) parameter is used to match a specific key. This is used, for instance, to choose among a set of keys within a JWK Set during key rollover. The structure of the \"kid\" value is unspecified. When \"kid\" values are used within a JWK Set, different keys within the JWK Set SHOULD use distinct \"kid\" values. (One example in which different keys might use the same \"kid\" value is if they have different \"kty\" (key type) values but are considered to be equivalent alternatives by the application using them.) The \"kid\" value is a case-sensitive string. |
|
15
15
|
**kty** | **String** | The \"kty\" (key type) parameter identifies the cryptographic algorithm family used with the key, such as \"RSA\" or \"EC\". \"kty\" values should either be registered in the IANA \"JSON Web Key Types\" registry established by [JWA] or be a value that contains a Collision- Resistant Name. The \"kty\" value is a case-sensitive string. |
|
16
|
-
**n** | **String** |
|
17
|
-
**p** | **String** |
|
18
|
-
**q** | **String** |
|
19
|
-
**qi** | **String** |
|
16
|
+
**n** | **String** | | [optional]
|
17
|
+
**p** | **String** | | [optional]
|
18
|
+
**q** | **String** | | [optional]
|
19
|
+
**qi** | **String** | | [optional]
|
20
20
|
**use** | **String** | Use (\"public key use\") identifies the intended use of the public key. The \"use\" parameter is employed to indicate whether a public key is used for encrypting data or verifying the signature on data. Values are commonly \"sig\" (signature) or \"enc\" (encryption). |
|
21
|
-
**x** | **String** |
|
21
|
+
**x** | **String** | | [optional]
|
22
22
|
**x5c** | **Array<String>** | The \"x5c\" (X.509 certificate chain) parameter contains a chain of one or more PKIX certificates [RFC5280]. The certificate chain is represented as a JSON array of certificate value strings. Each string in the array is a base64-encoded (Section 4 of [RFC4648] -- not base64url-encoded) DER [ITU.X690.1994] PKIX certificate value. The PKIX certificate containing the key value MUST be the first certificate. | [optional]
|
23
|
-
**y** | **String** |
|
23
|
+
**y** | **String** | | [optional]
|
24
24
|
|
25
25
|
## Code Sample
|
26
26
|
|
data/docs/LoginRequest.md
CHANGED
@@ -4,15 +4,15 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**challenge** | **String** | Challenge is the identifier (\"login challenge\") of the login request. It is used to identify the session. |
|
8
|
-
**client** | [**OAuth2Client**](OAuth2Client.md) | |
|
7
|
+
**challenge** | **String** | Challenge is the identifier (\"login challenge\") of the login request. It is used to identify the session. |
|
8
|
+
**client** | [**OAuth2Client**](OAuth2Client.md) | |
|
9
9
|
**oidc_context** | [**OpenIDConnectContext**](OpenIDConnectContext.md) | | [optional]
|
10
|
-
**request_url** | **String** | RequestURL is the original OAuth 2.0 Authorization URL requested by the OAuth 2.0 client. It is the URL which initiates the OAuth 2.0 Authorization Code or OAuth 2.0 Implicit flow. This URL is typically not needed, but might come in handy if you want to deal with additional request parameters. |
|
11
|
-
**requested_access_token_audience** | **Array<String>** | |
|
12
|
-
**requested_scope** | **Array<String>** | |
|
10
|
+
**request_url** | **String** | RequestURL is the original OAuth 2.0 Authorization URL requested by the OAuth 2.0 client. It is the URL which initiates the OAuth 2.0 Authorization Code or OAuth 2.0 Implicit flow. This URL is typically not needed, but might come in handy if you want to deal with additional request parameters. |
|
11
|
+
**requested_access_token_audience** | **Array<String>** | |
|
12
|
+
**requested_scope** | **Array<String>** | |
|
13
13
|
**session_id** | **String** | SessionID is the login session ID. If the user-agent reuses a login session (via cookie / remember flag) this ID will remain the same. If the user-agent did not have an existing authentication session (e.g. remember is false) this will be a new random value. This value is used as the \"sid\" parameter in the ID Token and in OIDC Front-/Back- channel logout. It's value can generally be used to associate consecutive login requests by a certain user. | [optional]
|
14
|
-
**skip** | **Boolean** | Skip, if true, implies that the client has requested the same scopes from the same user previously. If true, you can skip asking the user to grant the requested scopes, and simply forward the user to the redirect URL. This feature allows you to update / set session information. |
|
15
|
-
**subject** | **String** | Subject is the user ID of the end-user that authenticated. Now, that end user needs to grant or deny the scope requested by the OAuth 2.0 client. If this value is set and `skip` is true, you MUST include this subject type when accepting the login request, or the request will fail. |
|
14
|
+
**skip** | **Boolean** | Skip, if true, implies that the client has requested the same scopes from the same user previously. If true, you can skip asking the user to grant the requested scopes, and simply forward the user to the redirect URL. This feature allows you to update / set session information. |
|
15
|
+
**subject** | **String** | Subject is the user ID of the end-user that authenticated. Now, that end user needs to grant or deny the scope requested by the OAuth 2.0 client. If this value is set and `skip` is true, you MUST include this subject type when accepting the login request, or the request will fail. |
|
16
16
|
|
17
17
|
## Code Sample
|
18
18
|
|
data/docs/OAuth2Client.md
CHANGED
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
8
8
|
**audience** | **Array<String>** | | [optional]
|
9
9
|
**backchannel_logout_session_required** | **Boolean** | Boolean value specifying whether the RP requires that a sid (session ID) Claim be included in the Logout Token to identify the RP session with the OP when the backchannel_logout_uri is used. If omitted, the default value is false. | [optional]
|
10
10
|
**backchannel_logout_uri** | **String** | RP URL that will cause the RP to log itself out when sent a Logout Token by the OP. | [optional]
|
11
|
-
**client_id** | **String** |
|
11
|
+
**client_id** | **String** | ID is the id for this client. | [optional]
|
12
12
|
**client_name** | **String** | Name is the human-readable string name of the client to be presented to the end-user during authorization. | [optional]
|
13
13
|
**client_secret** | **String** | Secret is the client's secret. The secret will be included in the create request as cleartext, and then never again. The secret is stored using BCrypt so it is impossible to recover it. Tell your users that they need to write the secret down as it will not be made available again. | [optional]
|
14
14
|
**client_secret_expires_at** | **Integer** | SecretExpiresAt is an integer holding the time at which the client secret will expire or 0 if it will not expire. The time is represented as the number of seconds from 1970-01-01T00:00:00Z as measured in UTC until the date/time of expiration. This feature is currently not supported and it's value will always be set to 0. | [optional]
|
@@ -33,6 +33,7 @@ Name | Type | Description | Notes
|
|
33
33
|
**sector_identifier_uri** | **String** | URL using the https scheme to be used in calculating Pseudonymous Identifiers by the OP. The URL references a file with a single JSON array of redirect_uri values. | [optional]
|
34
34
|
**subject_type** | **String** | SubjectType requested for responses to this Client. The subject_types_supported Discovery parameter contains a list of the supported subject_type values for this server. Valid types include `pairwise` and `public`. | [optional]
|
35
35
|
**token_endpoint_auth_method** | **String** | Requested Client Authentication method for the Token Endpoint. The options are client_secret_post, client_secret_basic, private_key_jwt, and none. | [optional]
|
36
|
+
**token_endpoint_auth_signing_alg** | **String** | Requested Client Authentication signing algorithm for the Token Endpoint. | [optional]
|
36
37
|
**tos_uri** | **String** | TermsOfServiceURI is a URL string that points to a human-readable terms of service document for the client that describes a contractual relationship between the end-user and the client that the end-user accepts when authorizing the client. | [optional]
|
37
38
|
**updated_at** | **DateTime** | UpdatedAt returns the timestamp of the last update. | [optional]
|
38
39
|
**userinfo_signed_response_alg** | **String** | JWS alg algorithm [JWA] REQUIRED for signing UserInfo Responses. If this is specified, the response will be JWT [JWT] serialized, and signed using JWS. The default, if omitted, is for the UserInfo Response to return the Claims as a UTF-8 encoded JSON object using the application/json content-type. | [optional]
|
@@ -71,6 +72,7 @@ instance = OryHydraClient::OAuth2Client.new(allowed_cors_origins: null,
|
|
71
72
|
sector_identifier_uri: null,
|
72
73
|
subject_type: null,
|
73
74
|
token_endpoint_auth_method: null,
|
75
|
+
token_endpoint_auth_signing_alg: null,
|
74
76
|
tos_uri: null,
|
75
77
|
updated_at: null,
|
76
78
|
userinfo_signed_response_alg: null)
|
@@ -6,9 +6,9 @@ Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**active** | **Boolean** | Active is a boolean indicator of whether or not the presented token is currently active. The specifics of a token's \"active\" state will vary depending on the implementation of the authorization server and the information it keeps about its tokens, but a \"true\" value return for the \"active\" property will generally indicate that a given token has been issued by this authorization server, has not been revoked by the resource owner, and is within its given time window of validity (e.g., after its issuance time and before its expiration time). |
|
8
8
|
**aud** | **Array<String>** | Audience contains a list of the token's intended audiences. | [optional]
|
9
|
-
**client_id** | **String** |
|
9
|
+
**client_id** | **String** | ID is aclient identifier for the OAuth 2.0 client that requested this token. | [optional]
|
10
10
|
**exp** | **Integer** | Expires at is an integer timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token will expire. | [optional]
|
11
|
-
**ext** | **
|
11
|
+
**ext** | [**Object**](.md) | Extra is arbitrary data set by the session. | [optional]
|
12
12
|
**iat** | **Integer** | Issued at is an integer timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token was originally issued. | [optional]
|
13
13
|
**iss** | **String** | IssuerURL is a string representing the issuer of this token | [optional]
|
14
14
|
**nbf** | **Integer** | NotBefore is an integer timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token is not to be used before. | [optional]
|
data/docs/Oauth2TokenResponse.md
CHANGED
@@ -4,12 +4,12 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**access_token** | **String** |
|
8
|
-
**expires_in** | **Integer** |
|
9
|
-
**id_token** | **String** |
|
10
|
-
**refresh_token** | **String** |
|
11
|
-
**scope** | **String** |
|
12
|
-
**token_type** | **String** |
|
7
|
+
**access_token** | **String** | | [optional]
|
8
|
+
**expires_in** | **Integer** | | [optional]
|
9
|
+
**id_token** | **String** | | [optional]
|
10
|
+
**refresh_token** | **String** | | [optional]
|
11
|
+
**scope** | **String** | | [optional]
|
12
|
+
**token_type** | **String** | | [optional]
|
13
13
|
|
14
14
|
## Code Sample
|
15
15
|
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**acr_values** | **Array<String>** | ACRValues is the Authentication AuthorizationContext Class Reference requested in the OAuth 2.0 Authorization request. It is a parameter defined by OpenID Connect and expresses which level of authentication (e.g. 2FA) is required. OpenID Connect defines it as follows: > Requested Authentication AuthorizationContext Class Reference values. Space-separated string that specifies the acr values that the Authorization Server is being requested to use for processing this Authentication Request, with the values appearing in order of preference. The Authentication AuthorizationContext Class satisfied by the authentication performed is returned as the acr Claim Value, as specified in Section 2. The acr Claim is requested as a Voluntary Claim by this parameter. | [optional]
|
8
8
|
**display** | **String** | Display is a string value that specifies how the Authorization Server displays the authentication and consent user interface pages to the End-User. The defined values are: page: The Authorization Server SHOULD display the authentication and consent UI consistent with a full User Agent page view. If the display parameter is not specified, this is the default display mode. popup: The Authorization Server SHOULD display the authentication and consent UI consistent with a popup User Agent window. The popup User Agent window should be of an appropriate size for a login-focused dialog and should not obscure the entire window that it is popping up over. touch: The Authorization Server SHOULD display the authentication and consent UI consistent with a device that leverages a touch interface. wap: The Authorization Server SHOULD display the authentication and consent UI consistent with a \"feature phone\" type display. The Authorization Server MAY also attempt to detect the capabilities of the User Agent and present an appropriate display. | [optional]
|
9
|
-
**id_token_hint_claims** | **
|
9
|
+
**id_token_hint_claims** | [**Object**](.md) | IDTokenHintClaims are the claims of the ID Token previously issued by the Authorization Server being passed as a hint about the End-User's current or past authenticated session with the Client. | [optional]
|
10
10
|
**login_hint** | **String** | LoginHint hints about the login identifier the End-User might use to log in (if necessary). This hint can be used by an RP if it first asks the End-User for their e-mail address (or other identifier) and then wants to pass that value as a hint to the discovered authorization service. This value MAY also be a phone number in the format specified for the phone_number Claim. The use of this parameter is optional. | [optional]
|
11
11
|
**ui_locales** | **Array<String>** | UILocales is the End-User'id preferred languages and scripts for the user interface, represented as a space-separated list of BCP47 [RFC5646] language tag values, ordered by preference. For instance, the value \"fr-CA fr en\" represents a preference for French as spoken in Canada, then French (without a region designation), followed by English (without a region designation). An error SHOULD NOT result if some or all of the requested locales are not supported by the OpenID Provider. | [optional]
|
12
12
|
|
@@ -0,0 +1,47 @@
|
|
1
|
+
# OryHydraClient::PluginConfig
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**args** | [**PluginConfigArgs**](PluginConfigArgs.md) | |
|
8
|
+
**description** | **String** | description |
|
9
|
+
**docker_version** | **String** | Docker Version used to create the plugin | [optional]
|
10
|
+
**documentation** | **String** | documentation |
|
11
|
+
**entrypoint** | **Array<String>** | entrypoint |
|
12
|
+
**env** | [**Array<PluginEnv>**](PluginEnv.md) | env |
|
13
|
+
**interface** | [**PluginConfigInterface**](PluginConfigInterface.md) | |
|
14
|
+
**ipc_host** | **Boolean** | ipc host |
|
15
|
+
**linux** | [**PluginConfigLinux**](PluginConfigLinux.md) | |
|
16
|
+
**mounts** | [**Array<PluginMount>**](PluginMount.md) | mounts |
|
17
|
+
**network** | [**PluginConfigNetwork**](PluginConfigNetwork.md) | |
|
18
|
+
**pid_host** | **Boolean** | pid host |
|
19
|
+
**propagated_mount** | **String** | propagated mount |
|
20
|
+
**user** | [**PluginConfigUser**](PluginConfigUser.md) | | [optional]
|
21
|
+
**work_dir** | **String** | work dir |
|
22
|
+
**rootfs** | [**PluginConfigRootfs**](PluginConfigRootfs.md) | | [optional]
|
23
|
+
|
24
|
+
## Code Sample
|
25
|
+
|
26
|
+
```ruby
|
27
|
+
require 'OryHydraClient'
|
28
|
+
|
29
|
+
instance = OryHydraClient::PluginConfig.new(args: null,
|
30
|
+
description: null,
|
31
|
+
docker_version: null,
|
32
|
+
documentation: null,
|
33
|
+
entrypoint: null,
|
34
|
+
env: null,
|
35
|
+
interface: null,
|
36
|
+
ipc_host: null,
|
37
|
+
linux: null,
|
38
|
+
mounts: null,
|
39
|
+
network: null,
|
40
|
+
pid_host: null,
|
41
|
+
propagated_mount: null,
|
42
|
+
user: null,
|
43
|
+
work_dir: null,
|
44
|
+
rootfs: null)
|
45
|
+
```
|
46
|
+
|
47
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# OryHydraClient::PluginConfigArgs
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**description** | **String** | description |
|
8
|
+
**name** | **String** | name |
|
9
|
+
**settable** | **Array<String>** | settable |
|
10
|
+
**value** | **Array<String>** | value |
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'OryHydraClient'
|
16
|
+
|
17
|
+
instance = OryHydraClient::PluginConfigArgs.new(description: null,
|
18
|
+
name: null,
|
19
|
+
settable: null,
|
20
|
+
value: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# OryHydraClient::PluginConfigInterface
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**socket** | **String** | socket |
|
8
|
+
**types** | [**Array<PluginInterfaceType>**](PluginInterfaceType.md) | types |
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'OryHydraClient'
|
14
|
+
|
15
|
+
instance = OryHydraClient::PluginConfigInterface.new(socket: null,
|
16
|
+
types: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# OryHydraClient::PluginConfigLinux
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**allow_all_devices** | **Boolean** | allow all devices |
|
8
|
+
**capabilities** | **Array<String>** | capabilities |
|
9
|
+
**devices** | [**Array<PluginDevice>**](PluginDevice.md) | devices |
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'OryHydraClient'
|
15
|
+
|
16
|
+
instance = OryHydraClient::PluginConfigLinux.new(allow_all_devices: null,
|
17
|
+
capabilities: null,
|
18
|
+
devices: null)
|
19
|
+
```
|
20
|
+
|
21
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# OryHydraClient::PluginConfigNetwork
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**type** | **String** | type |
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'OryHydraClient'
|
13
|
+
|
14
|
+
instance = OryHydraClient::PluginConfigNetwork.new(type: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# OryHydraClient::PluginConfigRootfs
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**diff_ids** | **Array<String>** | diff ids | [optional]
|
8
|
+
**type** | **String** | type | [optional]
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'OryHydraClient'
|
14
|
+
|
15
|
+
instance = OryHydraClient::PluginConfigRootfs.new(diff_ids: null,
|
16
|
+
type: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|