ory-hydra-client 0.0.0.alpha39
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/README.md +165 -0
- data/Rakefile +10 -0
- data/docs/AcceptConsentRequest.md +25 -0
- data/docs/AcceptLoginRequest.md +27 -0
- data/docs/AdminApi.md +1443 -0
- data/docs/CompletedRequest.md +17 -0
- data/docs/ConsentRequest.md +39 -0
- data/docs/ConsentRequestSession.md +19 -0
- data/docs/FlushInactiveOAuth2TokensRequest.md +17 -0
- data/docs/GenericError.md +23 -0
- data/docs/HealthNotReadyStatus.md +17 -0
- data/docs/HealthStatus.md +17 -0
- data/docs/JSONWebKey.md +49 -0
- data/docs/JSONWebKeySet.md +17 -0
- data/docs/JsonWebKeySetGeneratorRequest.md +21 -0
- data/docs/LoginRequest.md +33 -0
- data/docs/LogoutRequest.md +23 -0
- data/docs/OAuth2Client.md +79 -0
- data/docs/OAuth2TokenIntrospection.md +41 -0
- data/docs/Oauth2TokenResponse.md +27 -0
- data/docs/OauthTokenResponse.md +27 -0
- data/docs/OpenIDConnectContext.md +25 -0
- data/docs/PreviousConsentSession.md +27 -0
- data/docs/PublicApi.md +398 -0
- data/docs/RejectRequest.md +25 -0
- data/docs/UserinfoResponse.md +53 -0
- data/docs/Version.md +17 -0
- data/docs/WellKnown.md +65 -0
- data/lib/ory-hydra-client.rb +65 -0
- data/lib/ory-hydra-client/api/admin_api.rb +1879 -0
- data/lib/ory-hydra-client/api/public_api.rb +498 -0
- data/lib/ory-hydra-client/api_client.rb +386 -0
- data/lib/ory-hydra-client/api_error.rb +57 -0
- data/lib/ory-hydra-client/configuration.rb +255 -0
- data/lib/ory-hydra-client/models/accept_consent_request.rb +250 -0
- data/lib/ory-hydra-client/models/accept_login_request.rb +264 -0
- data/lib/ory-hydra-client/models/completed_request.rb +207 -0
- data/lib/ory-hydra-client/models/consent_request.rb +321 -0
- data/lib/ory-hydra-client/models/consent_request_session.rb +221 -0
- data/lib/ory-hydra-client/models/flush_inactive_o_auth2_tokens_request.rb +207 -0
- data/lib/ory-hydra-client/models/generic_error.rb +243 -0
- data/lib/ory-hydra-client/models/health_not_ready_status.rb +209 -0
- data/lib/ory-hydra-client/models/health_status.rb +207 -0
- data/lib/ory-hydra-client/models/json_web_key.rb +377 -0
- data/lib/ory-hydra-client/models/json_web_key_set.rb +209 -0
- data/lib/ory-hydra-client/models/json_web_key_set_generator_request.rb +242 -0
- data/lib/ory-hydra-client/models/login_request.rb +289 -0
- data/lib/ory-hydra-client/models/logout_request.rb +237 -0
- data/lib/ory-hydra-client/models/o_auth2_client.rb +551 -0
- data/lib/ory-hydra-client/models/o_auth2_token_introspection.rb +337 -0
- data/lib/ory-hydra-client/models/oauth2_token_response.rb +252 -0
- data/lib/ory-hydra-client/models/oauth_token_response.rb +258 -0
- data/lib/ory-hydra-client/models/open_id_connect_context.rb +253 -0
- data/lib/ory-hydra-client/models/previous_consent_session.rb +260 -0
- data/lib/ory-hydra-client/models/reject_request.rb +242 -0
- data/lib/ory-hydra-client/models/userinfo_response.rb +388 -0
- data/lib/ory-hydra-client/models/version.rb +207 -0
- data/lib/ory-hydra-client/models/well_known.rb +501 -0
- data/lib/ory-hydra-client/version.rb +15 -0
- data/ory-hydra-client.gemspec +39 -0
- data/spec/api/admin_api_spec.rb +395 -0
- data/spec/api/public_api_spec.rb +129 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/accept_consent_request_spec.rb +65 -0
- data/spec/models/accept_login_request_spec.rb +71 -0
- data/spec/models/completed_request_spec.rb +41 -0
- data/spec/models/consent_request_session_spec.rb +47 -0
- data/spec/models/consent_request_spec.rb +107 -0
- data/spec/models/flush_inactive_o_auth2_tokens_request_spec.rb +41 -0
- data/spec/models/generic_error_spec.rb +59 -0
- data/spec/models/health_not_ready_status_spec.rb +41 -0
- data/spec/models/health_status_spec.rb +41 -0
- data/spec/models/json_web_key_set_generator_request_spec.rb +53 -0
- data/spec/models/json_web_key_set_spec.rb +41 -0
- data/spec/models/json_web_key_spec.rb +137 -0
- data/spec/models/login_request_spec.rb +89 -0
- data/spec/models/logout_request_spec.rb +59 -0
- data/spec/models/o_auth2_client_spec.rb +227 -0
- data/spec/models/o_auth2_token_introspection_spec.rb +113 -0
- data/spec/models/oauth2_token_response_spec.rb +71 -0
- data/spec/models/oauth_token_response_spec.rb +71 -0
- data/spec/models/open_id_connect_context_spec.rb +65 -0
- data/spec/models/previous_consent_session_spec.rb +71 -0
- data/spec/models/reject_request_spec.rb +65 -0
- data/spec/models/userinfo_response_spec.rb +149 -0
- data/spec/models/version_spec.rb +41 -0
- data/spec/models/well_known_spec.rb +185 -0
- data/spec/spec_helper.rb +111 -0
- metadata +223 -0
@@ -0,0 +1,17 @@
|
|
1
|
+
# OryHydraClient::CompletedRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**redirect_to** | **String** | RedirectURL is the URL which you should redirect the user to once the authentication process is completed. | [optional]
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'OryHydraClient'
|
13
|
+
|
14
|
+
instance = OryHydraClient::CompletedRequest.new(redirect_to: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,39 @@
|
|
1
|
+
# OryHydraClient::ConsentRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
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. | [optional]
|
9
|
+
**client** | [**OAuth2Client**](OAuth2Client.md) | | [optional]
|
10
|
+
**context** | **Hash<String, Object>** | Context contains arbitrary information set by the login endpoint or is empty if not set. | [optional]
|
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]
|
12
|
+
**login_session_id** | **String** | LoginSessionID 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]
|
13
|
+
**oidc_context** | [**OpenIDConnectContext**](OpenIDConnectContext.md) | | [optional]
|
14
|
+
**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. | [optional]
|
15
|
+
**requested_access_token_audience** | **Array<String>** | RequestedScope contains the access token audience as requested by the OAuth 2.0 Client. | [optional]
|
16
|
+
**requested_scope** | **Array<String>** | RequestedScope contains the OAuth 2.0 Scope requested by the OAuth 2.0 Client. | [optional]
|
17
|
+
**skip** | **Boolean** | Skip, if true, implies that the client has requested the same scopes from the same user previously. If true, you must not ask the user to grant the requested scopes. You must however either allow or deny the consent request using the usual API call. | [optional]
|
18
|
+
**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. | [optional]
|
19
|
+
|
20
|
+
## Code Sample
|
21
|
+
|
22
|
+
```ruby
|
23
|
+
require 'OryHydraClient'
|
24
|
+
|
25
|
+
instance = OryHydraClient::ConsentRequest.new(acr: null,
|
26
|
+
challenge: null,
|
27
|
+
client: null,
|
28
|
+
context: null,
|
29
|
+
login_challenge: null,
|
30
|
+
login_session_id: null,
|
31
|
+
oidc_context: null,
|
32
|
+
request_url: null,
|
33
|
+
requested_access_token_audience: null,
|
34
|
+
requested_scope: null,
|
35
|
+
skip: null,
|
36
|
+
subject: null)
|
37
|
+
```
|
38
|
+
|
39
|
+
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# OryHydraClient::ConsentRequestSession
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**access_token** | **Hash<String, Object>** | 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** | **Hash<String, Object>** | 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
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'OryHydraClient'
|
14
|
+
|
15
|
+
instance = OryHydraClient::ConsentRequestSession.new(access_token: null,
|
16
|
+
id_token: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# OryHydraClient::FlushInactiveOAuth2TokensRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**not_after** | **DateTime** | NotAfter sets after which point tokens should not be flushed. This is useful when you want to keep a history of recently issued tokens for auditing. | [optional]
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'OryHydraClient'
|
13
|
+
|
14
|
+
instance = OryHydraClient::FlushInactiveOAuth2TokensRequest.new(not_after: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# OryHydraClient::GenericError
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**debug** | **String** | Debug contains debug information. This is usually not available and has to be enabled. | [optional]
|
8
|
+
**error** | **String** | Name is the error name. |
|
9
|
+
**error_description** | **String** | Description contains further information on the nature of the error. | [optional]
|
10
|
+
**status_code** | **Integer** | Code represents the error status code (404, 403, 401, ...). | [optional]
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'OryHydraClient'
|
16
|
+
|
17
|
+
instance = OryHydraClient::GenericError.new(debug: The database adapter was unable to find the element,
|
18
|
+
error: The requested resource could not be found,
|
19
|
+
error_description: Object with ID 12345 does not exist,
|
20
|
+
status_code: 404)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# OryHydraClient::HealthNotReadyStatus
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**errors** | **Hash<String, String>** | Errors contains a list of errors that caused the not ready status. | [optional]
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'OryHydraClient'
|
13
|
+
|
14
|
+
instance = OryHydraClient::HealthNotReadyStatus.new(errors: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# OryHydraClient::HealthStatus
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**status** | **String** | Status always contains \"ok\". | [optional]
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'OryHydraClient'
|
13
|
+
|
14
|
+
instance = OryHydraClient::HealthStatus.new(status: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
data/docs/JSONWebKey.md
ADDED
@@ -0,0 +1,49 @@
|
|
1
|
+
# OryHydraClient::JSONWebKey
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
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** | | [optional]
|
9
|
+
**d** | **String** | | [optional]
|
10
|
+
**dp** | **String** | | [optional]
|
11
|
+
**dq** | **String** | | [optional]
|
12
|
+
**e** | **String** | | [optional]
|
13
|
+
**k** | **String** | | [optional]
|
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
|
+
**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** | | [optional]
|
17
|
+
**p** | **String** | | [optional]
|
18
|
+
**q** | **String** | | [optional]
|
19
|
+
**qi** | **String** | | [optional]
|
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** | | [optional]
|
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** | | [optional]
|
24
|
+
|
25
|
+
## Code Sample
|
26
|
+
|
27
|
+
```ruby
|
28
|
+
require 'OryHydraClient'
|
29
|
+
|
30
|
+
instance = OryHydraClient::JSONWebKey.new(alg: RS256,
|
31
|
+
crv: P-256,
|
32
|
+
d: T_N8I-6He3M8a7X1vWt6TGIx4xB_GP3Mb4SsZSA4v-orvJzzRiQhLlRR81naWYxfQAYt5isDI6_C2L9bdWo4FFPjGQFvNoRX-_sBJyBI_rl-TBgsZYoUlAj3J92WmY2inbA-PwyJfsaIIDceYBC-eX-xiCu6qMqkZi3MwQAFL6bMdPEM0z4JBcwFT3VdiWAIRUuACWQwrXMq672x7fMuaIaHi7XDGgt1ith23CLfaREmJku9PQcchbt_uEY-hqrFY6ntTtS4paWWQj86xLL94S-Tf6v6xkL918PfLSOTq6XCzxvlFwzBJqApnAhbwqLjpPhgUG04EDRrqrSBc5Y1BLevn6Ip5h1AhessBp3wLkQgz_roeckt-ybvzKTjESMuagnpqLvOT7Y9veIug2MwPJZI2VjczRc1vzMs25XrFQ8DpUy-bNdp89TmvAXwctUMiJdgHloJw23Cv03gIUAkDnsTqZmkpbIf-crpgNKFmQP_EDKoe8p_PXZZgfbRri3NoEVGP7Mk6yEu8LjJhClhZaBNjuWw2-KlBfOA3g79mhfBnkInee5KO9mGR50qPk1V-MorUYNTFMZIm0kFE6eYVWFBwJHLKYhHU34DoiK1VP-svZpC2uAMFNA_UJEwM9CQ2b8qe4-5e9aywMvwcuArRkAB5mBIfOaOJao3mfukKAE,
|
33
|
+
dp: G4sPXkc6Ya9y8oJW9_ILj4xuppu0lzi_H7VTkS8xj5SdX3coE0oimYwxIi2emTAue0UOa5dpgFGyBJ4c8tQ2VF402XRugKDTP8akYhFo5tAA77Qe_NmtuYZc3C3m3I24G2GvR5sSDxUyAN2zq8Lfn9EUms6rY3Ob8YeiKkTiBj0,
|
34
|
+
dq: s9lAH9fggBsoFR8Oac2R_E2gw282rT2kGOAhvIllETE1efrA6huUUvMfBcMpn8lqeW6vzznYY5SSQF7pMdC_agI3nG8Ibp1BUb0JUiraRNqUfLhcQb_d9GF4Dh7e74WbRsobRonujTYN1xCaP6TO61jvWrX-L18txXw494Q_cgk,
|
35
|
+
e: AQAB,
|
36
|
+
k: GawgguFyGrWKav7AX4VKUg,
|
37
|
+
kid: 1603dfe0af8f4596,
|
38
|
+
kty: RSA,
|
39
|
+
n: vTqrxUyQPl_20aqf5kXHwDZrel-KovIp8s7ewJod2EXHl8tWlRB3_Rem34KwBfqlKQGp1nqah-51H4Jzruqe0cFP58hPEIt6WqrvnmJCXxnNuIB53iX_uUUXXHDHBeaPCSRoNJzNysjoJ30TIUsKBiirhBa7f235PXbKiHducLevV6PcKxJ5cY8zO286qJLBWSPm-OIevwqsIsSIH44Qtm9sioFikhkbLwoqwWORGAY0nl6XvVOlhADdLjBSqSAeT1FPuCDCnXwzCDR8N9IFB_IjdStFkC-rVt2K5BYfPd0c3yFp_vHR15eRd0zJ8XQ7woBC8Vnsac6Et1pKS59pX6256DPWu8UDdEOolKAPgcd_g2NpA76cAaF_jcT80j9KrEzw8Tv0nJBGesuCjPNjGs_KzdkWTUXt23Hn9QJsdc1MZuaW0iqXBepHYfYoqNelzVte117t4BwVp0kUM6we0IqyXClaZgOI8S-WDBw2_Ovdm8e5NmhYAblEVoygcX8Y46oH6bKiaCQfKCFDMcRgChme7AoE1yZZYsPbaG_3IjPrC4LBMHQw8rM9dWjJ8ImjicvZ1pAm0dx-KHCP3y5PVKrxBDf1zSOsBRkOSjB8TPODnJMz6-jd5hTtZxpZPwPoIdCanTZ3ZD6uRBpTmDwtpRGm63UQs1m5FWPwb0T2IF0,
|
40
|
+
p: 6NbkXwDWUhi-eR55Cgbf27FkQDDWIamOaDr0rj1q0f1fFEz1W5A_09YvG09Fiv1AO2-D8Rl8gS1Vkz2i0zCSqnyy8A025XOcRviOMK7nIxE4OH_PEsko8dtIrb3TmE2hUXvCkmzw9EsTF1LQBOGC6iusLTXepIC1x9ukCKFZQvdgtEObQ5kzd9Nhq-cdqmSeMVLoxPLd1blviVT9Vm8-y12CtYpeJHOaIDtVPLlBhJiBoPKWg3vxSm4XxIliNOefqegIlsmTIa3MpS6WWlCK3yHhat0Q-rRxDxdyiVdG_wzJvp0Iw_2wms7pe-PgNPYvUWH9JphWP5K38YqEBiJFXQ,
|
41
|
+
q: 0A1FmpOWR91_RAWpqreWSavNaZb9nXeKiBo0DQGBz32DbqKqQ8S4aBJmbRhJcctjCLjain-ivut477tAUMmzJwVJDDq2MZFwC9Q-4VYZmFU4HJityQuSzHYe64RjN-E_NQ02TWhG3QGW6roq6c57c99rrUsETwJJiwS8M5p15Miuz53DaOjv-uqqFAFfywN5WkxHbraBcjHtMiQuyQbQqkCFh-oanHkwYNeytsNhTu2mQmwR5DR2roZ2nPiFjC6nsdk-A7E3S3wMzYYFw7jvbWWoYWo9vB40_MY2Y0FYQSqcDzcBIcq_0tnnasf3VW4Fdx6m80RzOb2Fsnln7vKXAQ,
|
42
|
+
qi: GyM_p6JrXySiz1toFgKbWV-JdI3jQ4ypu9rbMWx3rQJBfmt0FoYzgUIZEVFEcOqwemRN81zoDAaa-Bk0KWNGDjJHZDdDmFhW3AN7lI-puxk_mHZGJ11rxyR8O55XLSe3SPmRfKwZI6yU24ZxvQKFYItdldUKGzO6Ia6zTKhAVRU,
|
43
|
+
use: sig,
|
44
|
+
x: f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU,
|
45
|
+
x5c: null,
|
46
|
+
y: x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0)
|
47
|
+
```
|
48
|
+
|
49
|
+
|
@@ -0,0 +1,17 @@
|
|
1
|
+
# OryHydraClient::JSONWebKeySet
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**keys** | [**Array<JSONWebKey>**](JSONWebKey.md) | The value of the \"keys\" parameter is an array of JWK values. By default, the order of the JWK values within the array does not imply an order of preference among them, although applications of JWK Sets can choose to assign a meaning to the order for their purposes, if desired. | [optional]
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'OryHydraClient'
|
13
|
+
|
14
|
+
instance = OryHydraClient::JSONWebKeySet.new(keys: null)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# OryHydraClient::JsonWebKeySetGeneratorRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**alg** | **String** | The algorithm to be used for creating the key. Supports \"RS256\", \"ES512\", \"HS512\", and \"HS256\" |
|
8
|
+
**kid** | **String** | The kid of the key to be created |
|
9
|
+
**use** | **String** | The \"use\" (public key use) parameter 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. Valid values are \"enc\" and \"sig\". |
|
10
|
+
|
11
|
+
## Code Sample
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'OryHydraClient'
|
15
|
+
|
16
|
+
instance = OryHydraClient::JsonWebKeySetGeneratorRequest.new(alg: null,
|
17
|
+
kid: null,
|
18
|
+
use: null)
|
19
|
+
```
|
20
|
+
|
21
|
+
|
@@ -0,0 +1,33 @@
|
|
1
|
+
# OryHydraClient::LoginRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**challenge** | **String** | Challenge is the identifier (\"login challenge\") of the login request. It is used to identify the session. | [optional]
|
8
|
+
**client** | [**OAuth2Client**](OAuth2Client.md) | | [optional]
|
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. | [optional]
|
11
|
+
**requested_access_token_audience** | **Array<String>** | RequestedScope contains the access token audience as requested by the OAuth 2.0 Client. | [optional]
|
12
|
+
**requested_scope** | **Array<String>** | RequestedScope contains the OAuth 2.0 Scope requested by the OAuth 2.0 Client. | [optional]
|
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. | [optional]
|
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. | [optional]
|
16
|
+
|
17
|
+
## Code Sample
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'OryHydraClient'
|
21
|
+
|
22
|
+
instance = OryHydraClient::LoginRequest.new(challenge: null,
|
23
|
+
client: null,
|
24
|
+
oidc_context: null,
|
25
|
+
request_url: null,
|
26
|
+
requested_access_token_audience: null,
|
27
|
+
requested_scope: null,
|
28
|
+
session_id: null,
|
29
|
+
skip: null,
|
30
|
+
subject: null)
|
31
|
+
```
|
32
|
+
|
33
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
# OryHydraClient::LogoutRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**request_url** | **String** | RequestURL is the original Logout URL requested. | [optional]
|
8
|
+
**rp_initiated** | **Boolean** | RPInitiated is set to true if the request was initiated by a Relying Party (RP), also known as an OAuth 2.0 Client. | [optional]
|
9
|
+
**sid** | **String** | SessionID is the login session ID that was requested to log out. | [optional]
|
10
|
+
**subject** | **String** | Subject is the user for whom the logout was request. | [optional]
|
11
|
+
|
12
|
+
## Code Sample
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'OryHydraClient'
|
16
|
+
|
17
|
+
instance = OryHydraClient::LogoutRequest.new(request_url: null,
|
18
|
+
rp_initiated: null,
|
19
|
+
sid: null,
|
20
|
+
subject: null)
|
21
|
+
```
|
22
|
+
|
23
|
+
|
@@ -0,0 +1,79 @@
|
|
1
|
+
# OryHydraClient::OAuth2Client
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**allowed_cors_origins** | **Array<String>** | AllowedCORSOrigins are one or more URLs (scheme://host[:port]) which are allowed to make CORS requests to the /oauth/token endpoint. If this array is empty, the sever's CORS origin configuration (`CORS_ALLOWED_ORIGINS`) will be used instead. If this array is set, the allowed origins are appended to the server's CORS origin configuration. Be aware that environment variable `CORS_ENABLED` MUST be set to `true` for this to work. | [optional]
|
8
|
+
**audience** | **Array<String>** | Audience is a whitelist defining the audiences this client is allowed to request tokens for. An audience limits the applicability of an OAuth 2.0 Access Token to, for example, certain API endpoints. The value is a list of URLs. URLs MUST NOT contain whitespaces. | [optional]
|
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
|
+
**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** | ClientID is the id for this client. | [optional]
|
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
|
+
**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
|
+
**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]
|
15
|
+
**client_uri** | **String** | ClientURI is an URL string of a web page providing information about the client. If present, the server SHOULD display this URL to the end-user in a clickable fashion. | [optional]
|
16
|
+
**contacts** | **Array<String>** | Contacts is a array of strings representing ways to contact people responsible for this client, typically email addresses. | [optional]
|
17
|
+
**created_at** | **DateTime** | CreatedAt returns the timestamp of the client's creation. | [optional]
|
18
|
+
**frontchannel_logout_session_required** | **Boolean** | Boolean value specifying whether the RP requires that iss (issuer) and sid (session ID) query parameters be included to identify the RP session with the OP when the frontchannel_logout_uri is used. If omitted, the default value is false. | [optional]
|
19
|
+
**frontchannel_logout_uri** | **String** | RP URL that will cause the RP to log itself out when rendered in an iframe by the OP. An iss (issuer) query parameter and a sid (session ID) query parameter MAY be included by the OP to enable the RP to validate the request and to determine which of the potentially multiple sessions is to be logged out; if either is included, both MUST be. | [optional]
|
20
|
+
**grant_types** | **Array<String>** | GrantTypes is an array of grant types the client is allowed to use. | [optional]
|
21
|
+
**jwks** | [**JSONWebKeySet**](JSONWebKeySet.md) | | [optional]
|
22
|
+
**jwks_uri** | **String** | URL for the Client's JSON Web Key Set [JWK] document. If the Client signs requests to the Server, it contains the signing key(s) the Server uses to validate signatures from the Client. The JWK Set MAY also contain the Client's encryption keys(s), which are used by the Server to encrypt responses to the Client. 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. | [optional]
|
23
|
+
**logo_uri** | **String** | LogoURI is an URL string that references a logo for the client. | [optional]
|
24
|
+
**metadata** | **Hash<String, Object>** | Metadata is arbitrary data. | [optional]
|
25
|
+
**owner** | **String** | Owner is a string identifying the owner of the OAuth 2.0 Client. | [optional]
|
26
|
+
**policy_uri** | **String** | PolicyURI is a URL string that points to a human-readable privacy policy document that describes how the deployment organization collects, uses, retains, and discloses personal data. | [optional]
|
27
|
+
**post_logout_redirect_uris** | **Array<String>** | Array of URLs supplied by the RP to which it MAY request that the End-User's User Agent be redirected using the post_logout_redirect_uri parameter after a logout has been performed. | [optional]
|
28
|
+
**redirect_uris** | **Array<String>** | RedirectURIs is an array of allowed redirect urls for the client, for example http://mydomain/oauth/callback . | [optional]
|
29
|
+
**request_object_signing_alg** | **String** | JWS [JWS] alg algorithm [JWA] that MUST be used for signing Request Objects sent to the OP. All Request Objects from this Client MUST be rejected, if not signed with this algorithm. | [optional]
|
30
|
+
**request_uris** | **Array<String>** | Array of request_uri values that are pre-registered by the RP for use at the OP. Servers MAY cache the contents of the files referenced by these URIs and not retrieve them at the time they are used in a request. OPs can require that request_uri values used be pre-registered with the require_request_uri_registration discovery parameter. | [optional]
|
31
|
+
**response_types** | **Array<String>** | ResponseTypes is an array of the OAuth 2.0 response type strings that the client can use at the authorization endpoint. | [optional]
|
32
|
+
**scope** | **String** | Scope is a string containing a space-separated list of scope values (as described in Section 3.3 of OAuth 2.0 [RFC6749]) that the client can use when requesting access tokens. | [optional]
|
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
|
+
**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
|
+
**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
|
+
**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
|
+
**updated_at** | **DateTime** | UpdatedAt returns the timestamp of the last update. | [optional]
|
38
|
+
**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]
|
39
|
+
|
40
|
+
## Code Sample
|
41
|
+
|
42
|
+
```ruby
|
43
|
+
require 'OryHydraClient'
|
44
|
+
|
45
|
+
instance = OryHydraClient::OAuth2Client.new(allowed_cors_origins: null,
|
46
|
+
audience: null,
|
47
|
+
backchannel_logout_session_required: null,
|
48
|
+
backchannel_logout_uri: null,
|
49
|
+
client_id: null,
|
50
|
+
client_name: null,
|
51
|
+
client_secret: null,
|
52
|
+
client_secret_expires_at: null,
|
53
|
+
client_uri: null,
|
54
|
+
contacts: null,
|
55
|
+
created_at: null,
|
56
|
+
frontchannel_logout_session_required: null,
|
57
|
+
frontchannel_logout_uri: null,
|
58
|
+
grant_types: null,
|
59
|
+
jwks: null,
|
60
|
+
jwks_uri: null,
|
61
|
+
logo_uri: null,
|
62
|
+
metadata: null,
|
63
|
+
owner: null,
|
64
|
+
policy_uri: null,
|
65
|
+
post_logout_redirect_uris: null,
|
66
|
+
redirect_uris: null,
|
67
|
+
request_object_signing_alg: null,
|
68
|
+
request_uris: null,
|
69
|
+
response_types: null,
|
70
|
+
scope: null,
|
71
|
+
sector_identifier_uri: null,
|
72
|
+
subject_type: null,
|
73
|
+
token_endpoint_auth_method: null,
|
74
|
+
tos_uri: null,
|
75
|
+
updated_at: null,
|
76
|
+
userinfo_signed_response_alg: null)
|
77
|
+
```
|
78
|
+
|
79
|
+
|
@@ -0,0 +1,41 @@
|
|
1
|
+
# OryHydraClient::OAuth2TokenIntrospection
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
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
|
+
**aud** | **Array<String>** | Audience contains a list of the token's intended audiences. | [optional]
|
9
|
+
**client_id** | **String** | ClientID is aclient identifier for the OAuth 2.0 client that requested this token. | [optional]
|
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** | **Hash<String, Object>** | Extra is arbitrary data set by the session. | [optional]
|
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
|
+
**iss** | **String** | IssuerURL is a string representing the issuer of this token | [optional]
|
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]
|
15
|
+
**obfuscated_subject** | **String** | ObfuscatedSubject is set when the subject identifier algorithm was set to \"pairwise\" during authorization. It is the `sub` value of the ID Token that was issued. | [optional]
|
16
|
+
**scope** | **String** | Scope is a JSON string containing a space-separated list of scopes associated with this token. | [optional]
|
17
|
+
**sub** | **String** | Subject of the token, as defined in JWT [RFC7519]. Usually a machine-readable identifier of the resource owner who authorized this token. | [optional]
|
18
|
+
**token_type** | **String** | TokenType is the introspected token's type, for example `access_token` or `refresh_token`. | [optional]
|
19
|
+
**username** | **String** | Username is a human-readable identifier for the resource owner who authorized this token. | [optional]
|
20
|
+
|
21
|
+
## Code Sample
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
require 'OryHydraClient'
|
25
|
+
|
26
|
+
instance = OryHydraClient::OAuth2TokenIntrospection.new(active: null,
|
27
|
+
aud: null,
|
28
|
+
client_id: null,
|
29
|
+
exp: null,
|
30
|
+
ext: null,
|
31
|
+
iat: null,
|
32
|
+
iss: null,
|
33
|
+
nbf: null,
|
34
|
+
obfuscated_subject: null,
|
35
|
+
scope: null,
|
36
|
+
sub: null,
|
37
|
+
token_type: null,
|
38
|
+
username: null)
|
39
|
+
```
|
40
|
+
|
41
|
+
|
@@ -0,0 +1,27 @@
|
|
1
|
+
# OryHydraClient::Oauth2TokenResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
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
|
+
|
14
|
+
## Code Sample
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'OryHydraClient'
|
18
|
+
|
19
|
+
instance = OryHydraClient::Oauth2TokenResponse.new(access_token: null,
|
20
|
+
expires_in: null,
|
21
|
+
id_token: null,
|
22
|
+
refresh_token: null,
|
23
|
+
scope: null,
|
24
|
+
token_type: null)
|
25
|
+
```
|
26
|
+
|
27
|
+
|