ory-hydra-client 0.0.0.alpha63 → 1.2.0.alpha2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile +1 -1
- data/README.md +37 -45
- data/docs/AcceptConsentRequest.md +2 -4
- data/docs/AcceptLoginRequest.md +1 -1
- data/docs/AdminApi.md +70 -110
- data/docs/AttributeTypeAndValue.md +19 -0
- data/docs/Certificate.md +101 -0
- data/docs/CompletedRequest.md +1 -1
- data/docs/ConsentRequest.md +4 -4
- data/docs/ConsentRequestSession.md +2 -2
- data/docs/Extension.md +21 -0
- data/docs/IPNet.md +19 -0
- data/docs/JSONWebKey.md +12 -12
- data/docs/LoginRequest.md +7 -7
- data/docs/Name.md +27 -0
- data/docs/OAuth2Client.md +11 -13
- data/docs/OAuth2TokenIntrospection.md +3 -5
- data/docs/Oauth2TokenResponse.md +6 -6
- data/docs/OpenIDConnectContext.md +1 -1
- data/docs/PreviousConsentSession.md +2 -4
- data/docs/PublicApi.md +15 -15
- data/docs/RejectRequest.md +5 -5
- data/docs/URL.md +33 -0
- data/docs/WellKnown.md +1 -3
- data/lib/ory-hydra-client.rb +9 -16
- data/lib/ory-hydra-client/api/admin_api.rb +47 -113
- data/lib/ory-hydra-client/api/public_api.rb +12 -12
- data/lib/ory-hydra-client/api_client.rb +7 -9
- 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 +5 -12
- data/lib/ory-hydra-client/models/accept_login_request.rb +7 -4
- data/lib/ory-hydra-client/models/{plugin_config_rootfs.rb → attribute_type_and_value.rb} +21 -22
- data/lib/ory-hydra-client/models/certificate.rb +683 -0
- data/lib/ory-hydra-client/models/completed_request.rb +2 -7
- data/lib/ory-hydra-client/models/consent_request.rb +10 -10
- data/lib/ory-hydra-client/models/consent_request_session.rb +10 -6
- data/lib/ory-hydra-client/models/{plugin_config_network.rb → extension.rb} +37 -19
- 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 -2
- data/lib/ory-hydra-client/models/health_status.rb +2 -2
- data/lib/ory-hydra-client/models/{plugin_config_user.rb → ip_net.rb} +23 -21
- data/lib/ory-hydra-client/models/json_web_key.rb +15 -3
- 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 +3 -2
- data/lib/ory-hydra-client/models/login_request.rb +5 -38
- data/lib/ory-hydra-client/models/logout_request.rb +2 -2
- data/lib/ory-hydra-client/models/{plugin_settings.rb → name.rb} +61 -58
- data/lib/ory-hydra-client/models/o_auth2_client.rb +14 -15
- data/lib/ory-hydra-client/models/o_auth2_token_introspection.rb +9 -17
- data/lib/ory-hydra-client/models/oauth2_token_response.rb +8 -2
- data/lib/ory-hydra-client/models/oauth_token_response.rb +2 -2
- data/lib/ory-hydra-client/models/open_id_connect_context.rb +6 -4
- data/lib/ory-hydra-client/models/previous_consent_session.rb +6 -13
- data/lib/ory-hydra-client/models/reject_request.rb +7 -7
- data/lib/ory-hydra-client/models/{plugin_device.rb → url.rb} +77 -49
- data/lib/ory-hydra-client/models/userinfo_response.rb +3 -3
- data/lib/ory-hydra-client/models/version.rb +3 -2
- data/lib/ory-hydra-client/models/well_known.rb +3 -15
- data/lib/ory-hydra-client/version.rb +3 -3
- data/ory-hydra-client.gemspec +2 -2
- data/spec/models/{plugin_config_rootfs_spec.rb → attribute_type_and_value_spec.rb} +9 -9
- data/spec/models/certificate_spec.rb +293 -0
- data/spec/models/{plugin_interface_type_spec.rb → extension_spec.rb} +10 -10
- data/spec/models/{plugin_config_user_spec.rb → ip_net_spec.rb} +9 -9
- data/spec/models/{plugin_mount_spec.rb → name_spec.rb} +13 -19
- data/spec/models/url_spec.rb +89 -0
- metadata +43 -75
- data/docs/ContainerWaitOKBodyError.md +0 -17
- data/docs/PluginConfig.md +0 -47
- data/docs/PluginConfigArgs.md +0 -23
- data/docs/PluginConfigInterface.md +0 -19
- data/docs/PluginConfigLinux.md +0 -21
- data/docs/PluginConfigNetwork.md +0 -17
- data/docs/PluginConfigRootfs.md +0 -19
- data/docs/PluginConfigUser.md +0 -19
- data/docs/PluginDevice.md +0 -23
- data/docs/PluginEnv.md +0 -23
- data/docs/PluginInterfaceType.md +0 -21
- data/docs/PluginMount.md +0 -29
- data/docs/PluginSettings.md +0 -23
- data/docs/VolumeUsageData.md +0 -19
- data/lib/ory-hydra-client/models/container_wait_ok_body_error.rb +0 -208
- data/lib/ory-hydra-client/models/plugin_config.rb +0 -422
- data/lib/ory-hydra-client/models/plugin_config_args.rb +0 -262
- data/lib/ory-hydra-client/models/plugin_config_interface.rb +0 -230
- data/lib/ory-hydra-client/models/plugin_config_linux.rb +0 -247
- data/lib/ory-hydra-client/models/plugin_env.rb +0 -260
- data/lib/ory-hydra-client/models/plugin_interface_type.rb +0 -243
- data/lib/ory-hydra-client/models/plugin_mount.rb +0 -307
- data/lib/ory-hydra-client/models/volume_usage_data.rb +0 -228
- data/spec/models/container_wait_ok_body_error_spec.rb +0 -41
- data/spec/models/plugin_config_args_spec.rb +0 -59
- data/spec/models/plugin_config_interface_spec.rb +0 -47
- data/spec/models/plugin_config_linux_spec.rb +0 -53
- data/spec/models/plugin_config_network_spec.rb +0 -41
- data/spec/models/plugin_config_spec.rb +0 -131
- data/spec/models/plugin_device_spec.rb +0 -59
- data/spec/models/plugin_env_spec.rb +0 -59
- data/spec/models/plugin_settings_spec.rb +0 -59
- data/spec/models/volume_usage_data_spec.rb +0 -47
data/docs/RejectRequest.md
CHANGED
|
@@ -4,11 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
|
7
|
-
**error** | **String** |
|
|
8
|
-
**error_debug** | **String** |
|
|
9
|
-
**error_description** | **String** |
|
|
10
|
-
**error_hint** | **String** |
|
|
11
|
-
**status_code** | **Integer** |
|
|
7
|
+
**error** | **String** | error | [optional]
|
|
8
|
+
**error_debug** | **String** | error debug | [optional]
|
|
9
|
+
**error_description** | **String** | error description | [optional]
|
|
10
|
+
**error_hint** | **String** | error hint | [optional]
|
|
11
|
+
**status_code** | **Integer** | status code | [optional]
|
|
12
12
|
|
|
13
13
|
## Code Sample
|
|
14
14
|
|
data/docs/URL.md
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# OryHydraClient::URL
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
Name | Type | Description | Notes
|
|
6
|
+
------------ | ------------- | ------------- | -------------
|
|
7
|
+
**force_query** | **Boolean** | force query | [optional]
|
|
8
|
+
**fragment** | **String** | fragment | [optional]
|
|
9
|
+
**host** | **String** | host | [optional]
|
|
10
|
+
**opaque** | **String** | opaque | [optional]
|
|
11
|
+
**path** | **String** | path | [optional]
|
|
12
|
+
**raw_path** | **String** | raw path | [optional]
|
|
13
|
+
**raw_query** | **String** | raw query | [optional]
|
|
14
|
+
**scheme** | **String** | scheme | [optional]
|
|
15
|
+
**user** | [**Object**](.md) | Userinfo Userinfo Userinfo The Userinfo type is an immutable encapsulation of username and password details for a URL. An existing Userinfo value is guaranteed to have a username set (potentially empty, as allowed by RFC 2396), and optionally a password. | [optional]
|
|
16
|
+
|
|
17
|
+
## Code Sample
|
|
18
|
+
|
|
19
|
+
```ruby
|
|
20
|
+
require 'OryHydraClient'
|
|
21
|
+
|
|
22
|
+
instance = OryHydraClient::URL.new(force_query: null,
|
|
23
|
+
fragment: null,
|
|
24
|
+
host: null,
|
|
25
|
+
opaque: null,
|
|
26
|
+
path: null,
|
|
27
|
+
raw_path: null,
|
|
28
|
+
raw_query: null,
|
|
29
|
+
scheme: null,
|
|
30
|
+
user: null)
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
|
data/docs/WellKnown.md
CHANGED
|
@@ -17,7 +17,6 @@ Name | Type | Description | Notes
|
|
|
17
17
|
**issuer** | **String** | URL using the https scheme with no query or fragment component that the OP asserts as its IssuerURL Identifier. If IssuerURL discovery is supported , this value MUST be identical to the issuer value returned by WebFinger. This also MUST be identical to the iss Claim value in ID Tokens issued from this IssuerURL. |
|
|
18
18
|
**jwks_uri** | **String** | URL of the OP's JSON Web Key Set [JWK] document. This contains the signing key(s) the RP uses to validate signatures from the OP. The JWK Set MAY also contain the Server's encryption key(s), which are used by RPs to encrypt requests to the Server. When both signing and encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced JWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both signatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used to provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST match those in the certificate. |
|
|
19
19
|
**registration_endpoint** | **String** | URL of the OP's Dynamic Client Registration Endpoint. | [optional]
|
|
20
|
-
**request_object_signing_alg_values_supported** | **Array<String>** | JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for Request Objects, which are described in Section 6.1 of OpenID Connect Core 1.0 [OpenID.Core]. These algorithms are used both when the Request Object is passed by value (using the request parameter) and when it is passed by reference (using the request_uri parameter). | [optional]
|
|
21
20
|
**request_parameter_supported** | **Boolean** | Boolean value specifying whether the OP supports use of the request parameter, with true indicating support. | [optional]
|
|
22
21
|
**request_uri_parameter_supported** | **Boolean** | Boolean value specifying whether the OP supports use of the request_uri parameter, with true indicating support. | [optional]
|
|
23
22
|
**require_request_uri_registration** | **Boolean** | Boolean value specifying whether the OP requires any request_uri values used to be pre-registered using the request_uris registration parameter. | [optional]
|
|
@@ -49,7 +48,6 @@ instance = OryHydraClient::WellKnown.new(authorization_endpoint: https://playgro
|
|
|
49
48
|
issuer: https://playground.ory.sh/ory-hydra/public/,
|
|
50
49
|
jwks_uri: https://playground.ory.sh/ory-hydra/public/.well-known/jwks.json,
|
|
51
50
|
registration_endpoint: https://playground.ory.sh/ory-hydra/admin/client,
|
|
52
|
-
request_object_signing_alg_values_supported: null,
|
|
53
51
|
request_parameter_supported: null,
|
|
54
52
|
request_uri_parameter_supported: null,
|
|
55
53
|
require_request_uri_registration: null,
|
|
@@ -57,7 +55,7 @@ instance = OryHydraClient::WellKnown.new(authorization_endpoint: https://playgro
|
|
|
57
55
|
response_types_supported: null,
|
|
58
56
|
revocation_endpoint: null,
|
|
59
57
|
scopes_supported: null,
|
|
60
|
-
subject_types_supported:
|
|
58
|
+
subject_types_supported: public, pairwise,
|
|
61
59
|
token_endpoint: https://playground.ory.sh/ory-hydra/public/oauth2/token,
|
|
62
60
|
token_endpoint_auth_methods_supported: null,
|
|
63
61
|
userinfo_endpoint: null,
|
data/lib/ory-hydra-client.rb
CHANGED
|
@@ -3,10 +3,10 @@
|
|
|
3
3
|
|
|
4
4
|
#Welcome to the ORY Hydra HTTP API documentation. You will find documentation for all HTTP APIs here.
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document:
|
|
6
|
+
The version of the OpenAPI document: latest
|
|
7
7
|
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
OpenAPI Generator version: 4.
|
|
9
|
+
OpenAPI Generator version: 4.2.2
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -19,40 +19,33 @@ require 'ory-hydra-client/configuration'
|
|
|
19
19
|
# Models
|
|
20
20
|
require 'ory-hydra-client/models/accept_consent_request'
|
|
21
21
|
require 'ory-hydra-client/models/accept_login_request'
|
|
22
|
+
require 'ory-hydra-client/models/attribute_type_and_value'
|
|
23
|
+
require 'ory-hydra-client/models/certificate'
|
|
22
24
|
require 'ory-hydra-client/models/completed_request'
|
|
23
25
|
require 'ory-hydra-client/models/consent_request'
|
|
24
26
|
require 'ory-hydra-client/models/consent_request_session'
|
|
25
|
-
require 'ory-hydra-client/models/
|
|
27
|
+
require 'ory-hydra-client/models/extension'
|
|
26
28
|
require 'ory-hydra-client/models/flush_inactive_o_auth2_tokens_request'
|
|
27
29
|
require 'ory-hydra-client/models/generic_error'
|
|
28
30
|
require 'ory-hydra-client/models/health_not_ready_status'
|
|
29
31
|
require 'ory-hydra-client/models/health_status'
|
|
32
|
+
require 'ory-hydra-client/models/ip_net'
|
|
30
33
|
require 'ory-hydra-client/models/json_web_key'
|
|
31
34
|
require 'ory-hydra-client/models/json_web_key_set'
|
|
32
35
|
require 'ory-hydra-client/models/json_web_key_set_generator_request'
|
|
33
36
|
require 'ory-hydra-client/models/login_request'
|
|
34
37
|
require 'ory-hydra-client/models/logout_request'
|
|
38
|
+
require 'ory-hydra-client/models/name'
|
|
35
39
|
require 'ory-hydra-client/models/o_auth2_client'
|
|
36
40
|
require 'ory-hydra-client/models/o_auth2_token_introspection'
|
|
37
41
|
require 'ory-hydra-client/models/oauth2_token_response'
|
|
42
|
+
require 'ory-hydra-client/models/oauth_token_response'
|
|
38
43
|
require 'ory-hydra-client/models/open_id_connect_context'
|
|
39
|
-
require 'ory-hydra-client/models/plugin_config'
|
|
40
|
-
require 'ory-hydra-client/models/plugin_config_args'
|
|
41
|
-
require 'ory-hydra-client/models/plugin_config_interface'
|
|
42
|
-
require 'ory-hydra-client/models/plugin_config_linux'
|
|
43
|
-
require 'ory-hydra-client/models/plugin_config_network'
|
|
44
|
-
require 'ory-hydra-client/models/plugin_config_rootfs'
|
|
45
|
-
require 'ory-hydra-client/models/plugin_config_user'
|
|
46
|
-
require 'ory-hydra-client/models/plugin_device'
|
|
47
|
-
require 'ory-hydra-client/models/plugin_env'
|
|
48
|
-
require 'ory-hydra-client/models/plugin_interface_type'
|
|
49
|
-
require 'ory-hydra-client/models/plugin_mount'
|
|
50
|
-
require 'ory-hydra-client/models/plugin_settings'
|
|
51
44
|
require 'ory-hydra-client/models/previous_consent_session'
|
|
52
45
|
require 'ory-hydra-client/models/reject_request'
|
|
46
|
+
require 'ory-hydra-client/models/url'
|
|
53
47
|
require 'ory-hydra-client/models/userinfo_response'
|
|
54
48
|
require 'ory-hydra-client/models/version'
|
|
55
|
-
require 'ory-hydra-client/models/volume_usage_data'
|
|
56
49
|
require 'ory-hydra-client/models/well_known'
|
|
57
50
|
|
|
58
51
|
# APIs
|
|
@@ -3,10 +3,10 @@
|
|
|
3
3
|
|
|
4
4
|
#Welcome to the ORY Hydra HTTP API documentation. You will find documentation for all HTTP APIs here.
|
|
5
5
|
|
|
6
|
-
The version of the OpenAPI document:
|
|
6
|
+
The version of the OpenAPI document: latest
|
|
7
7
|
|
|
8
8
|
Generated by: https://openapi-generator.tech
|
|
9
|
-
OpenAPI Generator version: 4.
|
|
9
|
+
OpenAPI Generator version: 4.2.2
|
|
10
10
|
|
|
11
11
|
=end
|
|
12
12
|
|
|
@@ -19,7 +19,7 @@ module OryHydraClient
|
|
|
19
19
|
def initialize(api_client = ApiClient.default)
|
|
20
20
|
@api_client = api_client
|
|
21
21
|
end
|
|
22
|
-
# Accept
|
|
22
|
+
# Accept an consent request
|
|
23
23
|
# When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider to authenticate the subject and then tell ORY Hydra now about it. If the subject authenticated, he/she must now be asked if the OAuth 2.0 Client which initiated the flow should be allowed to access the resources on the subject's behalf. The consent provider which handles this request and is a web app implemented and hosted by you. It shows a subject interface which asks the subject to grant or deny the client access to the requested scope (\"Application my-dropbox-app wants write access to all your private files\"). The consent challenge is appended to the consent provider's URL to which the subject's user-agent (browser) is redirected to. The consent provider uses that challenge to fetch information on the OAuth2 request and then tells ORY Hydra if the subject accepted or rejected the request. This endpoint tells ORY Hydra that the subject has authorized the OAuth 2.0 client to access resources on his/her behalf. The consent provider includes additional information, such as session data for access and ID tokens, and if the consent request should be used as basis for future requests. The response contains a redirect URL which the consent provider should redirect the user-agent to.
|
|
24
24
|
# @param consent_challenge [String]
|
|
25
25
|
# @param [Hash] opts the optional parameters
|
|
@@ -30,7 +30,7 @@ module OryHydraClient
|
|
|
30
30
|
data
|
|
31
31
|
end
|
|
32
32
|
|
|
33
|
-
# Accept
|
|
33
|
+
# Accept an consent request
|
|
34
34
|
# When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider to authenticate the subject and then tell ORY Hydra now about it. If the subject authenticated, he/she must now be asked if the OAuth 2.0 Client which initiated the flow should be allowed to access the resources on the subject's behalf. The consent provider which handles this request and is a web app implemented and hosted by you. It shows a subject interface which asks the subject to grant or deny the client access to the requested scope (\"Application my-dropbox-app wants write access to all your private files\"). The consent challenge is appended to the consent provider's URL to which the subject's user-agent (browser) is redirected to. The consent provider uses that challenge to fetch information on the OAuth2 request and then tells ORY Hydra if the subject accepted or rejected the request. This endpoint tells ORY Hydra that the subject has authorized the OAuth 2.0 client to access resources on his/her behalf. The consent provider includes additional information, such as session data for access and ID tokens, and if the consent request should be used as basis for future requests. The response contains a redirect URL which the consent provider should redirect the user-agent to.
|
|
35
35
|
# @param consent_challenge [String]
|
|
36
36
|
# @param [Hash] opts the optional parameters
|
|
@@ -86,7 +86,7 @@ module OryHydraClient
|
|
|
86
86
|
return data, status_code, headers
|
|
87
87
|
end
|
|
88
88
|
|
|
89
|
-
# Accept
|
|
89
|
+
# Accept an login request
|
|
90
90
|
# When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider (sometimes called \"identity provider\") to authenticate the subject and then tell ORY Hydra now about it. The login provider is an web-app you write and host, and it must be able to authenticate (\"show the subject a login screen\") a subject (in OAuth2 the proper name for subject is \"resource owner\"). The authentication challenge is appended to the login provider URL to which the subject's user-agent (browser) is redirected to. The login provider uses that challenge to fetch information on the OAuth2 request and then accept or reject the requested authentication process. This endpoint tells ORY Hydra that the subject has successfully authenticated and includes additional information such as the subject's ID and if ORY Hydra should remember the subject's subject agent for future authentication attempts by setting a cookie. The response contains a redirect URL which the login provider should redirect the user-agent to.
|
|
91
91
|
# @param login_challenge [String]
|
|
92
92
|
# @param [Hash] opts the optional parameters
|
|
@@ -97,7 +97,7 @@ module OryHydraClient
|
|
|
97
97
|
data
|
|
98
98
|
end
|
|
99
99
|
|
|
100
|
-
# Accept
|
|
100
|
+
# Accept an login request
|
|
101
101
|
# When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider (sometimes called \"identity provider\") to authenticate the subject and then tell ORY Hydra now about it. The login provider is an web-app you write and host, and it must be able to authenticate (\"show the subject a login screen\") a subject (in OAuth2 the proper name for subject is \"resource owner\"). The authentication challenge is appended to the login provider URL to which the subject's user-agent (browser) is redirected to. The login provider uses that challenge to fetch information on the OAuth2 request and then accept or reject the requested authentication process. This endpoint tells ORY Hydra that the subject has successfully authenticated and includes additional information such as the subject's ID and if ORY Hydra should remember the subject's subject agent for future authentication attempts by setting a cookie. The response contains a redirect URL which the login provider should redirect the user-agent to.
|
|
102
102
|
# @param login_challenge [String]
|
|
103
103
|
# @param [Hash] opts the optional parameters
|
|
@@ -153,7 +153,7 @@ module OryHydraClient
|
|
|
153
153
|
return data, status_code, headers
|
|
154
154
|
end
|
|
155
155
|
|
|
156
|
-
# Accept a
|
|
156
|
+
# Accept a logout request
|
|
157
157
|
# When a user or an application requests ORY Hydra to log out a user, this endpoint is used to confirm that logout request. No body is required. The response contains a redirect URL which the consent provider should redirect the user-agent to.
|
|
158
158
|
# @param logout_challenge [String]
|
|
159
159
|
# @param [Hash] opts the optional parameters
|
|
@@ -163,7 +163,7 @@ module OryHydraClient
|
|
|
163
163
|
data
|
|
164
164
|
end
|
|
165
165
|
|
|
166
|
-
# Accept a
|
|
166
|
+
# Accept a logout request
|
|
167
167
|
# When a user or an application requests ORY Hydra to log out a user, this endpoint is used to confirm that logout request. No body is required. The response contains a redirect URL which the consent provider should redirect the user-agent to.
|
|
168
168
|
# @param logout_challenge [String]
|
|
169
169
|
# @param [Hash] opts the optional parameters
|
|
@@ -216,7 +216,7 @@ module OryHydraClient
|
|
|
216
216
|
return data, status_code, headers
|
|
217
217
|
end
|
|
218
218
|
|
|
219
|
-
# Generate a
|
|
219
|
+
# Generate a new JSON Web Key
|
|
220
220
|
# This endpoint is capable of generating JSON Web Key Sets for you. There a different strategies available, such as symmetric cryptographic keys (HS256, HS512) and asymetric cryptographic keys (RS256, ECDSA). If the specified JSON Web Key Set does not exist, it will be created. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
|
|
221
221
|
# @param set [String] The set
|
|
222
222
|
# @param [Hash] opts the optional parameters
|
|
@@ -227,7 +227,7 @@ module OryHydraClient
|
|
|
227
227
|
data
|
|
228
228
|
end
|
|
229
229
|
|
|
230
|
-
# Generate a
|
|
230
|
+
# Generate a new JSON Web Key
|
|
231
231
|
# This endpoint is capable of generating JSON Web Key Sets for you. There a different strategies available, such as symmetric cryptographic keys (HS256, HS512) and asymetric cryptographic keys (RS256, ECDSA). If the specified JSON Web Key Set does not exist, it will be created. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.
|
|
232
232
|
# @param set [String] The set
|
|
233
233
|
# @param [Hash] opts the optional parameters
|
|
@@ -282,7 +282,7 @@ module OryHydraClient
|
|
|
282
282
|
return data, status_code, headers
|
|
283
283
|
end
|
|
284
284
|
|
|
285
|
-
# Create an OAuth 2.0
|
|
285
|
+
# Create an OAuth 2.0 client
|
|
286
286
|
# Create a new OAuth 2.0 client If you pass `client_secret` the secret will be used, otherwise a random secret will be generated. The secret will be returned in the response and you will not be able to retrieve it later on. Write the secret down and keep it somwhere safe. OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities. To manage ORY Hydra, you will need an OAuth 2.0 Client as well. Make sure that this endpoint is well protected and only callable by first-party components.
|
|
287
287
|
# @param body [OAuth2Client]
|
|
288
288
|
# @param [Hash] opts the optional parameters
|
|
@@ -292,7 +292,7 @@ module OryHydraClient
|
|
|
292
292
|
data
|
|
293
293
|
end
|
|
294
294
|
|
|
295
|
-
# Create an OAuth 2.0
|
|
295
|
+
# Create an OAuth 2.0 client
|
|
296
296
|
# Create a new OAuth 2.0 client If you pass `client_secret` the secret will be used, otherwise a random secret will be generated. The secret will be returned in the response and you will not be able to retrieve it later on. Write the secret down and keep it somwhere safe. OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities. To manage ORY Hydra, you will need an OAuth 2.0 Client as well. Make sure that this endpoint is well protected and only callable by first-party components.
|
|
297
297
|
# @param body [OAuth2Client]
|
|
298
298
|
# @param [Hash] opts the optional parameters
|
|
@@ -538,69 +538,6 @@ module OryHydraClient
|
|
|
538
538
|
return data, status_code, headers
|
|
539
539
|
end
|
|
540
540
|
|
|
541
|
-
# Delete OAuth2 Access Tokens from a Client
|
|
542
|
-
# This endpoint deletes OAuth2 access tokens issued for a client from the database
|
|
543
|
-
# @param client_id [String]
|
|
544
|
-
# @param [Hash] opts the optional parameters
|
|
545
|
-
# @return [nil]
|
|
546
|
-
def delete_o_auth2_token(client_id, opts = {})
|
|
547
|
-
delete_o_auth2_token_with_http_info(client_id, opts)
|
|
548
|
-
nil
|
|
549
|
-
end
|
|
550
|
-
|
|
551
|
-
# Delete OAuth2 Access Tokens from a Client
|
|
552
|
-
# This endpoint deletes OAuth2 access tokens issued for a client from the database
|
|
553
|
-
# @param client_id [String]
|
|
554
|
-
# @param [Hash] opts the optional parameters
|
|
555
|
-
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
556
|
-
def delete_o_auth2_token_with_http_info(client_id, opts = {})
|
|
557
|
-
if @api_client.config.debugging
|
|
558
|
-
@api_client.config.logger.debug 'Calling API: AdminApi.delete_o_auth2_token ...'
|
|
559
|
-
end
|
|
560
|
-
# verify the required parameter 'client_id' is set
|
|
561
|
-
if @api_client.config.client_side_validation && client_id.nil?
|
|
562
|
-
fail ArgumentError, "Missing the required parameter 'client_id' when calling AdminApi.delete_o_auth2_token"
|
|
563
|
-
end
|
|
564
|
-
# resource path
|
|
565
|
-
local_var_path = '/oauth2/tokens'
|
|
566
|
-
|
|
567
|
-
# query parameters
|
|
568
|
-
query_params = opts[:query_params] || {}
|
|
569
|
-
query_params[:'client_id'] = client_id
|
|
570
|
-
|
|
571
|
-
# header parameters
|
|
572
|
-
header_params = opts[:header_params] || {}
|
|
573
|
-
# HTTP header 'Accept' (if needed)
|
|
574
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
575
|
-
|
|
576
|
-
# form parameters
|
|
577
|
-
form_params = opts[:form_params] || {}
|
|
578
|
-
|
|
579
|
-
# http body (model)
|
|
580
|
-
post_body = opts[:body]
|
|
581
|
-
|
|
582
|
-
# return_type
|
|
583
|
-
return_type = opts[:return_type]
|
|
584
|
-
|
|
585
|
-
# auth_names
|
|
586
|
-
auth_names = opts[:auth_names] || []
|
|
587
|
-
|
|
588
|
-
new_options = opts.merge(
|
|
589
|
-
:header_params => header_params,
|
|
590
|
-
:query_params => query_params,
|
|
591
|
-
:form_params => form_params,
|
|
592
|
-
:body => post_body,
|
|
593
|
-
:auth_names => auth_names,
|
|
594
|
-
:return_type => return_type
|
|
595
|
-
)
|
|
596
|
-
|
|
597
|
-
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
598
|
-
if @api_client.config.debugging
|
|
599
|
-
@api_client.config.logger.debug "API called: AdminApi#delete_o_auth2_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
600
|
-
end
|
|
601
|
-
return data, status_code, headers
|
|
602
|
-
end
|
|
603
|
-
|
|
604
541
|
# Flush Expired OAuth2 Access Tokens
|
|
605
542
|
# This endpoint flushes expired OAuth2 access tokens from the database. You can set a time after which no tokens will be not be touched, in case you want to keep recent tokens for auditing. Refresh tokens can not be flushed as they are deleted automatically when performing the refresh flow.
|
|
606
543
|
# @param [Hash] opts the optional parameters
|
|
@@ -661,7 +598,7 @@ module OryHydraClient
|
|
|
661
598
|
return data, status_code, headers
|
|
662
599
|
end
|
|
663
600
|
|
|
664
|
-
# Get
|
|
601
|
+
# Get consent request information
|
|
665
602
|
# When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider to authenticate the subject and then tell ORY Hydra now about it. If the subject authenticated, he/she must now be asked if the OAuth 2.0 Client which initiated the flow should be allowed to access the resources on the subject's behalf. The consent provider which handles this request and is a web app implemented and hosted by you. It shows a subject interface which asks the subject to grant or deny the client access to the requested scope (\"Application my-dropbox-app wants write access to all your private files\"). The consent challenge is appended to the consent provider's URL to which the subject's user-agent (browser) is redirected to. The consent provider uses that challenge to fetch information on the OAuth2 request and then tells ORY Hydra if the subject accepted or rejected the request.
|
|
666
603
|
# @param consent_challenge [String]
|
|
667
604
|
# @param [Hash] opts the optional parameters
|
|
@@ -671,7 +608,7 @@ module OryHydraClient
|
|
|
671
608
|
data
|
|
672
609
|
end
|
|
673
610
|
|
|
674
|
-
# Get
|
|
611
|
+
# Get consent request information
|
|
675
612
|
# When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider to authenticate the subject and then tell ORY Hydra now about it. If the subject authenticated, he/she must now be asked if the OAuth 2.0 Client which initiated the flow should be allowed to access the resources on the subject's behalf. The consent provider which handles this request and is a web app implemented and hosted by you. It shows a subject interface which asks the subject to grant or deny the client access to the requested scope (\"Application my-dropbox-app wants write access to all your private files\"). The consent challenge is appended to the consent provider's URL to which the subject's user-agent (browser) is redirected to. The consent provider uses that challenge to fetch information on the OAuth2 request and then tells ORY Hydra if the subject accepted or rejected the request.
|
|
676
613
|
# @param consent_challenge [String]
|
|
677
614
|
# @param [Hash] opts the optional parameters
|
|
@@ -854,7 +791,7 @@ module OryHydraClient
|
|
|
854
791
|
return data, status_code, headers
|
|
855
792
|
end
|
|
856
793
|
|
|
857
|
-
# Get
|
|
794
|
+
# Get an login request
|
|
858
795
|
# When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider (sometimes called \"identity provider\") to authenticate the subject and then tell ORY Hydra now about it. The login provider is an web-app you write and host, and it must be able to authenticate (\"show the subject a login screen\") a subject (in OAuth2 the proper name for subject is \"resource owner\"). The authentication challenge is appended to the login provider URL to which the subject's user-agent (browser) is redirected to. The login provider uses that challenge to fetch information on the OAuth2 request and then accept or reject the requested authentication process.
|
|
859
796
|
# @param login_challenge [String]
|
|
860
797
|
# @param [Hash] opts the optional parameters
|
|
@@ -864,7 +801,7 @@ module OryHydraClient
|
|
|
864
801
|
data
|
|
865
802
|
end
|
|
866
803
|
|
|
867
|
-
# Get
|
|
804
|
+
# Get an login request
|
|
868
805
|
# When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider (sometimes called \"identity provider\") to authenticate the subject and then tell ORY Hydra now about it. The login provider is an web-app you write and host, and it must be able to authenticate (\"show the subject a login screen\") a subject (in OAuth2 the proper name for subject is \"resource owner\"). The authentication challenge is appended to the login provider URL to which the subject's user-agent (browser) is redirected to. The login provider uses that challenge to fetch information on the OAuth2 request and then accept or reject the requested authentication process.
|
|
869
806
|
# @param login_challenge [String]
|
|
870
807
|
# @param [Hash] opts the optional parameters
|
|
@@ -917,7 +854,7 @@ module OryHydraClient
|
|
|
917
854
|
return data, status_code, headers
|
|
918
855
|
end
|
|
919
856
|
|
|
920
|
-
# Get a
|
|
857
|
+
# Get a logout request
|
|
921
858
|
# Use this endpoint to fetch a logout request.
|
|
922
859
|
# @param logout_challenge [String]
|
|
923
860
|
# @param [Hash] opts the optional parameters
|
|
@@ -927,7 +864,7 @@ module OryHydraClient
|
|
|
927
864
|
data
|
|
928
865
|
end
|
|
929
866
|
|
|
930
|
-
# Get a
|
|
867
|
+
# Get a logout request
|
|
931
868
|
# Use this endpoint to fetch a logout request.
|
|
932
869
|
# @param logout_challenge [String]
|
|
933
870
|
# @param [Hash] opts the optional parameters
|
|
@@ -1042,7 +979,7 @@ module OryHydraClient
|
|
|
1042
979
|
return data, status_code, headers
|
|
1043
980
|
end
|
|
1044
981
|
|
|
1045
|
-
# Get
|
|
982
|
+
# Get service version
|
|
1046
983
|
# This endpoint returns the service version typically notated using semantic versioning. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set.
|
|
1047
984
|
# @param [Hash] opts the optional parameters
|
|
1048
985
|
# @return [Version]
|
|
@@ -1051,7 +988,7 @@ module OryHydraClient
|
|
|
1051
988
|
data
|
|
1052
989
|
end
|
|
1053
990
|
|
|
1054
|
-
# Get
|
|
991
|
+
# Get service version
|
|
1055
992
|
# This endpoint returns the service version typically notated using semantic versioning. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set.
|
|
1056
993
|
# @param [Hash] opts the optional parameters
|
|
1057
994
|
# @return [Array<(Version, Integer, Hash)>] Version data, response status code and response headers
|
|
@@ -1098,7 +1035,7 @@ module OryHydraClient
|
|
|
1098
1035
|
return data, status_code, headers
|
|
1099
1036
|
end
|
|
1100
1037
|
|
|
1101
|
-
# Introspect OAuth2
|
|
1038
|
+
# Introspect OAuth2 tokens
|
|
1102
1039
|
# The introspection endpoint allows to check if a token (both refresh and access) is active or not. An active token is neither expired nor revoked. If a token is active, additional information on the token will be included. You can set additional data for a token by setting `accessTokenExtra` during the consent flow. For more information [read this blog post](https://www.oauth.com/oauth2-servers/token-introspection-endpoint/).
|
|
1103
1040
|
# @param token [String] The string value of the token. For access tokens, this is the \\\"access_token\\\" value returned from the token endpoint defined in OAuth 2.0. For refresh tokens, this is the \\\"refresh_token\\\" value returned.
|
|
1104
1041
|
# @param [Hash] opts the optional parameters
|
|
@@ -1109,7 +1046,7 @@ module OryHydraClient
|
|
|
1109
1046
|
data
|
|
1110
1047
|
end
|
|
1111
1048
|
|
|
1112
|
-
# Introspect OAuth2
|
|
1049
|
+
# Introspect OAuth2 tokens
|
|
1113
1050
|
# The introspection endpoint allows to check if a token (both refresh and access) is active or not. An active token is neither expired nor revoked. If a token is active, additional information on the token will be included. You can set additional data for a token by setting `accessTokenExtra` during the consent flow. For more information [read this blog post](https://www.oauth.com/oauth2-servers/token-introspection-endpoint/).
|
|
1114
1051
|
# @param token [String] The string value of the token. For access tokens, this is the \\\"access_token\\\" value returned from the token endpoint defined in OAuth 2.0. For refresh tokens, this is the \\\"refresh_token\\\" value returned.
|
|
1115
1052
|
# @param [Hash] opts the optional parameters
|
|
@@ -1148,7 +1085,7 @@ module OryHydraClient
|
|
|
1148
1085
|
return_type = opts[:return_type] || 'OAuth2TokenIntrospection'
|
|
1149
1086
|
|
|
1150
1087
|
# auth_names
|
|
1151
|
-
auth_names = opts[:auth_names] || []
|
|
1088
|
+
auth_names = opts[:auth_names] || ['basic', 'oauth2']
|
|
1152
1089
|
|
|
1153
1090
|
new_options = opts.merge(
|
|
1154
1091
|
:header_params => header_params,
|
|
@@ -1166,7 +1103,7 @@ module OryHydraClient
|
|
|
1166
1103
|
return data, status_code, headers
|
|
1167
1104
|
end
|
|
1168
1105
|
|
|
1169
|
-
# Check
|
|
1106
|
+
# Check alive status
|
|
1170
1107
|
# This endpoint returns a 200 status code when the HTTP server is up running. This status does currently not include checks whether the database connection is working. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set. Be aware that if you are running multiple nodes of this service, the health status will never refer to the cluster state, only to a single instance.
|
|
1171
1108
|
# @param [Hash] opts the optional parameters
|
|
1172
1109
|
# @return [HealthStatus]
|
|
@@ -1175,7 +1112,7 @@ module OryHydraClient
|
|
|
1175
1112
|
data
|
|
1176
1113
|
end
|
|
1177
1114
|
|
|
1178
|
-
# Check
|
|
1115
|
+
# Check alive status
|
|
1179
1116
|
# This endpoint returns a 200 status code when the HTTP server is up running. This status does currently not include checks whether the database connection is working. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set. Be aware that if you are running multiple nodes of this service, the health status will never refer to the cluster state, only to a single instance.
|
|
1180
1117
|
# @param [Hash] opts the optional parameters
|
|
1181
1118
|
# @return [Array<(HealthStatus, Integer, Hash)>] HealthStatus data, response status code and response headers
|
|
@@ -1223,9 +1160,9 @@ module OryHydraClient
|
|
|
1223
1160
|
end
|
|
1224
1161
|
|
|
1225
1162
|
# List OAuth 2.0 Clients
|
|
1226
|
-
# This endpoint lists all clients in the database, and never returns client secrets.
|
|
1163
|
+
# This endpoint lists all clients in the database, and never returns client secrets. OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities. To manage ORY Hydra, you will need an OAuth 2.0 Client as well. Make sure that this endpoint is well protected and only callable by first-party components. The \"Link\" header is also included in successful responses, which contains one or more links for pagination, formatted like so: '<https://hydra-url/admin/clients?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.
|
|
1227
1164
|
# @param [Hash] opts the optional parameters
|
|
1228
|
-
# @option opts [Integer] :limit The maximum amount of policies returned
|
|
1165
|
+
# @option opts [Integer] :limit The maximum amount of policies returned.
|
|
1229
1166
|
# @option opts [Integer] :offset The offset from where to start looking.
|
|
1230
1167
|
# @return [Array<OAuth2Client>]
|
|
1231
1168
|
def list_o_auth2_clients(opts = {})
|
|
@@ -1234,9 +1171,9 @@ module OryHydraClient
|
|
|
1234
1171
|
end
|
|
1235
1172
|
|
|
1236
1173
|
# List OAuth 2.0 Clients
|
|
1237
|
-
# This endpoint lists all clients in the database, and never returns client secrets.
|
|
1174
|
+
# This endpoint lists all clients in the database, and never returns client secrets. OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities. To manage ORY Hydra, you will need an OAuth 2.0 Client as well. Make sure that this endpoint is well protected and only callable by first-party components. The \"Link\" header is also included in successful responses, which contains one or more links for pagination, formatted like so: '<https://hydra-url/admin/clients?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.
|
|
1238
1175
|
# @param [Hash] opts the optional parameters
|
|
1239
|
-
# @option opts [Integer] :limit The maximum amount of policies returned
|
|
1176
|
+
# @option opts [Integer] :limit The maximum amount of policies returned.
|
|
1240
1177
|
# @option opts [Integer] :offset The offset from where to start looking.
|
|
1241
1178
|
# @return [Array<(Array<OAuth2Client>, Integer, Hash)>] Array<OAuth2Client> data, response status code and response headers
|
|
1242
1179
|
def list_o_auth2_clients_with_http_info(opts = {})
|
|
@@ -1284,8 +1221,8 @@ module OryHydraClient
|
|
|
1284
1221
|
return data, status_code, headers
|
|
1285
1222
|
end
|
|
1286
1223
|
|
|
1287
|
-
# Lists
|
|
1288
|
-
# This endpoint lists all subject's granted consent sessions, including client and granted scope.
|
|
1224
|
+
# Lists all consent sessions of a subject
|
|
1225
|
+
# 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.
|
|
1289
1226
|
# @param subject [String]
|
|
1290
1227
|
# @param [Hash] opts the optional parameters
|
|
1291
1228
|
# @return [Array<PreviousConsentSession>]
|
|
@@ -1294,8 +1231,8 @@ module OryHydraClient
|
|
|
1294
1231
|
data
|
|
1295
1232
|
end
|
|
1296
1233
|
|
|
1297
|
-
# Lists
|
|
1298
|
-
# This endpoint lists all subject's granted consent sessions, including client and granted scope.
|
|
1234
|
+
# Lists all consent sessions of a subject
|
|
1235
|
+
# 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.
|
|
1299
1236
|
# @param subject [String]
|
|
1300
1237
|
# @param [Hash] opts the optional parameters
|
|
1301
1238
|
# @return [Array<(Array<PreviousConsentSession>, Integer, Hash)>] Array<PreviousConsentSession> data, response status code and response headers
|
|
@@ -1347,8 +1284,8 @@ module OryHydraClient
|
|
|
1347
1284
|
return data, status_code, headers
|
|
1348
1285
|
end
|
|
1349
1286
|
|
|
1350
|
-
# Get
|
|
1351
|
-
#
|
|
1287
|
+
# Get snapshot metrics from the Hydra service. If you're using k8s, you can then add annotations to your deployment like so:
|
|
1288
|
+
# ``` metadata: annotations: prometheus.io/port: \"4445\" prometheus.io/path: \"/metrics/prometheus\" ```
|
|
1352
1289
|
# @param [Hash] opts the optional parameters
|
|
1353
1290
|
# @return [nil]
|
|
1354
1291
|
def prometheus(opts = {})
|
|
@@ -1356,8 +1293,8 @@ module OryHydraClient
|
|
|
1356
1293
|
nil
|
|
1357
1294
|
end
|
|
1358
1295
|
|
|
1359
|
-
# Get
|
|
1360
|
-
#
|
|
1296
|
+
# Get snapshot metrics from the Hydra service. If you're using k8s, you can then add annotations to your deployment like so:
|
|
1297
|
+
# ``` metadata: annotations: prometheus.io/port: \"4445\" prometheus.io/path: \"/metrics/prometheus\" ```
|
|
1361
1298
|
# @param [Hash] opts the optional parameters
|
|
1362
1299
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
1363
1300
|
def prometheus_with_http_info(opts = {})
|
|
@@ -1401,7 +1338,7 @@ module OryHydraClient
|
|
|
1401
1338
|
return data, status_code, headers
|
|
1402
1339
|
end
|
|
1403
1340
|
|
|
1404
|
-
# Reject
|
|
1341
|
+
# Reject an consent request
|
|
1405
1342
|
# When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider to authenticate the subject and then tell ORY Hydra now about it. If the subject authenticated, he/she must now be asked if the OAuth 2.0 Client which initiated the flow should be allowed to access the resources on the subject's behalf. The consent provider which handles this request and is a web app implemented and hosted by you. It shows a subject interface which asks the subject to grant or deny the client access to the requested scope (\"Application my-dropbox-app wants write access to all your private files\"). The consent challenge is appended to the consent provider's URL to which the subject's user-agent (browser) is redirected to. The consent provider uses that challenge to fetch information on the OAuth2 request and then tells ORY Hydra if the subject accepted or rejected the request. This endpoint tells ORY Hydra that the subject has not authorized the OAuth 2.0 client to access resources on his/her behalf. The consent provider must include a reason why the consent was not granted. The response contains a redirect URL which the consent provider should redirect the user-agent to.
|
|
1406
1343
|
# @param consent_challenge [String]
|
|
1407
1344
|
# @param [Hash] opts the optional parameters
|
|
@@ -1412,7 +1349,7 @@ module OryHydraClient
|
|
|
1412
1349
|
data
|
|
1413
1350
|
end
|
|
1414
1351
|
|
|
1415
|
-
# Reject
|
|
1352
|
+
# Reject an consent request
|
|
1416
1353
|
# When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider to authenticate the subject and then tell ORY Hydra now about it. If the subject authenticated, he/she must now be asked if the OAuth 2.0 Client which initiated the flow should be allowed to access the resources on the subject's behalf. The consent provider which handles this request and is a web app implemented and hosted by you. It shows a subject interface which asks the subject to grant or deny the client access to the requested scope (\"Application my-dropbox-app wants write access to all your private files\"). The consent challenge is appended to the consent provider's URL to which the subject's user-agent (browser) is redirected to. The consent provider uses that challenge to fetch information on the OAuth2 request and then tells ORY Hydra if the subject accepted or rejected the request. This endpoint tells ORY Hydra that the subject has not authorized the OAuth 2.0 client to access resources on his/her behalf. The consent provider must include a reason why the consent was not granted. The response contains a redirect URL which the consent provider should redirect the user-agent to.
|
|
1417
1354
|
# @param consent_challenge [String]
|
|
1418
1355
|
# @param [Hash] opts the optional parameters
|
|
@@ -1468,7 +1405,7 @@ module OryHydraClient
|
|
|
1468
1405
|
return data, status_code, headers
|
|
1469
1406
|
end
|
|
1470
1407
|
|
|
1471
|
-
# Reject a
|
|
1408
|
+
# Reject a login request
|
|
1472
1409
|
# When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider (sometimes called \"identity provider\") to authenticate the subject and then tell ORY Hydra now about it. The login provider is an web-app you write and host, and it must be able to authenticate (\"show the subject a login screen\") a subject (in OAuth2 the proper name for subject is \"resource owner\"). The authentication challenge is appended to the login provider URL to which the subject's user-agent (browser) is redirected to. The login provider uses that challenge to fetch information on the OAuth2 request and then accept or reject the requested authentication process. This endpoint tells ORY Hydra that the subject has not authenticated and includes a reason why the authentication was be denied. The response contains a redirect URL which the login provider should redirect the user-agent to.
|
|
1473
1410
|
# @param login_challenge [String]
|
|
1474
1411
|
# @param [Hash] opts the optional parameters
|
|
@@ -1479,7 +1416,7 @@ module OryHydraClient
|
|
|
1479
1416
|
data
|
|
1480
1417
|
end
|
|
1481
1418
|
|
|
1482
|
-
# Reject a
|
|
1419
|
+
# Reject a login request
|
|
1483
1420
|
# When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider (sometimes called \"identity provider\") to authenticate the subject and then tell ORY Hydra now about it. The login provider is an web-app you write and host, and it must be able to authenticate (\"show the subject a login screen\") a subject (in OAuth2 the proper name for subject is \"resource owner\"). The authentication challenge is appended to the login provider URL to which the subject's user-agent (browser) is redirected to. The login provider uses that challenge to fetch information on the OAuth2 request and then accept or reject the requested authentication process. This endpoint tells ORY Hydra that the subject has not authenticated and includes a reason why the authentication was be denied. The response contains a redirect URL which the login provider should redirect the user-agent to.
|
|
1484
1421
|
# @param login_challenge [String]
|
|
1485
1422
|
# @param [Hash] opts the optional parameters
|
|
@@ -1535,7 +1472,7 @@ module OryHydraClient
|
|
|
1535
1472
|
return data, status_code, headers
|
|
1536
1473
|
end
|
|
1537
1474
|
|
|
1538
|
-
# Reject a
|
|
1475
|
+
# Reject a logout request
|
|
1539
1476
|
# When a user or an application requests ORY Hydra to log out a user, this endpoint is used to deny that logout request. No body is required. The response is empty as the logout provider has to chose what action to perform next.
|
|
1540
1477
|
# @param logout_challenge [String]
|
|
1541
1478
|
# @param [Hash] opts the optional parameters
|
|
@@ -1546,7 +1483,7 @@ module OryHydraClient
|
|
|
1546
1483
|
nil
|
|
1547
1484
|
end
|
|
1548
1485
|
|
|
1549
|
-
# Reject a
|
|
1486
|
+
# Reject a logout request
|
|
1550
1487
|
# When a user or an application requests ORY Hydra to log out a user, this endpoint is used to deny that logout request. No body is required. The response is empty as the logout provider has to chose what action to perform next.
|
|
1551
1488
|
# @param logout_challenge [String]
|
|
1552
1489
|
# @param [Hash] opts the optional parameters
|
|
@@ -1602,7 +1539,7 @@ module OryHydraClient
|
|
|
1602
1539
|
return data, status_code, headers
|
|
1603
1540
|
end
|
|
1604
1541
|
|
|
1605
|
-
# Invalidates
|
|
1542
|
+
# Invalidates all login sessions of a certain user Invalidates a subject's authentication session
|
|
1606
1543
|
# This endpoint invalidates a subject's authentication session. After revoking the authentication session, the subject has to re-authenticate at ORY Hydra. This endpoint does not invalidate any tokens and does not work with OpenID Connect Front- or Back-channel logout.
|
|
1607
1544
|
# @param subject [String]
|
|
1608
1545
|
# @param [Hash] opts the optional parameters
|
|
@@ -1612,7 +1549,7 @@ module OryHydraClient
|
|
|
1612
1549
|
nil
|
|
1613
1550
|
end
|
|
1614
1551
|
|
|
1615
|
-
# Invalidates
|
|
1552
|
+
# Invalidates all login sessions of a certain user Invalidates a subject's authentication session
|
|
1616
1553
|
# This endpoint invalidates a subject's authentication session. After revoking the authentication session, the subject has to re-authenticate at ORY Hydra. This endpoint does not invalidate any tokens and does not work with OpenID Connect Front- or Back-channel logout.
|
|
1617
1554
|
# @param subject [String]
|
|
1618
1555
|
# @param [Hash] opts the optional parameters
|
|
@@ -1665,24 +1602,22 @@ module OryHydraClient
|
|
|
1665
1602
|
return data, status_code, headers
|
|
1666
1603
|
end
|
|
1667
1604
|
|
|
1668
|
-
# Revokes
|
|
1605
|
+
# Revokes consent sessions of a subject for a specific OAuth 2.0 Client
|
|
1669
1606
|
# This endpoint revokes a subject's granted consent sessions for a specific OAuth 2.0 Client and invalidates all associated OAuth 2.0 Access Tokens.
|
|
1670
1607
|
# @param subject [String] The subject (Subject) who's consent sessions should be deleted.
|
|
1671
1608
|
# @param [Hash] opts the optional parameters
|
|
1672
1609
|
# @option opts [String] :client If set, deletes only those consent sessions by the Subject that have been granted to the specified OAuth 2.0 Client ID
|
|
1673
|
-
# @option opts [Boolean] :all If set to `?all=true`, deletes all consent sessions by the Subject that have been granted.
|
|
1674
1610
|
# @return [nil]
|
|
1675
1611
|
def revoke_consent_sessions(subject, opts = {})
|
|
1676
1612
|
revoke_consent_sessions_with_http_info(subject, opts)
|
|
1677
1613
|
nil
|
|
1678
1614
|
end
|
|
1679
1615
|
|
|
1680
|
-
# Revokes
|
|
1616
|
+
# Revokes consent sessions of a subject for a specific OAuth 2.0 Client
|
|
1681
1617
|
# This endpoint revokes a subject's granted consent sessions for a specific OAuth 2.0 Client and invalidates all associated OAuth 2.0 Access Tokens.
|
|
1682
1618
|
# @param subject [String] The subject (Subject) who's consent sessions should be deleted.
|
|
1683
1619
|
# @param [Hash] opts the optional parameters
|
|
1684
1620
|
# @option opts [String] :client If set, deletes only those consent sessions by the Subject that have been granted to the specified OAuth 2.0 Client ID
|
|
1685
|
-
# @option opts [Boolean] :all If set to `?all=true`, deletes all consent sessions by the Subject that have been granted.
|
|
1686
1621
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
1687
1622
|
def revoke_consent_sessions_with_http_info(subject, opts = {})
|
|
1688
1623
|
if @api_client.config.debugging
|
|
@@ -1699,7 +1634,6 @@ module OryHydraClient
|
|
|
1699
1634
|
query_params = opts[:query_params] || {}
|
|
1700
1635
|
query_params[:'subject'] = subject
|
|
1701
1636
|
query_params[:'client'] = opts[:'client'] if !opts[:'client'].nil?
|
|
1702
|
-
query_params[:'all'] = opts[:'all'] if !opts[:'all'].nil?
|
|
1703
1637
|
|
|
1704
1638
|
# header parameters
|
|
1705
1639
|
header_params = opts[:header_params] || {}
|