diff --git a/README.md b/README.md index 45354f2..a7e2961 100644 --- a/README.md +++ b/README.md @@ -64,23 +64,6 @@ app_info = PassageClient.get_app() ``` -The information available in the Passage App struct returned by PassageClient.get_app(): - -```ruby - Struct.new :name, - :id, - :auth_origin, - :redirect_url, - :login_url, - :rsa_public_key, - :allowed_identifer, - :require_identifier_verification, - :session_timeout_length, - :user_metadata_schema, - :layouts, - :auth_fallback_method, - :auth_fallback_method_ttl -``` ## Retrieve User Info @@ -104,24 +87,6 @@ class ApplicationController < ActionController::Base end ``` -The information available in the Passage User struct returned by PassageClient.user.get(user_id:): - -```ruby - Struct.new :id, - :status, - :email, - :phone, - :email_verified, - :phone_verified, - :created_at, - :updated_at, - :last_login_at, - :login_count, - :recent_events, - :webauthn, - :webauthn_devices, - :user_metadata, -``` ## Activate/Deactivate User @@ -179,18 +144,6 @@ PassageClient = devices = PassageClient.user.list_devices(user_id: user_id) ``` -The information available in the array of Passage Device struct returned by PassageClient.user.list_devices(user_id:): - -```ruby - Struct.new :id, - :cred_id, - :friendly_name, - :usage_count, - :updated_at, - :created_at, - :last_login_at, - -``` ## List User Devices @@ -227,17 +180,20 @@ magic_link = ) ``` -The information available in the Passage Magic Link struct returned this method is below: +## Available Functions -```ruby -Struct.new :id, - :secret, - :activated, - :user_id, - :app_id, - :identifier, - :type, - :redirect_url, - :ttl, - :url -``` + +Class | Method | Description +------------ | ------------- | ------------- +*ClientApi* | [**get_app**](docs/custom/ClientApi.md#get_app) | Get App +*ClientApi* | [**create_magic_link**](docs/custom/Passage/ClientApi.md#create_magic_link) | Create Embeddable Magic Link +*AuthApi* | [**validate_jwt**](docs/custom/AuthApi.md#validate_jwt) | Validates user jwt token +*UserAPI* | [**user.delete_device**](docs/custom/UserApi.md#delete_device) | Delete a device for a user +*UserAPI* | [**user.list_devices**](docs/custom/UserApi.md#list_devices) | List User Devices +*UserAPI* | [**user.activate**](docs/custom/UserApi.md#activate) | Activate User +*UserAPI* | [**user.create**](docs/custom/UserApi.md#create) | Create User +*UserAPI* | [**user.deactivate**](docs/custom/UserApi.md#deactivate) | Deactivate User +*UserAPI* | [**user.delete**](docs/custom/UserApi.md#delete) | Delete User +*UserAPI* | [**user.get**](docs/custom/UserApi.md#get) | Get User +*UserAPI* | [**user.update**](docs/custom/UserApi.md#update) | Update User +*UserAPI* | [**user.signout**](docs/custom/UserApi.md#signout) | Update User \ No newline at end of file diff --git a/docs/custom/AuthApi.md b/docs/custom/AuthApi.md index 9c0ed00..aca04f4 100644 --- a/docs/custom/AuthApi.md +++ b/docs/custom/AuthApi.md @@ -1,4 +1,4 @@ -# Passage::TokensApi +# Passage::AuthApi All URIs are relative to *https://api.passage.id/v1* @@ -34,19 +34,6 @@ class ApplicationController < ActionController::Base 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. - -> revoke_user_refresh_tokens_with_http_info(app_id, user_id) - -```ruby - # Revokes refresh tokens - data, status_code, headers = PassageClient.auth.revoke_user_refresh_tokens_with_http_info(app_id, user_id) - p status_code # => 2xx - p headers # => { ... } - p data # => nil -``` ### Parameters diff --git a/docs/custom/UsersApi.md b/docs/custom/UserApi.md similarity index 69% rename from docs/custom/UsersApi.md rename to docs/custom/UserApi.md index 2592bfd..0d84ad9 100644 --- a/docs/custom/UsersApi.md +++ b/docs/custom/UserApi.md @@ -4,19 +4,19 @@ All URIs are relative to *https://api.passage.id/v1* | Method | HTTP request | Description | | ------ | ------------ | ----------- | -| [**activate_user**](UsersApi.md#activate_user) | **PATCH** /apps/{app_id}/users/{user_id}/activate | Activate User | -| [**create_user**](UsersApi.md#create_user) | **POST** /apps/{app_id}/users | Create User | -| [**deactivate_user**](UsersApi.md#deactivate_user) | **PATCH** /apps/{app_id}/users/{user_id}/deactivate | Deactivate User | -| [**delete_user**](UsersApi.md#delete_user) | **DELETE** /apps/{app_id}/users/{user_id} | Delete User | -| [**get_user**](UsersApi.md#get_user) | **GET** /apps/{app_id}/users/{user_id} | Get User | -| [**update_user**](UsersApi.md#update_user) | **PATCH** /apps/{app_id}/users/{user_id} | Update User | -| [**delete_user_devices**](UsersApi.md#delete_user_devices) | **DELETE** /apps/{app_id}/users/{user_id}/devices/{device_id} | Delete a device for a user | -| [**list_user_devices**](UsersApi.md#list_user_devices) | **GET** /apps/{app_id}/users/{user_id}/devices | List User Devices | +| [**activate**](UsersApi.md#activate) | **PATCH** /apps/{app_id}/users/{user_id}/activate | Activate User | +| [**create**](UsersApi.md#create) | **POST** /apps/{app_id}/users | Create User | +| [**deactivate**](UsersApi.md#deactivate) | **PATCH** /apps/{app_id}/users/{user_id}/deactivate | Deactivate User | +| [**delete**](UsersApi.md#delete) | **DELETE** /apps/{app_id}/users/{user_id} | Delete User | +| [**get**](UsersApi.md#get) | **GET** /apps/{app_id}/users/{user_id} | Get User | +| [**update**](UsersApi.md#update) | **PATCH** /apps/{app_id}/users/{user_id} | Update User | +| [**delete_device**](UsersApi.md#delete_device) | **DELETE** /apps/{app_id}/users/{user_id}/devices/{device_id} | Delete a device for a user | +| [**list_devices**](UsersApi.md#list_devices) | **GET** /apps/{app_id}/users/{user_id}/devices | List User Devices | -## activate_user +## activate -> activate_user(user_id) +> activate(user_id) Activate User @@ -30,10 +30,10 @@ user_id = 'user_id_example' # String | User ID begin # Activate User - result = api_instance.activate_user(user_id) + result = api_instance.activate(user_id) p result rescue OpenapiClient::ApiError => e - puts "Error when calling UsersApi->activate_user: #{e}" + puts "Error when calling UsersApi->activate: #{e}" end ``` @@ -58,9 +58,9 @@ end --- -## create_user +## create -> create_user(create_user_request) +> create(create_user_request) Create User @@ -74,10 +74,10 @@ create_user_request = OpenapiClient::CreateUserRequest.new # CreateUserRequest | begin # Create User - result = api_instance.create_user(create_user_request) + result = api_instance.create(create_user_request) p result rescue OpenapiClient::ApiError => e - puts "Error when calling UsersApi->create_user: #{e}" + puts "Error when calling UsersApi->create: #{e}" end ``` @@ -102,9 +102,9 @@ end --- -## deactivate_user +## deactivate -> deactivate_user(user_id) +> deactivate(user_id) Deactivate User @@ -118,10 +118,10 @@ user_id = 'user_id_example' # String | User ID begin # Deactivate User - result = api_instance.deactivate_user(user_id) + result = api_instance.deactivate(user_id) p result rescue OpenapiClient::ApiError => e - puts "Error when calling UsersApi->deactivate_user: #{e}" + puts "Error when calling UsersApi->deactivate: #{e}" end ``` @@ -147,9 +147,9 @@ end --- -## delete_user +## delete -> delete_user(user_id) +> delete(user_id) Delete User @@ -163,9 +163,9 @@ user_id = 'user_id_example' # String | User ID begin # Delete User - api_instance.delete_user(user_id) + api_instance.delete(user_id) rescue OpenapiClient::ApiError => e - puts "Error when calling UsersApi->delete_user: #{e}" + puts "Error when calling UsersApi->delete: #{e}" end ``` @@ -190,9 +190,9 @@ nil (empty response body) --- -## get_user +## get -> get_user(user_id) +> get(user_id) Get User @@ -206,10 +206,10 @@ user_id = 'user_id_example' # String | User ID begin # Get User - result = api_instance.get_user(user_id) + result = api_instance.get(user_id) p result rescue OpenapiClient::ApiError => e - puts "Error when calling UsersApi->get_user: #{e}" + puts "Error when calling UsersApi->get: #{e}" end ``` @@ -234,9 +234,9 @@ end --- -## update_user +## update -> update_user(user_id, update_user_request) +> update(user_id, update_user_request) Update User @@ -251,10 +251,10 @@ update_user_request = OpenapiClient::UpdateUserRequest.new # UpdateUserRequest | begin # Update User - result = api_instance.update_user(user_id, update_user_request) + result = api_instance.update(user_id, update_user_request) p result rescue OpenapiClient::ApiError => e - puts "Error when calling UsersApi->update_user: #{e}" + puts "Error when calling UsersApi->update: #{e}" end ``` @@ -280,9 +280,9 @@ end --- -## delete_user_devices +## delete_device -> delete_user_devices(user_id, device_id) +> delete_device(user_id, device_id) Delete a device for a user @@ -297,9 +297,9 @@ device_id = 'device_id_example' # String | Device ID begin # Delete a device for a user - api_instance.delete_user_devices(user_id, device_id) + api_instance.delete_device(user_id, device_id) rescue OpenapiClient::ApiError => e - puts "Error when calling UserDevicesApi->delete_user_devices: #{e}" + puts "Error when calling UserDevicesApi->delete_device: #{e}" end ``` @@ -326,9 +326,9 @@ nil (empty response body) --- -## list_user_devices +## list_devices -> list_user_devices(user_id) +> list_devices(user_id) List User Devices @@ -342,10 +342,10 @@ user_id = 'user_id_example' # String | User ID begin # List User Devices - result = api_instance.list_user_devices(user_id) + result = api_instance.list_devices(user_id) p result rescue OpenapiClient::ApiError => e - puts "Error when calling UserDevicesApi->list_user_devices: #{e}" + puts "Error when calling UserDevicesApi->list_devices: #{e}" end ```