passageidentity 0.2.3 → 0.4.0

data/docs/generated/TokensApi.md

@@ -0,0 +1,78 @@
+# OpenapiClient::TokensApi
+
+All URIs are relative to *https://api.passage.id/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**revoke_user_refresh_tokens**](TokensApi.md#revoke_user_refresh_tokens) | **DELETE** /apps/{app_id}/users/{user_id}/tokens | Revokes refresh tokens |
+
+
+## revoke_user_refresh_tokens
+
+> revoke_user_refresh_tokens(app_id, user_id)
+
+Revokes refresh tokens
+
+Revokes all refresh tokens for a user
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = OpenapiClient::TokensApi.new
+app_id = 'app_id_example' # String | App ID
+user_id = 'user_id_example' # String | User ID
+
+begin
+  # Revokes refresh tokens
+  api_instance.revoke_user_refresh_tokens(app_id, user_id)
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling TokensApi->revoke_user_refresh_tokens: #{e}"
+end
+```
+
+#### Using the revoke_user_refresh_tokens_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)> revoke_user_refresh_tokens_with_http_info(app_id, user_id)
+
+```ruby
+begin
+  # Revokes refresh tokens
+  data, status_code, headers = api_instance.revoke_user_refresh_tokens_with_http_info(app_id, user_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling TokensApi->revoke_user_refresh_tokens_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** | App ID |  |
+| **user_id** | **String** | User ID |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/generated/TtlDisplayUnit.md

@@ -0,0 +1,15 @@
+# OpenapiClient::TtlDisplayUnit
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::TtlDisplayUnit.new()
+```
+

data/docs/generated/UpdateMagicLinkAuthMethod.md

@@ -0,0 +1,22 @@
+# OpenapiClient::UpdateMagicLinkAuthMethod
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **enabled** | **Boolean** |  | [optional] |
+| **ttl** | **Integer** | Maximum time (IN SECONDS) for the auth to expire. | [optional][default to 300] |
+| **ttl_display_unit** | [**TtlDisplayUnit**](TtlDisplayUnit.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::UpdateMagicLinkAuthMethod.new(
+  enabled: null,
+  ttl: null,
+  ttl_display_unit: null
+)
+```
+

data/docs/generated/UpdateOtpAuthMethod.md

@@ -0,0 +1,22 @@
+# OpenapiClient::UpdateOtpAuthMethod
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **enabled** | **Boolean** |  | [optional] |
+| **ttl** | **Integer** | Maximum time (IN SECONDS) for the auth to expire. | [optional][default to 300] |
+| **ttl_display_unit** | [**TtlDisplayUnit**](TtlDisplayUnit.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::UpdateOtpAuthMethod.new(
+  enabled: null,
+  ttl: null,
+  ttl_display_unit: null
+)
+```
+

data/docs/generated/UpdatePasskeysAuthMethod.md

@@ -0,0 +1,18 @@
+# OpenapiClient::UpdatePasskeysAuthMethod
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **enabled** | **Boolean** |  | [optional][default to true] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::UpdatePasskeysAuthMethod.new(
+  enabled: null
+)
+```
+

data/docs/generated/UpdateUserRequest.md

@@ -0,0 +1,22 @@
+# OpenapiClient::UpdateUserRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** |  | [optional] |
+| **phone** | **String** |  | [optional] |
+| **user_metadata** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::UpdateUserRequest.new(
+  email: null,
+  phone: null,
+  user_metadata: null
+)
+```
+

data/docs/generated/UserDevicesApi.md

@@ -0,0 +1,152 @@
+# OpenapiClient::UserDevicesApi
+
+All URIs are relative to *https://api.passage.id/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**delete_user_devices**](UserDevicesApi.md#delete_user_devices) | **DELETE** /apps/{app_id}/users/{user_id}/devices/{device_id} | Delete a device for a user |
+| [**list_user_devices**](UserDevicesApi.md#list_user_devices) | **GET** /apps/{app_id}/users/{user_id}/devices | List User Devices |
+
+
+## delete_user_devices
+
+> delete_user_devices(app_id, user_id, device_id)
+
+Delete a device for a user
+
+Delete a device for a user.
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = OpenapiClient::UserDevicesApi.new
+app_id = 'app_id_example' # String | App ID
+user_id = 'user_id_example' # String | User ID
+device_id = 'device_id_example' # String | Device ID
+
+begin
+  # Delete a device for a user
+  api_instance.delete_user_devices(app_id, user_id, device_id)
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling UserDevicesApi->delete_user_devices: #{e}"
+end
+```
+
+#### Using the delete_user_devices_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_user_devices_with_http_info(app_id, user_id, device_id)
+
+```ruby
+begin
+  # Delete a device for a user
+  data, status_code, headers = api_instance.delete_user_devices_with_http_info(app_id, user_id, device_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling UserDevicesApi->delete_user_devices_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** | App ID |  |
+| **user_id** | **String** | User ID |  |
+| **device_id** | **String** | Device ID |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_user_devices
+
+> <ListDevicesResponse> list_user_devices(app_id, user_id)
+
+List User Devices
+
+List user devices.
+
+### Examples
+
+```ruby
+require 'time'
+require 'openapi_client'
+# setup authorization
+OpenapiClient.configure do |config|
+  # Configure Bearer authorization (JWT): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = OpenapiClient::UserDevicesApi.new
+app_id = 'app_id_example' # String | App ID
+user_id = 'user_id_example' # String | User ID
+
+begin
+  # List User Devices
+  result = api_instance.list_user_devices(app_id, user_id)
+  p result
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling UserDevicesApi->list_user_devices: #{e}"
+end
+```
+
+#### Using the list_user_devices_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListDevicesResponse>, Integer, Hash)> list_user_devices_with_http_info(app_id, user_id)
+
+```ruby
+begin
+  # List User Devices
+  data, status_code, headers = api_instance.list_user_devices_with_http_info(app_id, user_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListDevicesResponse>
+rescue OpenapiClient::ApiError => e
+  puts "Error when calling UserDevicesApi->list_user_devices_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **app_id** | **String** | App ID |  |
+| **user_id** | **String** | User ID |  |
+
+### Return type
+
+[**ListDevicesResponse**](ListDevicesResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/generated/UserEventInfo.md

@@ -0,0 +1,26 @@
+# OpenapiClient::UserEventInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **Time** |  |  |
+| **id** | **String** |  |  |
+| **ip_addr** | **String** |  |  |
+| **type** | **String** |  |  |
+| **user_agent** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::UserEventInfo.new(
+  created_at: null,
+  id: null,
+  ip_addr: null,
+  type: null,
+  user_agent: null
+)
+```
+

data/docs/generated/UserInfo.md

@@ -0,0 +1,48 @@
+# OpenapiClient::UserInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **Time** |  |  |
+| **email** | **String** |  |  |
+| **email_verified** | **Boolean** |  |  |
+| **id** | **String** |  |  |
+| **last_login_at** | **Time** |  |  |
+| **login_count** | **Integer** |  |  |
+| **phone** | **String** |  |  |
+| **phone_verified** | **Boolean** |  |  |
+| **recent_events** | [**Array<UserEventInfo>**](UserEventInfo.md) |  |  |
+| **social_connections** | [**UserSocialConnections**](UserSocialConnections.md) |  |  |
+| **status** | [**UserStatus**](UserStatus.md) |  |  |
+| **updated_at** | **Time** |  |  |
+| **user_metadata** | **Object** |  |  |
+| **webauthn** | **Boolean** |  |  |
+| **webauthn_devices** | [**Array<WebAuthnDevices>**](WebAuthnDevices.md) |  |  |
+| **webauthn_types** | [**Array<WebAuthnType>**](WebAuthnType.md) | List of credential types that have been used for authentication |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::UserInfo.new(
+  created_at: null,
+  email: null,
+  email_verified: null,
+  id: null,
+  last_login_at: null,
+  login_count: null,
+  phone: null,
+  phone_verified: null,
+  recent_events: null,
+  social_connections: null,
+  status: null,
+  updated_at: null,
+  user_metadata: null,
+  webauthn: null,
+  webauthn_devices: null,
+  webauthn_types: null
+)
+```
+

data/docs/generated/UserMetadataField.md

@@ -0,0 +1,28 @@
+# OpenapiClient::UserMetadataField
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field_name** | **String** |  |  |
+| **friendly_name** | **String** |  |  |
+| **id** | **String** |  |  |
+| **profile** | **Boolean** |  |  |
+| **registration** | **Boolean** |  |  |
+| **type** | [**UserMetadataFieldType**](UserMetadataFieldType.md) |  |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::UserMetadataField.new(
+  field_name: null,
+  friendly_name: null,
+  id: null,
+  profile: null,
+  registration: null,
+  type: null
+)
+```
+

data/docs/generated/UserMetadataFieldType.md

@@ -0,0 +1,15 @@
+# OpenapiClient::UserMetadataFieldType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::UserMetadataFieldType.new()
+```
+

data/docs/generated/UserResponse.md

@@ -0,0 +1,18 @@
+# OpenapiClient::UserResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user** | [**UserInfo**](UserInfo.md) |  |  |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::UserResponse.new(
+  user: null
+)
+```
+

data/docs/generated/UserSocialConnections.md

@@ -0,0 +1,20 @@
+# OpenapiClient::UserSocialConnections
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **google** | [**GoogleSocialConnection**](GoogleSocialConnection.md) |  | [optional] |
+| **github** | [**GithubSocialConnection**](GithubSocialConnection.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::UserSocialConnections.new(
+  google: null,
+  github: null
+)
+```
+

data/docs/generated/UserStatus.md

@@ -0,0 +1,15 @@
+# OpenapiClient::UserStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'openapi_client'
+
+instance = OpenapiClient::UserStatus.new()
+```
+