ory-client 0.2.0.alpha48 → 1.0.0.alpha0

data/docs/JwkApi.md

@@ -0,0 +1,511 @@
+# OryClient::JwkApi
+
+All URIs are relative to *https://playground.projects.oryapis.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_json_web_key_set**](JwkApi.md#create_json_web_key_set) | **POST** /admin/keys/{set} | Create JSON Web Key |
+| [**delete_json_web_key**](JwkApi.md#delete_json_web_key) | **DELETE** /admin/keys/{set}/{kid} | Delete JSON Web Key |
+| [**delete_json_web_key_set**](JwkApi.md#delete_json_web_key_set) | **DELETE** /admin/keys/{set} | Delete JSON Web Key Set |
+| [**get_json_web_key**](JwkApi.md#get_json_web_key) | **GET** /admin/keys/{set}/{kid} | Get JSON Web Key |
+| [**get_json_web_key_set**](JwkApi.md#get_json_web_key_set) | **GET** /admin/keys/{set} | Retrieve a JSON Web Key Set |
+| [**set_json_web_key**](JwkApi.md#set_json_web_key) | **PUT** /admin/keys/{set}/{kid} | Set JSON Web Key |
+| [**set_json_web_key_set**](JwkApi.md#set_json_web_key_set) | **PUT** /admin/keys/{set} | Update a JSON Web Key Set |
+
+
+## create_json_web_key_set
+
+> <JsonWebKeySet> create_json_web_key_set(set, create_json_web_key_set)
+
+Create JSON Web Key
+
+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.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-client'
+# setup authorization
+OryClient.configure do |config|
+  # Configure Bearer authorization: oryAccessToken
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = OryClient::JwkApi.new
+set = 'set_example' # String | The JSON Web Key Set ID
+create_json_web_key_set = OryClient::CreateJsonWebKeySet.new({alg: 'alg_example', kid: 'kid_example', use: 'use_example'}) # CreateJsonWebKeySet | 
+
+begin
+  # Create JSON Web Key
+  result = api_instance.create_json_web_key_set(set, create_json_web_key_set)
+  p result
+rescue OryClient::ApiError => e
+  puts "Error when calling JwkApi->create_json_web_key_set: #{e}"
+end
+```
+
+#### Using the create_json_web_key_set_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<JsonWebKeySet>, Integer, Hash)> create_json_web_key_set_with_http_info(set, create_json_web_key_set)
+
+```ruby
+begin
+  # Create JSON Web Key
+  data, status_code, headers = api_instance.create_json_web_key_set_with_http_info(set, create_json_web_key_set)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <JsonWebKeySet>
+rescue OryClient::ApiError => e
+  puts "Error when calling JwkApi->create_json_web_key_set_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **set** | **String** | The JSON Web Key Set ID |  |
+| **create_json_web_key_set** | [**CreateJsonWebKeySet**](CreateJsonWebKeySet.md) |  |  |
+
+### Return type
+
+[**JsonWebKeySet**](JsonWebKeySet.md)
+
+### Authorization
+
+[oryAccessToken](../README.md#oryAccessToken)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_json_web_key
+
+> delete_json_web_key(set, kid)
+
+Delete JSON Web Key
+
+Use this endpoint to delete a single JSON Web Key.  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.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-client'
+# setup authorization
+OryClient.configure do |config|
+  # Configure Bearer authorization: oryAccessToken
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = OryClient::JwkApi.new
+set = 'set_example' # String | The JSON Web Key Set
+kid = 'kid_example' # String | The JSON Web Key ID (kid)
+
+begin
+  # Delete JSON Web Key
+  api_instance.delete_json_web_key(set, kid)
+rescue OryClient::ApiError => e
+  puts "Error when calling JwkApi->delete_json_web_key: #{e}"
+end
+```
+
+#### Using the delete_json_web_key_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_json_web_key_with_http_info(set, kid)
+
+```ruby
+begin
+  # Delete JSON Web Key
+  data, status_code, headers = api_instance.delete_json_web_key_with_http_info(set, kid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue OryClient::ApiError => e
+  puts "Error when calling JwkApi->delete_json_web_key_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **set** | **String** | The JSON Web Key Set |  |
+| **kid** | **String** | The JSON Web Key ID (kid) |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oryAccessToken](../README.md#oryAccessToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## delete_json_web_key_set
+
+> delete_json_web_key_set(set)
+
+Delete JSON Web Key Set
+
+Use this endpoint to delete a complete JSON Web Key Set and all the keys in that set.  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.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-client'
+# setup authorization
+OryClient.configure do |config|
+  # Configure Bearer authorization: oryAccessToken
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = OryClient::JwkApi.new
+set = 'set_example' # String | The JSON Web Key Set
+
+begin
+  # Delete JSON Web Key Set
+  api_instance.delete_json_web_key_set(set)
+rescue OryClient::ApiError => e
+  puts "Error when calling JwkApi->delete_json_web_key_set: #{e}"
+end
+```
+
+#### Using the delete_json_web_key_set_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_json_web_key_set_with_http_info(set)
+
+```ruby
+begin
+  # Delete JSON Web Key Set
+  data, status_code, headers = api_instance.delete_json_web_key_set_with_http_info(set)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue OryClient::ApiError => e
+  puts "Error when calling JwkApi->delete_json_web_key_set_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **set** | **String** | The JSON Web Key Set |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oryAccessToken](../README.md#oryAccessToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_json_web_key
+
+> <JsonWebKeySet> get_json_web_key(set, kid)
+
+Get JSON Web Key
+
+This endpoint returns a singular JSON Web Key contained in a set. It is identified by the set and the specific key ID (kid).
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-client'
+# setup authorization
+OryClient.configure do |config|
+  # Configure Bearer authorization: oryAccessToken
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = OryClient::JwkApi.new
+set = 'set_example' # String | JSON Web Key Set ID
+kid = 'kid_example' # String | JSON Web Key ID
+
+begin
+  # Get JSON Web Key
+  result = api_instance.get_json_web_key(set, kid)
+  p result
+rescue OryClient::ApiError => e
+  puts "Error when calling JwkApi->get_json_web_key: #{e}"
+end
+```
+
+#### Using the get_json_web_key_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<JsonWebKeySet>, Integer, Hash)> get_json_web_key_with_http_info(set, kid)
+
+```ruby
+begin
+  # Get JSON Web Key
+  data, status_code, headers = api_instance.get_json_web_key_with_http_info(set, kid)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <JsonWebKeySet>
+rescue OryClient::ApiError => e
+  puts "Error when calling JwkApi->get_json_web_key_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **set** | **String** | JSON Web Key Set ID |  |
+| **kid** | **String** | JSON Web Key ID |  |
+
+### Return type
+
+[**JsonWebKeySet**](JsonWebKeySet.md)
+
+### Authorization
+
+[oryAccessToken](../README.md#oryAccessToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_json_web_key_set
+
+> <JsonWebKeySet> get_json_web_key_set(set)
+
+Retrieve a JSON Web Key Set
+
+This endpoint can be used to retrieve JWK Sets stored in ORY Hydra.  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.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-client'
+# setup authorization
+OryClient.configure do |config|
+  # Configure Bearer authorization: oryAccessToken
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = OryClient::JwkApi.new
+set = 'set_example' # String | JSON Web Key Set ID
+
+begin
+  # Retrieve a JSON Web Key Set
+  result = api_instance.get_json_web_key_set(set)
+  p result
+rescue OryClient::ApiError => e
+  puts "Error when calling JwkApi->get_json_web_key_set: #{e}"
+end
+```
+
+#### Using the get_json_web_key_set_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<JsonWebKeySet>, Integer, Hash)> get_json_web_key_set_with_http_info(set)
+
+```ruby
+begin
+  # Retrieve a JSON Web Key Set
+  data, status_code, headers = api_instance.get_json_web_key_set_with_http_info(set)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <JsonWebKeySet>
+rescue OryClient::ApiError => e
+  puts "Error when calling JwkApi->get_json_web_key_set_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **set** | **String** | JSON Web Key Set ID |  |
+
+### Return type
+
+[**JsonWebKeySet**](JsonWebKeySet.md)
+
+### Authorization
+
+[oryAccessToken](../README.md#oryAccessToken)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## set_json_web_key
+
+> <JsonWebKey> set_json_web_key(set, kid, opts)
+
+Set JSON Web Key
+
+Use this method if you do not want to let Hydra generate the JWKs for you, but instead save your own.  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.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-client'
+# setup authorization
+OryClient.configure do |config|
+  # Configure Bearer authorization: oryAccessToken
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = OryClient::JwkApi.new
+set = 'set_example' # String | The JSON Web Key Set ID
+kid = 'kid_example' # String | JSON Web Key ID
+opts = {
+  json_web_key: OryClient::JsonWebKey.new({alg: 'RS256', kid: '1603dfe0af8f4596', kty: 'RSA', use: 'sig'}) # JsonWebKey | 
+}
+
+begin
+  # Set JSON Web Key
+  result = api_instance.set_json_web_key(set, kid, opts)
+  p result
+rescue OryClient::ApiError => e
+  puts "Error when calling JwkApi->set_json_web_key: #{e}"
+end
+```
+
+#### Using the set_json_web_key_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<JsonWebKey>, Integer, Hash)> set_json_web_key_with_http_info(set, kid, opts)
+
+```ruby
+begin
+  # Set JSON Web Key
+  data, status_code, headers = api_instance.set_json_web_key_with_http_info(set, kid, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <JsonWebKey>
+rescue OryClient::ApiError => e
+  puts "Error when calling JwkApi->set_json_web_key_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **set** | **String** | The JSON Web Key Set ID |  |
+| **kid** | **String** | JSON Web Key ID |  |
+| **json_web_key** | [**JsonWebKey**](JsonWebKey.md) |  | [optional] |
+
+### Return type
+
+[**JsonWebKey**](JsonWebKey.md)
+
+### Authorization
+
+[oryAccessToken](../README.md#oryAccessToken)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## set_json_web_key_set
+
+> <JsonWebKeySet> set_json_web_key_set(set, opts)
+
+Update a JSON Web Key Set
+
+Use this method if you do not want to let Hydra generate the JWKs for you, but instead save your own.  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.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-client'
+# setup authorization
+OryClient.configure do |config|
+  # Configure Bearer authorization: oryAccessToken
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = OryClient::JwkApi.new
+set = 'set_example' # String | The JSON Web Key Set ID
+opts = {
+  json_web_key_set: OryClient::JsonWebKeySet.new # JsonWebKeySet | 
+}
+
+begin
+  # Update a JSON Web Key Set
+  result = api_instance.set_json_web_key_set(set, opts)
+  p result
+rescue OryClient::ApiError => e
+  puts "Error when calling JwkApi->set_json_web_key_set: #{e}"
+end
+```
+
+#### Using the set_json_web_key_set_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<JsonWebKeySet>, Integer, Hash)> set_json_web_key_set_with_http_info(set, opts)
+
+```ruby
+begin
+  # Update a JSON Web Key Set
+  data, status_code, headers = api_instance.set_json_web_key_set_with_http_info(set, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <JsonWebKeySet>
+rescue OryClient::ApiError => e
+  puts "Error when calling JwkApi->set_json_web_key_set_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **set** | **String** | The JSON Web Key Set ID |  |
+| **json_web_key_set** | [**JsonWebKeySet**](JsonWebKeySet.md) |  | [optional] |
+
+### Return type
+
+[**JsonWebKeySet**](JsonWebKeySet.md)
+
+### Authorization
+
+[oryAccessToken](../README.md#oryAccessToken)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/LoginFlow.md

@@ -0,0 +1,44 @@
+# OryClient::LoginFlow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **active** | [**IdentityCredentialsType**](IdentityCredentialsType.md) |  | [optional] |
+| **created_at** | **Time** | CreatedAt is a helper struct field for gobuffalo.pop. | [optional] |
+| **expires_at** | **Time** | ExpiresAt is the time (UTC) when the flow expires. If the user still wishes to log in, a new flow has to be initiated. |  |
+| **id** | **String** | ID represents the flow's unique ID. When performing the login flow, this represents the id in the login UI's query parameter: http://<selfservice.flows.login.ui_url>/?flow=<flow_id> |  |
+| **issued_at** | **Time** | IssuedAt is the time (UTC) when the flow started. |  |
+| **oauth2_login_challenge** | **String** |  | [optional] |
+| **oauth2_login_request** | [**OAuth2LoginRequest**](OAuth2LoginRequest.md) |  | [optional] |
+| **refresh** | **Boolean** | Refresh stores whether this login flow should enforce re-authentication. | [optional] |
+| **request_url** | **String** | RequestURL is the initial URL that was requested from Ory Kratos. It can be used to forward information contained in the URL's path or query for example. |  |
+| **requested_aal** | [**AuthenticatorAssuranceLevel**](AuthenticatorAssuranceLevel.md) |  | [optional] |
+| **return_to** | **String** | ReturnTo contains the requested return_to URL. | [optional] |
+| **type** | **String** | The flow type can either be `api` or `browser`. |  |
+| **ui** | [**UiContainer**](UiContainer.md) |  |  |
+| **updated_at** | **Time** | UpdatedAt is a helper struct field for gobuffalo.pop. | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::LoginFlow.new(
+  active: null,
+  created_at: null,
+  expires_at: null,
+  id: null,
+  issued_at: null,
+  oauth2_login_challenge: null,
+  oauth2_login_request: null,
+  refresh: null,
+  request_url: null,
+  requested_aal: null,
+  return_to: null,
+  type: null,
+  ui: null,
+  updated_at: null
+)
+```
+

data/docs/LogoutFlow.md

@@ -0,0 +1,20 @@
+# OryClient::LogoutFlow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **logout_token** | **String** | LogoutToken can be used to perform logout using AJAX. |  |
+| **logout_url** | **String** | LogoutURL can be opened in a browser to sign the user out.  format: uri |  |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::LogoutFlow.new(
+  logout_token: null,
+  logout_url: null
+)
+```
+

data/docs/ManagedIdentitySchema.md

@@ -8,7 +8,7 @@
 | **blob_url** | **String** | The publicly accessible url of the schema |  |
 | **content_hash** | **String** | The Content Hash  Contains a hash of the schema's content. | [optional] |
 | **created_at** | **Time** | The Schema's Creation Date | [readonly] |
-| **id** | **String** | The schema's ID. | [readonly] |
+| **id** | **String** |  |  |
 | **name** | **String** | The schema name  This is set by the user and is for them to easily recognise their schema |  |
 | **updated_at** | **Time** | Last Time Schema was Updated | [readonly] |
 

data/docs/Message.md

@@ -0,0 +1,36 @@
+# OryClient::Message
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | **String** |  | [optional] |
+| **created_at** | **Time** | CreatedAt is a helper struct field for gobuffalo.pop. | [optional] |
+| **id** | **String** |  | [optional] |
+| **recipient** | **String** |  | [optional] |
+| **send_count** | **Integer** |  | [optional] |
+| **status** | [**CourierMessageStatus**](CourierMessageStatus.md) |  | [optional] |
+| **subject** | **String** |  | [optional] |
+| **template_type** | **String** |  | [optional] |
+| **type** | [**CourierMessageType**](CourierMessageType.md) |  | [optional] |
+| **updated_at** | **Time** | UpdatedAt is a helper struct field for gobuffalo.pop. | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::Message.new(
+  body: null,
+  created_at: null,
+  id: null,
+  recipient: null,
+  send_count: null,
+  status: null,
+  subject: null,
+  template_type: null,
+  type: null,
+  updated_at: null
+)
+```
+

data/docs/Namespace.md

@@ -0,0 +1,18 @@
+# OryClient::Namespace
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of the namespace. | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::Namespace.new(
+  name: null
+)
+```
+

data/docs/NormalizedProject.md

@@ -7,10 +7,9 @@
 | **created_at** | **Time** | The Project's Creation Date | [readonly] |
 | **current_revision** | [**NormalizedProjectRevision**](NormalizedProjectRevision.md) |  |  |
 | **hosts** | **Array<String>** |  |  |
-| **id** | **String** | The project's ID. | [readonly] |
-| **revisions** | [**Array<NormalizedProjectRevision>**](NormalizedProjectRevision.md) |  |  |
+| **id** | **String** |  |  |
 | **slug** | **String** | The project's slug | [readonly] |
-| **state** | **String** | The state of the project. running Running halted Halted | [readonly] |
+| **state** | **String** | The state of the project. | [readonly] |
 | **subscription_id** | **String** |  | [optional] |
 | **updated_at** | **Time** | Last Time Project was Updated | [readonly] |
 
@@ -24,7 +23,6 @@ instance = OryClient::NormalizedProject.new(
   current_revision: null,
   hosts: null,
   id: null,
-  revisions: null,
   slug: null,
   state: null,
   subscription_id: null,