ory-client 0.0.1.alpha55 → 0.0.1.alpha66

data/docs/ProjectOidcConfig.md

@@ -1,42 +0,0 @@
-# OryClient::ProjectOidcConfig
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **auth_url** | **String** | AuthURL is the authorize url, typically something like: https://example.org/oauth2/auth Should only be used when the OAuth2 / OpenID Connect server is not supporting OpenID Connect Discovery and when `provider` is set to `generic`. | [optional] |
-| **client_id** | **String** | ClientID is the application's Client ID. | [optional] |
-| **client_secret** | **String** | ClientSecret is the application's secret. | [optional] |
-| **id** | **String** | ID is the provider's ID | [optional] |
-| **issuer_url** | **String** | IssuerURL is the OpenID Connect Server URL. You can leave this empty if `provider` is not set to `generic`. If set, neither `auth_url` nor `token_url` are required. | [optional] |
-| **label** | **String** | Label represents an optional label which can be used in the UI generation. | [optional] |
-| **mapper_url** | **String** | Mapper specifies the JSONNet code snippet which uses the OpenID Connect Provider's data (e.g. GitHub or Google profile information) to hydrate the identity's data.  It can be either a URL (file://, http(s)://, base64://) or an inline JSONNet code snippet. | [optional] |
-| **provider** | **String** | Provider is either \"generic\" for a generic OAuth 2.0 / OpenID Connect Provider or one of: generic google github gitlab microsoft discord slack facebook vk yandex | [optional] |
-| **requested_claims** | **Object** | RequestedClaims string encoded json object that specifies claims and optionally their properties which should be included in the id_token or returned from the UserInfo Endpoint.  More information: https://openid.net/specs/openid-connect-core-1_0.html#ClaimsParameter | [optional] |
-| **scope** | **Array<String>** | Scope specifies optional requested permissions. | [optional] |
-| **string** | **String** |  | [optional] |
-| **tenant** | **String** | Tenant is the Azure AD Tenant to use for authentication, and must be set when `provider` is set to `microsoft`. Can be either `common`, `organizations`, `consumers` for a multitenant application or a specific tenant like `8eaef023-2b34-4da1-9baa-8bc8c9d6a490` or `contoso.onmicrosoft.com`. | [optional] |
-| **token_url** | **String** | TokenURL is the token url, typically something like: https://example.org/oauth2/token Should only be used when the OAuth2 / OpenID Connect server is not supporting OpenID Connect Discovery and when `provider` is set to `generic`. | [optional] |
-
-## Example
-
-```ruby
-require 'ory-client'
-
-instance = OryClient::ProjectOidcConfig.new(
-  auth_url: null,
-  client_id: null,
-  client_secret: null,
-  id: null,
-  issuer_url: null,
-  label: null,
-  mapper_url: null,
-  provider: null,
-  requested_claims: null,
-  scope: null,
-  string: null,
-  tenant: null,
-  token_url: null
-)
-```
-

data/docs/ProjectPasswordConfig.md

@@ -1,20 +0,0 @@
-# OryClient::ProjectPasswordConfig
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **enabled** | **Boolean** | Set to true to enable the password authentication method. | [optional] |
-| **revoke_active_sessions** | **Boolean** | Set to true to remove active sessions when the users logs in. | [optional] |
-
-## Example
-
-```ruby
-require 'ory-client'
-
-instance = OryClient::ProjectPasswordConfig.new(
-  enabled: null,
-  revoke_active_sessions: null
-)
-```
-

data/docs/ProjectPatch.md

@@ -1,60 +0,0 @@
-# OryClient::ProjectPatch
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **api_url** | **String** | URL of Project API  In the future will allow to override Kratos project URL. If set, error is returned. If left empty our hosted URL is used | [optional] |
-| **application_url** | **String** | URL where your application is available.  Your users will be redirected to this URL when they successfully complete a login, logout, verification, recovery, or registration flow. More fine-grained redirection patterns are available for the individual flows (login, registration, ...).  If left empty, our hosted URL will be used instead. It contains technical information on the identities and is useful when developing a new project or trying out Ory Cloud. | [optional] |
-| **default_identity_schema_url** | **String** | Default Identity Schema URL  This represents your Ory Kratos Default Identity Schema. It is your identity's default schema. This allows setting custom fields such as \"address\", specifying whether you want to log in using email or a username, and more. For more information on this topic, please check out the identity documentation.  If KratosCustomSchemaID is also added to the payload, it will be preferred and replace the value of DefaultIdentitySchemaURL set by the client.  The value of this field can be either any \"https://\" URL - for example a file hosted at GitHub, or a `preset://`-prefixed string.  Available presets are:  preset://email preset://username preset://basic preset://blank | [optional] |
-| **error_ui_url** | **String** | Self-Service Error UI URL  Sets the UI URL for the error UI. If left empty, this will use Ory's hosted pages. |  |
-| **kratos_custom_schema_id** | **String** | The Custom Schema ID  The custom schema ID is a preferred field over DefaultIdentitySchemaURL, meaning it will override the DefaultIdentitySchemaURL with the custom schema's URL instead of accepting it from the client-side. Once this field is set the given custom schema will be associated with this project. | [optional] |
-| **login_ui_url** | **String** | Self-Service Login UI URL  Sets the UI URL for the login UI. If left empty, this will use Ory's hosted pages. |  |
-| **lookup_secret** | [**ProjectLookupSecretConfig**](ProjectLookupSecretConfig.md) |  |  |
-| **name** | **String** | The project name.  Helps you identify your project.  in: body | [optional] |
-| **password** | [**ProjectPasswordConfig**](ProjectPasswordConfig.md) |  |  |
-| **recovery** | [**ProjectRecoveryConfig**](ProjectRecoveryConfig.md) |  |  |
-| **recovery_ui_url** | **String** | Self-Service Login UI URL  Sets the UI URL for the recovery UI. If left empty, this will use Ory's hosted pages. |  |
-| **redirection_config** | [**RedirectionConfig**](RedirectionConfig.md) |  | [optional] |
-| **registration_ui_url** | **String** | Self-Service Login UI URL  Sets the UI URL for the registration UI. If left empty, this will use Ory's hosted pages. |  |
-| **session_after_sign_up** | **Boolean** | Issue Session after Sign Up  If set to true, users will receive a session after they successfully signed up. Enabling this option allows account enumeration during registration flows. Read more: https://www.ory.sh/kratos/docs/self-service/flows/user-registration#successful-registration |  |
-| **session_soft_2fa** | **Boolean** | Enable Soft 2FA for Login Sessions |  |
-| **settings_privileged_session_max_age_seconds** | **Integer** | Duration in Seconds of how long a Session is Privileged  Defines how long a session is considered privileged in seconds. If the session's authenticated_at is older than the value specified here, the user needs to re-authenticate to perform certain actions (e.g. password change). |  |
-| **settings_soft_2fa** | **Boolean** | Enable Soft 2FA for Self-Service Settings Flows |  |
-| **settings_ui_url** | **String** | Self-Service Settings UI URL  Sets the UI URL for the settings UI. If left empty, this will use Ory's hosted pages. |  |
-| **totp** | [**ProjectTotpConfig**](ProjectTotpConfig.md) |  |  |
-| **verification** | [**ProjectVerificationConfig**](ProjectVerificationConfig.md) |  |  |
-| **verification_ui_url** | **String** | Self-Service Login UI URL  Sets the UI URL for the verification UI. If left empty, this will use Ory's hosted pages. |  |
-| **webauthn** | [**ProjectWebAuthnConfig**](ProjectWebAuthnConfig.md) |  |  |
-
-## Example
-
-```ruby
-require 'ory-client'
-
-instance = OryClient::ProjectPatch.new(
-  api_url: null,
-  application_url: null,
-  default_identity_schema_url: null,
-  error_ui_url: https://example.org/error,
-  kratos_custom_schema_id: null,
-  login_ui_url: https://example.org/login,
-  lookup_secret: null,
-  name: ACME App,
-  password: null,
-  recovery: null,
-  recovery_ui_url: https://example.org/recover,
-  redirection_config: null,
-  registration_ui_url: https://example.org/signup,
-  session_after_sign_up: null,
-  session_soft_2fa: null,
-  settings_privileged_session_max_age_seconds: 900,
-  settings_soft_2fa: null,
-  settings_ui_url: https://example.org/settings,
-  totp: null,
-  verification: null,
-  verification_ui_url: https://example.org/verify,
-  webauthn: null
-)
-```
-

data/docs/ProjectRecoveryConfig.md

@@ -1,18 +0,0 @@
-# OryClient::ProjectRecoveryConfig
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **enabled** | **Boolean** | Set to true to enable account recovery. | [optional] |
-
-## Example
-
-```ruby
-require 'ory-client'
-
-instance = OryClient::ProjectRecoveryConfig.new(
-  enabled: null
-)
-```
-

data/docs/ProjectTotpConfig.md

@@ -1,20 +0,0 @@
-# OryClient::ProjectTotpConfig
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **enabled** | **Boolean** | Set to true to enable the TOTP authentication method. | [optional] |
-| **issuer** | **String** | The issuer is the name which will appear in the Authenticator app. | [optional] |
-
-## Example
-
-```ruby
-require 'ory-client'
-
-instance = OryClient::ProjectTotpConfig.new(
-  enabled: null,
-  issuer: ory.sh
-)
-```
-

data/docs/ProjectVerificationConfig.md

@@ -1,20 +0,0 @@
-# OryClient::ProjectVerificationConfig
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **enabled** | **Boolean** | Set to true to enable email / phone verification. | [optional] |
-| **require_verified_address** | **Boolean** | Set to true to only allow users with a verified address to sign in. | [optional] |
-
-## Example
-
-```ruby
-require 'ory-client'
-
-instance = OryClient::ProjectVerificationConfig.new(
-  enabled: null,
-  require_verified_address: null
-)
-```
-

data/docs/ProjectWebAuthnConfig.md

@@ -1,26 +0,0 @@
-# OryClient::ProjectWebAuthnConfig
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **enabled** | **Boolean** | Set to true to enable the WebAuthn authentication method. | [optional] |
-| **rp_display_name** | **String** | The display name to show in the authenticator. | [optional] |
-| **rp_icon** | **String** | A URL to an icon which might be shown in the authenticator. | [optional] |
-| **rp_id** | **String** | This must be the hostname of the login page. | [optional] |
-| **rp_origin** | **String** | This must be the scheme://hostname of the login page. | [optional] |
-
-## Example
-
-```ruby
-require 'ory-client'
-
-instance = OryClient::ProjectWebAuthnConfig.new(
-  enabled: null,
-  rp_display_name: Ory Corp,
-  rp_icon: https://example.org/icon.png,
-  rp_id: example.org,
-  rp_origin: https://example.org/
-)
-```
-

data/docs/RedirectionConfig.md

@@ -1,32 +0,0 @@
-# OryClient::RedirectionConfig
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **global** | [**RedirectionField**](RedirectionField.md) |  | [optional] |
-| **login** | [**RedirectionField**](RedirectionField.md) |  | [optional] |
-| **logout** | [**RedirectionField**](RedirectionField.md) |  | [optional] |
-| **recovery** | [**RedirectionField**](RedirectionField.md) |  | [optional] |
-| **registration** | [**RedirectionField**](RedirectionField.md) |  | [optional] |
-| **settings** | [**RedirectionField**](RedirectionField.md) |  | [optional] |
-| **url_allowlist** | **Array<String>** |  | [optional] |
-| **verification** | [**RedirectionField**](RedirectionField.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'ory-client'
-
-instance = OryClient::RedirectionConfig.new(
-  global: null,
-  login: null,
-  logout: null,
-  recovery: null,
-  registration: null,
-  settings: null,
-  url_allowlist: null,
-  verification: null
-)
-```
-

data/docs/RedirectionField.md

@@ -1,24 +0,0 @@
-# OryClient::RedirectionField
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **main** | **String** |  | [optional] |
-| **oidc** | **String** |  | [optional] |
-| **password** | **String** |  | [optional] |
-| **profile** | **String** |  | [optional] |
-
-## Example
-
-```ruby
-require 'ory-client'
-
-instance = OryClient::RedirectionField.new(
-  main: null,
-  oidc: null,
-  password: null,
-  profile: null
-)
-```
-