ory-client 1.22.39 → 1.22.40

data/docs/RevocationReason.md

@@ -0,0 +1,15 @@
+# OryClient::RevocationReason
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::RevocationReason.new()
+```
+

data/docs/RotateIssuedAPIKeyResponse.md

@@ -0,0 +1,22 @@
+# OryClient::RotateIssuedAPIKeyResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **issued_api_key** | [**IssuedAPIKey**](IssuedAPIKey.md) |  | [optional] |
+| **old_issued_api_key** | [**IssuedAPIKey**](IssuedAPIKey.md) |  | [optional] |
+| **secret** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::RotateIssuedAPIKeyResponse.new(
+  issued_api_key: null,
+  old_issued_api_key: null,
+  secret: null
+)
+```
+

data/docs/SelfRevokeAPIKeyRequest.md

@@ -0,0 +1,20 @@
+# OryClient::SelfRevokeAPIKeyRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **credential** | **String** |  | [optional] |
+| **reason** | [**RevocationReason**](RevocationReason.md) |  | [optional][default to 'REVOCATION_REASON_UNSPECIFIED'] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::SelfRevokeAPIKeyRequest.new(
+  credential: null,
+  reason: null
+)
+```
+

data/docs/Status.md

@@ -0,0 +1,22 @@
+# OryClient::Status
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **Integer** |  | [optional] |
+| **details** | [**Array<Any>**](Any.md) |  | [optional] |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::Status.new(
+  code: null,
+  details: null,
+  message: null
+)
+```
+

data/docs/Token.md

@@ -0,0 +1,24 @@
+# OryClient::Token
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **claims** | **Object** | claims is the decoded token payload. For JWT, this contains the standard claims (iss, sub, aud, exp, iat, jti) plus custom claims. For macaroons, this lists the caveats. The shape is backend-dependent and should be treated as opaque diagnostic data. | [optional] |
+| **expire_time** | **Time** |  | [optional] |
+| **scopes** | **Array<String>** |  | [optional] |
+| **token** | **String** | The encoded token string. JWT tokens are signed JWS in compact serialization (header.payload.signature). Macaroons are base64-encoded binary blobs. | [optional] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::Token.new(
+  claims: null,
+  expire_time: null,
+  scopes: null,
+  token: null
+)
+```
+

data/docs/TokenAlgorithm.md

@@ -0,0 +1,15 @@
+# OryClient::TokenAlgorithm
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::TokenAlgorithm.new()
+```
+

data/docs/ValidateBaseURLRewriteRequest.md

@@ -0,0 +1,22 @@
+# OryClient::ValidateBaseURLRewriteRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **base_url** | **String** | The base URL the proxy wants Kratos to rewrite courier links to, e.g. \"http://localhost:4000\" for the Ory CLI / NextJS proxy. |  |
+| **project_id** | **String** | The Project ID the token is being authorized against. |  |
+| **token** | **String** | The bearer token from the inbound Ory-Base-URL-Rewrite-Token header. |  |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::ValidateBaseURLRewriteRequest.new(
+  base_url: null,
+  project_id: null,
+  token: null
+)
+```
+

data/docs/ValidateBaseURLRewriteResponse.md

@@ -0,0 +1,20 @@
+# OryClient::ValidateBaseURLRewriteResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **reason** | **String** | A machine-readable reason for negative outcomes. One of \"token_not_found\", \"missing_permission\", or \"invalid_base_url\". Empty when valid is true. | [optional] |
+| **valid** | **Boolean** | Whether the token authorizes the base URL rewrite. |  |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::ValidateBaseURLRewriteResponse.new(
+  reason: null,
+  valid: null
+)
+```
+

data/docs/VerificationErrorCode.md

@@ -0,0 +1,15 @@
+# OryClient::VerificationErrorCode
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::VerificationErrorCode.new()
+```
+

data/docs/VerifyAPIKeyRequest.md

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

data/docs/VerifyAPIKeyResponse.md

@@ -0,0 +1,44 @@
+# OryClient::VerifyAPIKeyResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **actor_id** | **String** |  | [optional] |
+| **error_code** | [**VerificationErrorCode**](VerificationErrorCode.md) |  | [optional][default to 'VERIFICATION_ERROR_UNSPECIFIED'] |
+| **error_message** | **String** |  | [optional] |
+| **expire_time** | **Time** |  | [optional] |
+| **is_valid** | **Boolean** | is_valid reports whether verification succeeded. It is true only when the credential parses, the signature checks out, the key was found, all policy gates (expiry, revocation, IP allowlist, rate limit) pass, and the key's status is KEY_STATUS_ACTIVE. When false, error_code and error_message describe the reason. Use this field for authentication decisions; use status to inspect lifecycle state independently. | [optional] |
+| **issuer** | **String** | The configured token issuer for this project. For derived tokens (JWT/macaroon), this matches the iss claim embedded in the verified token. | [optional] |
+| **key_id** | **String** |  | [optional] |
+| **metadata** | **Object** | metadata mirrors the metadata stored on the verified key. AIP-148 metadata field. | [optional] |
+| **rate_limit_policy** | [**RateLimitPolicy**](RateLimitPolicy.md) |  | [optional] |
+| **rate_limit_remaining** | **String** | Approximate number of requests available before the rate limit is reached (commercial-only, only set when enforcement is active). | [optional] |
+| **rate_limit_reset_time** | **Time** | Time when the rate limiter returns to full capacity (all quota recovered). | [optional] |
+| **scopes** | **Array<String>** |  | [optional] |
+| **status** | [**KeyStatus**](KeyStatus.md) |  | [optional][default to 'KEY_STATUS_UNSPECIFIED'] |
+| **visibility** | [**KeyVisibility**](KeyVisibility.md) |  | [optional][default to 'KEY_VISIBILITY_UNSPECIFIED'] |
+
+## Example
+
+```ruby
+require 'ory-client'
+
+instance = OryClient::VerifyAPIKeyResponse.new(
+  actor_id: null,
+  error_code: null,
+  error_message: null,
+  expire_time: null,
+  is_valid: null,
+  issuer: null,
+  key_id: null,
+  metadata: null,
+  rate_limit_policy: null,
+  rate_limit_remaining: null,
+  rate_limit_reset_time: null,
+  scopes: null,
+  status: null,
+  visibility: null
+)
+```
+