passageidentity 0.6.2 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (135) hide show
  1. checksums.yaml +4 -4
  2. data/lib/openapi_client/api/apps_api.rb +2 -2
  3. data/lib/openapi_client/api/magic_links_api.rb +4 -4
  4. data/lib/openapi_client/api/tokens_api.rb +2 -2
  5. data/lib/openapi_client/api/user_devices_api.rb +3 -3
  6. data/lib/openapi_client/api/users_api.rb +8 -8
  7. data/lib/openapi_client/api_client.rb +36 -30
  8. data/lib/openapi_client/api_error.rb +1 -1
  9. data/lib/openapi_client/configuration.rb +11 -1
  10. data/lib/openapi_client/models/app_info.rb +36 -3
  11. data/lib/openapi_client/models/app_response.rb +1 -1
  12. data/lib/openapi_client/models/apple_user_social_connection.rb +1 -1
  13. data/lib/openapi_client/models/auth_methods.rb +1 -1
  14. data/lib/openapi_client/models/create_magic_link_request.rb +2 -57
  15. data/lib/openapi_client/models/create_user_request.rb +1 -1
  16. data/lib/openapi_client/models/element_customization.rb +1 -1
  17. data/lib/openapi_client/models/font_family.rb +1 -1
  18. data/lib/openapi_client/models/github_user_social_connection.rb +1 -1
  19. data/lib/openapi_client/models/google_user_social_connection.rb +1 -1
  20. data/lib/openapi_client/models/layout_config.rb +1 -1
  21. data/lib/openapi_client/models/layouts.rb +1 -1
  22. data/lib/openapi_client/models/link.rb +1 -1
  23. data/lib/openapi_client/models/list_devices_response.rb +1 -1
  24. data/lib/openapi_client/models/list_paginated_users_item.rb +19 -2
  25. data/lib/openapi_client/models/list_paginated_users_response.rb +1 -1
  26. data/lib/openapi_client/models/magic_link.rb +1 -1
  27. data/lib/openapi_client/models/magic_link_auth_method.rb +1 -1
  28. data/lib/openapi_client/models/magic_link_channel.rb +1 -1
  29. data/lib/openapi_client/models/magic_link_response.rb +1 -1
  30. data/lib/openapi_client/models/magic_link_type.rb +1 -1
  31. data/lib/openapi_client/models/model400_error.rb +1 -1
  32. data/lib/openapi_client/models/model401_error.rb +1 -1
  33. data/lib/openapi_client/models/model403_error.rb +1 -1
  34. data/lib/openapi_client/models/model404_error.rb +3 -3
  35. data/lib/openapi_client/models/model500_error.rb +1 -1
  36. data/lib/openapi_client/models/nonce.rb +1 -1
  37. data/lib/openapi_client/models/otp_auth_method.rb +1 -1
  38. data/lib/openapi_client/models/paginated_links.rb +1 -1
  39. data/lib/openapi_client/models/passkeys_auth_method.rb +1 -1
  40. data/lib/openapi_client/models/social_connection_type.rb +41 -0
  41. data/lib/openapi_client/models/technologies.rb +1 -1
  42. data/lib/openapi_client/models/theme_type.rb +41 -0
  43. data/lib/openapi_client/models/ttl_display_unit.rb +1 -1
  44. data/lib/openapi_client/models/update_user_request.rb +1 -1
  45. data/lib/openapi_client/models/user_event_action.rb +41 -0
  46. data/lib/openapi_client/models/user_event_status.rb +1 -1
  47. data/lib/openapi_client/models/user_info.rb +19 -2
  48. data/lib/openapi_client/models/user_metadata_field.rb +1 -1
  49. data/lib/openapi_client/models/user_metadata_field_type.rb +1 -1
  50. data/lib/openapi_client/models/user_recent_event.rb +51 -5
  51. data/lib/openapi_client/models/user_response.rb +1 -1
  52. data/lib/openapi_client/models/user_social_connections.rb +1 -1
  53. data/lib/openapi_client/models/user_status.rb +1 -1
  54. data/lib/openapi_client/models/web_authn_devices.rb +1 -1
  55. data/lib/openapi_client/models/web_authn_icons.rb +1 -1
  56. data/lib/openapi_client/models/web_authn_type.rb +1 -1
  57. data/lib/openapi_client/version.rb +1 -1
  58. data/lib/openapi_client.rb +4 -4
  59. data/lib/passageidentity/auth.rb +205 -104
  60. data/lib/passageidentity/client.rb +71 -59
  61. data/lib/passageidentity/error.rb +42 -16
  62. data/lib/passageidentity/user_api.rb +120 -161
  63. data/lib/passageidentity/version.rb +1 -1
  64. data/lib/passageidentity.rb +6 -2
  65. metadata +33 -79
  66. data/.github/workflows/deploy.yml +0 -30
  67. data/.github/workflows/on-pull-request.yml +0 -33
  68. data/.gitignore +0 -58
  69. data/CHANGELOG.md +0 -57
  70. data/CONTRIBUTING.md +0 -66
  71. data/Gemfile +0 -13
  72. data/LICENSE +0 -21
  73. data/README.md +0 -84
  74. data/docs/custom/AuthApi.md +0 -141
  75. data/docs/custom/ClientApi.md +0 -107
  76. data/docs/custom/UserApi.md +0 -419
  77. data/docs/generated/AppInfo.md +0 -94
  78. data/docs/generated/AppResponse.md +0 -18
  79. data/docs/generated/AppleUserSocialConnection.md +0 -24
  80. data/docs/generated/AppsApi.md +0 -77
  81. data/docs/generated/AuthMethods.md +0 -22
  82. data/docs/generated/CreateMagicLinkRequest.md +0 -36
  83. data/docs/generated/CreateUserRequest.md +0 -22
  84. data/docs/generated/ElementCustomization.md +0 -56
  85. data/docs/generated/FontFamily.md +0 -15
  86. data/docs/generated/GithubUserSocialConnection.md +0 -24
  87. data/docs/generated/GoogleUserSocialConnection.md +0 -24
  88. data/docs/generated/LayoutConfig.md +0 -26
  89. data/docs/generated/Layouts.md +0 -20
  90. data/docs/generated/Link.md +0 -18
  91. data/docs/generated/ListDevicesResponse.md +0 -18
  92. data/docs/generated/ListPaginatedUsersItem.md +0 -38
  93. data/docs/generated/ListPaginatedUsersResponse.md +0 -28
  94. data/docs/generated/MagicLink.md +0 -36
  95. data/docs/generated/MagicLinkAuthMethod.md +0 -22
  96. data/docs/generated/MagicLinkChannel.md +0 -15
  97. data/docs/generated/MagicLinkResponse.md +0 -18
  98. data/docs/generated/MagicLinkType.md +0 -15
  99. data/docs/generated/MagicLinksApi.md +0 -79
  100. data/docs/generated/Model400Error.md +0 -20
  101. data/docs/generated/Model401Error.md +0 -20
  102. data/docs/generated/Model403Error.md +0 -20
  103. data/docs/generated/Model404Error.md +0 -20
  104. data/docs/generated/Model500Error.md +0 -20
  105. data/docs/generated/Nonce.md +0 -18
  106. data/docs/generated/OtpAuthMethod.md +0 -22
  107. data/docs/generated/PaginatedLinks.md +0 -26
  108. data/docs/generated/PasskeysAuthMethod.md +0 -18
  109. data/docs/generated/README.md +0 -158
  110. data/docs/generated/Technologies.md +0 -15
  111. data/docs/generated/TokensApi.md +0 -78
  112. data/docs/generated/TtlDisplayUnit.md +0 -15
  113. data/docs/generated/UpdateUserRequest.md +0 -22
  114. data/docs/generated/UserDevicesApi.md +0 -152
  115. data/docs/generated/UserEventStatus.md +0 -15
  116. data/docs/generated/UserInfo.md +0 -48
  117. data/docs/generated/UserMetadataField.md +0 -28
  118. data/docs/generated/UserMetadataFieldType.md +0 -15
  119. data/docs/generated/UserRecentEvent.md +0 -30
  120. data/docs/generated/UserResponse.md +0 -18
  121. data/docs/generated/UserSocialConnections.md +0 -22
  122. data/docs/generated/UserStatus.md +0 -15
  123. data/docs/generated/UsersApi.md +0 -534
  124. data/docs/generated/WebAuthnDevices.md +0 -34
  125. data/docs/generated/WebAuthnIcons.md +0 -20
  126. data/docs/generated/WebAuthnType.md +0 -15
  127. data/generate.sh +0 -31
  128. data/openapitools.json +0 -7
  129. data/passageidentity.gemspec +0 -32
  130. data/tests/all.rb +0 -3
  131. data/tests/app_test.rb +0 -15
  132. data/tests/auth_test.rb +0 -74
  133. data/tests/errors_test.rb +0 -30
  134. data/tests/magic_link_test.rb +0 -22
  135. data/tests/user_api_test.rb +0 -121
@@ -1,20 +0,0 @@
1
- # OpenapiClient::Model403Error
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **code** | **String** | | |
8
- | **error** | **String** | | |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'openapi_client'
14
-
15
- instance = OpenapiClient::Model403Error.new(
16
- code: null,
17
- error: null
18
- )
19
- ```
20
-
@@ -1,20 +0,0 @@
1
- # OpenapiClient::Model404Error
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **code** | **String** | | |
8
- | **error** | **String** | | |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'openapi_client'
14
-
15
- instance = OpenapiClient::Model404Error.new(
16
- code: null,
17
- error: null
18
- )
19
- ```
20
-
@@ -1,20 +0,0 @@
1
- # OpenapiClient::Model500Error
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **code** | **String** | | |
8
- | **error** | **String** | | |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'openapi_client'
14
-
15
- instance = OpenapiClient::Model500Error.new(
16
- code: null,
17
- error: null
18
- )
19
- ```
20
-
@@ -1,18 +0,0 @@
1
- # OpenapiClient::Nonce
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **nonce** | **String** | | |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'openapi_client'
13
-
14
- instance = OpenapiClient::Nonce.new(
15
- nonce: null
16
- )
17
- ```
18
-
@@ -1,22 +0,0 @@
1
- # OpenapiClient::OtpAuthMethod
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **enabled** | **Boolean** | | |
8
- | **ttl** | **Integer** | Maximum time (IN SECONDS) for the auth to expire. | [default to 300] |
9
- | **ttl_display_unit** | [**TtlDisplayUnit**](TtlDisplayUnit.md) | | |
10
-
11
- ## Example
12
-
13
- ```ruby
14
- require 'openapi_client'
15
-
16
- instance = OpenapiClient::OtpAuthMethod.new(
17
- enabled: null,
18
- ttl: null,
19
- ttl_display_unit: null
20
- )
21
- ```
22
-
@@ -1,26 +0,0 @@
1
- # OpenapiClient::PaginatedLinks
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **first** | [**Link**](Link.md) | | |
8
- | **last** | [**Link**](Link.md) | | |
9
- | **_next** | [**Link**](Link.md) | | |
10
- | **previous** | [**Link**](Link.md) | | |
11
- | **_self** | [**Link**](Link.md) | | |
12
-
13
- ## Example
14
-
15
- ```ruby
16
- require 'openapi_client'
17
-
18
- instance = OpenapiClient::PaginatedLinks.new(
19
- first: null,
20
- last: null,
21
- _next: null,
22
- previous: null,
23
- _self: null
24
- )
25
- ```
26
-
@@ -1,18 +0,0 @@
1
- # OpenapiClient::PasskeysAuthMethod
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **enabled** | **Boolean** | | [default to true] |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'openapi_client'
13
-
14
- instance = OpenapiClient::PasskeysAuthMethod.new(
15
- enabled: null
16
- )
17
- ```
18
-
@@ -1,158 +0,0 @@
1
- # openapi_client
2
-
3
- OpenapiClient - the Ruby gem for the Passage Management API
4
-
5
- Passage's management API to manage your Passage apps and users.
6
-
7
- This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
-
9
- - API version: 1
10
- - Package version: 1.0.0
11
- - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
- For more information, please visit [https://passage.id/support](https://passage.id/support)
13
-
14
- ## Installation
15
-
16
- ### Build a gem
17
-
18
- To build the Ruby code into a gem:
19
-
20
- ```shell
21
- gem build openapi_client.gemspec
22
- ```
23
-
24
- Then either install the gem locally:
25
-
26
- ```shell
27
- gem install ./openapi_client-1.0.0.gem
28
- ```
29
-
30
- (for development, run `gem install --dev ./openapi_client-1.0.0.gem` to install the development dependencies)
31
-
32
- or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
33
-
34
- Finally add this to the Gemfile:
35
-
36
- gem 'openapi_client', '~> 1.0.0'
37
-
38
- ### Install from Git
39
-
40
- If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
41
-
42
- gem 'openapi_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
43
-
44
- ### Include the Ruby code directly
45
-
46
- Include the Ruby code directly using `-I` as follows:
47
-
48
- ```shell
49
- ruby -Ilib script.rb
50
- ```
51
-
52
- ## Getting Started
53
-
54
- Please follow the [installation](#installation) procedure and then run the following code:
55
-
56
- ```ruby
57
- # Load the gem
58
- require 'openapi_client'
59
-
60
- # Setup authorization
61
- OpenapiClient.configure do |config|
62
- # Configure Bearer authorization (JWT): bearerAuth
63
- config.access_token = 'YOUR_BEARER_TOKEN'
64
- # Configure a proc to get access tokens in lieu of the static access_token configuration
65
- config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' }
66
- # Configure faraday connection
67
- config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
68
- end
69
-
70
- api_instance = OpenapiClient::AppsApi.new
71
- app_id = 'app_id_example' # String | App ID
72
-
73
- begin
74
- #Get App
75
- result = api_instance.get_app(app_id)
76
- p result
77
- rescue OpenapiClient::ApiError => e
78
- puts "Exception when calling AppsApi->get_app: #{e}"
79
- end
80
-
81
- ```
82
-
83
- ## Documentation for API Endpoints
84
-
85
- All URIs are relative to *https://api.passage.id/v1*
86
-
87
- Class | Method | HTTP request | Description
88
- ------------ | ------------- | ------------- | -------------
89
- *OpenapiClient::AppsApi* | [**get_app**](docs/AppsApi.md#get_app) | **GET** /apps/{app_id} | Get App
90
- *OpenapiClient::MagicLinksApi* | [**create_magic_link**](docs/MagicLinksApi.md#create_magic_link) | **POST** /apps/{app_id}/magic-links | Create Embeddable Magic Link
91
- *OpenapiClient::TokensApi* | [**revoke_user_refresh_tokens**](docs/TokensApi.md#revoke_user_refresh_tokens) | **DELETE** /apps/{app_id}/users/{user_id}/tokens | Revokes refresh tokens
92
- *OpenapiClient::UserDevicesApi* | [**delete_user_devices**](docs/UserDevicesApi.md#delete_user_devices) | **DELETE** /apps/{app_id}/users/{user_id}/devices/{device_id} | Delete a device for a user
93
- *OpenapiClient::UserDevicesApi* | [**list_user_devices**](docs/UserDevicesApi.md#list_user_devices) | **GET** /apps/{app_id}/users/{user_id}/devices | List User Devices
94
- *OpenapiClient::UsersApi* | [**activate_user**](docs/UsersApi.md#activate_user) | **PATCH** /apps/{app_id}/users/{user_id}/activate | Activate User
95
- *OpenapiClient::UsersApi* | [**create_user**](docs/UsersApi.md#create_user) | **POST** /apps/{app_id}/users | Create User
96
- *OpenapiClient::UsersApi* | [**deactivate_user**](docs/UsersApi.md#deactivate_user) | **PATCH** /apps/{app_id}/users/{user_id}/deactivate | Deactivate User
97
- *OpenapiClient::UsersApi* | [**delete_user**](docs/UsersApi.md#delete_user) | **DELETE** /apps/{app_id}/users/{user_id} | Delete User
98
- *OpenapiClient::UsersApi* | [**get_user**](docs/UsersApi.md#get_user) | **GET** /apps/{app_id}/users/{user_id} | Get User
99
- *OpenapiClient::UsersApi* | [**list_paginated_users**](docs/UsersApi.md#list_paginated_users) | **GET** /apps/{app_id}/users | List Users
100
- *OpenapiClient::UsersApi* | [**update_user**](docs/UsersApi.md#update_user) | **PATCH** /apps/{app_id}/users/{user_id} | Update User
101
-
102
-
103
- ## Documentation for Models
104
-
105
- - [OpenapiClient::AppInfo](docs/AppInfo.md)
106
- - [OpenapiClient::AppResponse](docs/AppResponse.md)
107
- - [OpenapiClient::AppleUserSocialConnection](docs/AppleUserSocialConnection.md)
108
- - [OpenapiClient::AuthMethods](docs/AuthMethods.md)
109
- - [OpenapiClient::CreateMagicLinkRequest](docs/CreateMagicLinkRequest.md)
110
- - [OpenapiClient::CreateUserRequest](docs/CreateUserRequest.md)
111
- - [OpenapiClient::ElementCustomization](docs/ElementCustomization.md)
112
- - [OpenapiClient::FontFamily](docs/FontFamily.md)
113
- - [OpenapiClient::GithubUserSocialConnection](docs/GithubUserSocialConnection.md)
114
- - [OpenapiClient::GoogleUserSocialConnection](docs/GoogleUserSocialConnection.md)
115
- - [OpenapiClient::LayoutConfig](docs/LayoutConfig.md)
116
- - [OpenapiClient::Layouts](docs/Layouts.md)
117
- - [OpenapiClient::Link](docs/Link.md)
118
- - [OpenapiClient::ListDevicesResponse](docs/ListDevicesResponse.md)
119
- - [OpenapiClient::ListPaginatedUsersItem](docs/ListPaginatedUsersItem.md)
120
- - [OpenapiClient::ListPaginatedUsersResponse](docs/ListPaginatedUsersResponse.md)
121
- - [OpenapiClient::MagicLink](docs/MagicLink.md)
122
- - [OpenapiClient::MagicLinkAuthMethod](docs/MagicLinkAuthMethod.md)
123
- - [OpenapiClient::MagicLinkChannel](docs/MagicLinkChannel.md)
124
- - [OpenapiClient::MagicLinkResponse](docs/MagicLinkResponse.md)
125
- - [OpenapiClient::MagicLinkType](docs/MagicLinkType.md)
126
- - [OpenapiClient::Model400Error](docs/Model400Error.md)
127
- - [OpenapiClient::Model401Error](docs/Model401Error.md)
128
- - [OpenapiClient::Model403Error](docs/Model403Error.md)
129
- - [OpenapiClient::Model404Error](docs/Model404Error.md)
130
- - [OpenapiClient::Model500Error](docs/Model500Error.md)
131
- - [OpenapiClient::Nonce](docs/Nonce.md)
132
- - [OpenapiClient::OtpAuthMethod](docs/OtpAuthMethod.md)
133
- - [OpenapiClient::PaginatedLinks](docs/PaginatedLinks.md)
134
- - [OpenapiClient::PasskeysAuthMethod](docs/PasskeysAuthMethod.md)
135
- - [OpenapiClient::Technologies](docs/Technologies.md)
136
- - [OpenapiClient::TtlDisplayUnit](docs/TtlDisplayUnit.md)
137
- - [OpenapiClient::UpdateUserRequest](docs/UpdateUserRequest.md)
138
- - [OpenapiClient::UserEventStatus](docs/UserEventStatus.md)
139
- - [OpenapiClient::UserInfo](docs/UserInfo.md)
140
- - [OpenapiClient::UserMetadataField](docs/UserMetadataField.md)
141
- - [OpenapiClient::UserMetadataFieldType](docs/UserMetadataFieldType.md)
142
- - [OpenapiClient::UserRecentEvent](docs/UserRecentEvent.md)
143
- - [OpenapiClient::UserResponse](docs/UserResponse.md)
144
- - [OpenapiClient::UserSocialConnections](docs/UserSocialConnections.md)
145
- - [OpenapiClient::UserStatus](docs/UserStatus.md)
146
- - [OpenapiClient::WebAuthnDevices](docs/WebAuthnDevices.md)
147
- - [OpenapiClient::WebAuthnIcons](docs/WebAuthnIcons.md)
148
- - [OpenapiClient::WebAuthnType](docs/WebAuthnType.md)
149
-
150
-
151
- ## Documentation for Authorization
152
-
153
-
154
- Authentication schemes defined for the API:
155
- ### bearerAuth
156
-
157
- - **Type**: Bearer authentication (JWT)
158
-
@@ -1,15 +0,0 @@
1
- # OpenapiClient::Technologies
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
-
8
- ## Example
9
-
10
- ```ruby
11
- require 'openapi_client'
12
-
13
- instance = OpenapiClient::Technologies.new()
14
- ```
15
-
@@ -1,78 +0,0 @@
1
- # OpenapiClient::TokensApi
2
-
3
- All URIs are relative to *https://api.passage.id/v1*
4
-
5
- | Method | HTTP request | Description |
6
- | ------ | ------------ | ----------- |
7
- | [**revoke_user_refresh_tokens**](TokensApi.md#revoke_user_refresh_tokens) | **DELETE** /apps/{app_id}/users/{user_id}/tokens | Revokes refresh tokens |
8
-
9
-
10
- ## revoke_user_refresh_tokens
11
-
12
- > revoke_user_refresh_tokens(app_id, user_id)
13
-
14
- Revokes refresh tokens
15
-
16
- Revokes all refresh tokens for a user
17
-
18
- ### Examples
19
-
20
- ```ruby
21
- require 'time'
22
- require 'openapi_client'
23
- # setup authorization
24
- OpenapiClient.configure do |config|
25
- # Configure Bearer authorization (JWT): bearerAuth
26
- config.access_token = 'YOUR_BEARER_TOKEN'
27
- end
28
-
29
- api_instance = OpenapiClient::TokensApi.new
30
- app_id = 'app_id_example' # String | App ID
31
- user_id = 'user_id_example' # String | User ID
32
-
33
- begin
34
- # Revokes refresh tokens
35
- api_instance.revoke_user_refresh_tokens(app_id, user_id)
36
- rescue OpenapiClient::ApiError => e
37
- puts "Error when calling TokensApi->revoke_user_refresh_tokens: #{e}"
38
- end
39
- ```
40
-
41
- #### Using the revoke_user_refresh_tokens_with_http_info variant
42
-
43
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
44
-
45
- > <Array(nil, Integer, Hash)> revoke_user_refresh_tokens_with_http_info(app_id, user_id)
46
-
47
- ```ruby
48
- begin
49
- # Revokes refresh tokens
50
- data, status_code, headers = api_instance.revoke_user_refresh_tokens_with_http_info(app_id, user_id)
51
- p status_code # => 2xx
52
- p headers # => { ... }
53
- p data # => nil
54
- rescue OpenapiClient::ApiError => e
55
- puts "Error when calling TokensApi->revoke_user_refresh_tokens_with_http_info: #{e}"
56
- end
57
- ```
58
-
59
- ### Parameters
60
-
61
- | Name | Type | Description | Notes |
62
- | ---- | ---- | ----------- | ----- |
63
- | **app_id** | **String** | App ID | |
64
- | **user_id** | **String** | User ID | |
65
-
66
- ### Return type
67
-
68
- nil (empty response body)
69
-
70
- ### Authorization
71
-
72
- [bearerAuth](../README.md#bearerAuth)
73
-
74
- ### HTTP request headers
75
-
76
- - **Content-Type**: Not defined
77
- - **Accept**: application/json
78
-
@@ -1,15 +0,0 @@
1
- # OpenapiClient::TtlDisplayUnit
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
-
8
- ## Example
9
-
10
- ```ruby
11
- require 'openapi_client'
12
-
13
- instance = OpenapiClient::TtlDisplayUnit.new()
14
- ```
15
-
@@ -1,22 +0,0 @@
1
- # OpenapiClient::UpdateUserRequest
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **email** | **String** | | [optional] |
8
- | **phone** | **String** | | [optional] |
9
- | **user_metadata** | **Object** | | [optional] |
10
-
11
- ## Example
12
-
13
- ```ruby
14
- require 'openapi_client'
15
-
16
- instance = OpenapiClient::UpdateUserRequest.new(
17
- email: null,
18
- phone: null,
19
- user_metadata: null
20
- )
21
- ```
22
-
@@ -1,152 +0,0 @@
1
- # OpenapiClient::UserDevicesApi
2
-
3
- All URIs are relative to *https://api.passage.id/v1*
4
-
5
- | Method | HTTP request | Description |
6
- | ------ | ------------ | ----------- |
7
- | [**delete_user_devices**](UserDevicesApi.md#delete_user_devices) | **DELETE** /apps/{app_id}/users/{user_id}/devices/{device_id} | Delete a device for a user |
8
- | [**list_user_devices**](UserDevicesApi.md#list_user_devices) | **GET** /apps/{app_id}/users/{user_id}/devices | List User Devices |
9
-
10
-
11
- ## delete_user_devices
12
-
13
- > delete_user_devices(app_id, user_id, device_id)
14
-
15
- Delete a device for a user
16
-
17
- Delete a device for a user.
18
-
19
- ### Examples
20
-
21
- ```ruby
22
- require 'time'
23
- require 'openapi_client'
24
- # setup authorization
25
- OpenapiClient.configure do |config|
26
- # Configure Bearer authorization (JWT): bearerAuth
27
- config.access_token = 'YOUR_BEARER_TOKEN'
28
- end
29
-
30
- api_instance = OpenapiClient::UserDevicesApi.new
31
- app_id = 'app_id_example' # String | App ID
32
- user_id = 'user_id_example' # String | User ID
33
- device_id = 'device_id_example' # String | Device ID
34
-
35
- begin
36
- # Delete a device for a user
37
- api_instance.delete_user_devices(app_id, user_id, device_id)
38
- rescue OpenapiClient::ApiError => e
39
- puts "Error when calling UserDevicesApi->delete_user_devices: #{e}"
40
- end
41
- ```
42
-
43
- #### Using the delete_user_devices_with_http_info variant
44
-
45
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
46
-
47
- > <Array(nil, Integer, Hash)> delete_user_devices_with_http_info(app_id, user_id, device_id)
48
-
49
- ```ruby
50
- begin
51
- # Delete a device for a user
52
- data, status_code, headers = api_instance.delete_user_devices_with_http_info(app_id, user_id, device_id)
53
- p status_code # => 2xx
54
- p headers # => { ... }
55
- p data # => nil
56
- rescue OpenapiClient::ApiError => e
57
- puts "Error when calling UserDevicesApi->delete_user_devices_with_http_info: #{e}"
58
- end
59
- ```
60
-
61
- ### Parameters
62
-
63
- | Name | Type | Description | Notes |
64
- | ---- | ---- | ----------- | ----- |
65
- | **app_id** | **String** | App ID | |
66
- | **user_id** | **String** | User ID | |
67
- | **device_id** | **String** | Device ID | |
68
-
69
- ### Return type
70
-
71
- nil (empty response body)
72
-
73
- ### Authorization
74
-
75
- [bearerAuth](../README.md#bearerAuth)
76
-
77
- ### HTTP request headers
78
-
79
- - **Content-Type**: Not defined
80
- - **Accept**: application/json
81
-
82
-
83
- ## list_user_devices
84
-
85
- > <ListDevicesResponse> list_user_devices(app_id, user_id)
86
-
87
- List User Devices
88
-
89
- List user devices.
90
-
91
- ### Examples
92
-
93
- ```ruby
94
- require 'time'
95
- require 'openapi_client'
96
- # setup authorization
97
- OpenapiClient.configure do |config|
98
- # Configure Bearer authorization (JWT): bearerAuth
99
- config.access_token = 'YOUR_BEARER_TOKEN'
100
- end
101
-
102
- api_instance = OpenapiClient::UserDevicesApi.new
103
- app_id = 'app_id_example' # String | App ID
104
- user_id = 'user_id_example' # String | User ID
105
-
106
- begin
107
- # List User Devices
108
- result = api_instance.list_user_devices(app_id, user_id)
109
- p result
110
- rescue OpenapiClient::ApiError => e
111
- puts "Error when calling UserDevicesApi->list_user_devices: #{e}"
112
- end
113
- ```
114
-
115
- #### Using the list_user_devices_with_http_info variant
116
-
117
- This returns an Array which contains the response data, status code and headers.
118
-
119
- > <Array(<ListDevicesResponse>, Integer, Hash)> list_user_devices_with_http_info(app_id, user_id)
120
-
121
- ```ruby
122
- begin
123
- # List User Devices
124
- data, status_code, headers = api_instance.list_user_devices_with_http_info(app_id, user_id)
125
- p status_code # => 2xx
126
- p headers # => { ... }
127
- p data # => <ListDevicesResponse>
128
- rescue OpenapiClient::ApiError => e
129
- puts "Error when calling UserDevicesApi->list_user_devices_with_http_info: #{e}"
130
- end
131
- ```
132
-
133
- ### Parameters
134
-
135
- | Name | Type | Description | Notes |
136
- | ---- | ---- | ----------- | ----- |
137
- | **app_id** | **String** | App ID | |
138
- | **user_id** | **String** | User ID | |
139
-
140
- ### Return type
141
-
142
- [**ListDevicesResponse**](ListDevicesResponse.md)
143
-
144
- ### Authorization
145
-
146
- [bearerAuth](../README.md#bearerAuth)
147
-
148
- ### HTTP request headers
149
-
150
- - **Content-Type**: Not defined
151
- - **Accept**: application/json
152
-
@@ -1,15 +0,0 @@
1
- # OpenapiClient::UserEventStatus
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
-
8
- ## Example
9
-
10
- ```ruby
11
- require 'openapi_client'
12
-
13
- instance = OpenapiClient::UserEventStatus.new()
14
- ```
15
-
@@ -1,48 +0,0 @@
1
- # OpenapiClient::UserInfo
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **created_at** | **Time** | | |
8
- | **email** | **String** | | |
9
- | **email_verified** | **Boolean** | | |
10
- | **id** | **String** | | |
11
- | **last_login_at** | **Time** | | |
12
- | **login_count** | **Integer** | | |
13
- | **phone** | **String** | | |
14
- | **phone_verified** | **Boolean** | | |
15
- | **recent_events** | [**Array&lt;UserRecentEvent&gt;**](UserRecentEvent.md) | | |
16
- | **social_connections** | [**UserSocialConnections**](UserSocialConnections.md) | | |
17
- | **status** | [**UserStatus**](UserStatus.md) | | |
18
- | **updated_at** | **Time** | | |
19
- | **user_metadata** | **Object** | | |
20
- | **webauthn** | **Boolean** | | |
21
- | **webauthn_devices** | [**Array&lt;WebAuthnDevices&gt;**](WebAuthnDevices.md) | | |
22
- | **webauthn_types** | [**Array&lt;WebAuthnType&gt;**](WebAuthnType.md) | List of credential types that have been used for authentication | |
23
-
24
- ## Example
25
-
26
- ```ruby
27
- require 'openapi_client'
28
-
29
- instance = OpenapiClient::UserInfo.new(
30
- created_at: null,
31
- email: null,
32
- email_verified: null,
33
- id: null,
34
- last_login_at: null,
35
- login_count: null,
36
- phone: null,
37
- phone_verified: null,
38
- recent_events: null,
39
- social_connections: null,
40
- status: null,
41
- updated_at: null,
42
- user_metadata: null,
43
- webauthn: null,
44
- webauthn_devices: null,
45
- webauthn_types: null
46
- )
47
- ```
48
-
@@ -1,28 +0,0 @@
1
- # OpenapiClient::UserMetadataField
2
-
3
- ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **field_name** | **String** | | |
8
- | **friendly_name** | **String** | | |
9
- | **id** | **String** | | |
10
- | **profile** | **Boolean** | | |
11
- | **registration** | **Boolean** | | |
12
- | **type** | [**UserMetadataFieldType**](UserMetadataFieldType.md) | | |
13
-
14
- ## Example
15
-
16
- ```ruby
17
- require 'openapi_client'
18
-
19
- instance = OpenapiClient::UserMetadataField.new(
20
- field_name: null,
21
- friendly_name: null,
22
- id: null,
23
- profile: null,
24
- registration: null,
25
- type: null
26
- )
27
- ```
28
-