passageidentity 0.2.3 → 0.4.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +27 -0
- data/README.md +18 -61
- data/docs/custom/AuthApi.md +141 -0
- data/docs/custom/ClientApi.md +107 -0
- data/docs/custom/UserApi.md +419 -0
- data/docs/generated/AppInfo.md +94 -0
- data/docs/generated/AppResponse.md +18 -0
- data/docs/generated/AppsApi.md +77 -0
- data/docs/generated/AuthMethods.md +22 -0
- data/docs/generated/CreateMagicLinkRequest.md +36 -0
- data/docs/generated/CreateUserRequest.md +22 -0
- data/docs/generated/ElementCustomization.md +56 -0
- data/docs/generated/FontFamily.md +15 -0
- data/docs/generated/GithubSocialConnection.md +24 -0
- data/docs/generated/GoogleSocialConnection.md +24 -0
- data/docs/generated/LayoutConfig.md +26 -0
- data/docs/generated/Layouts.md +20 -0
- data/docs/generated/ListDevicesResponse.md +18 -0
- data/docs/generated/MagicLink.md +36 -0
- data/docs/generated/MagicLinkAuthMethod.md +22 -0
- data/docs/generated/MagicLinkChannel.md +15 -0
- data/docs/generated/MagicLinkResponse.md +18 -0
- data/docs/generated/MagicLinkType.md +15 -0
- data/docs/generated/MagicLinksApi.md +79 -0
- data/docs/generated/Model400Error.md +20 -0
- data/docs/generated/Model401Error.md +20 -0
- data/docs/generated/Model404Error.md +20 -0
- data/docs/generated/Model500Error.md +20 -0
- data/docs/generated/OtpAuthMethod.md +22 -0
- data/docs/generated/PasskeysAuthMethod.md +18 -0
- data/docs/generated/README.md +152 -0
- data/docs/generated/Technologies.md +15 -0
- data/docs/generated/TokensApi.md +78 -0
- data/docs/generated/TtlDisplayUnit.md +15 -0
- data/docs/generated/UpdateMagicLinkAuthMethod.md +22 -0
- data/docs/generated/UpdateOtpAuthMethod.md +22 -0
- data/docs/generated/UpdatePasskeysAuthMethod.md +18 -0
- data/docs/generated/UpdateUserRequest.md +22 -0
- data/docs/generated/UserDevicesApi.md +152 -0
- data/docs/generated/UserEventInfo.md +26 -0
- data/docs/generated/UserInfo.md +48 -0
- data/docs/generated/UserMetadataField.md +28 -0
- data/docs/generated/UserMetadataFieldType.md +15 -0
- data/docs/generated/UserResponse.md +18 -0
- data/docs/generated/UserSocialConnections.md +20 -0
- data/docs/generated/UserStatus.md +15 -0
- data/docs/generated/UsersApi.md +440 -0
- data/docs/generated/WebAuthnDevices.md +34 -0
- data/docs/generated/WebAuthnIcons.md +20 -0
- data/docs/generated/WebAuthnType.md +15 -0
- data/generate.sh +31 -0
- data/lib/openapi_client/api/apps_api.rb +85 -0
- data/lib/openapi_client/api/magic_links_api.rb +96 -0
- data/lib/openapi_client/api/tokens_api.rb +91 -0
- data/lib/openapi_client/api/user_devices_api.rb +166 -0
- data/lib/openapi_client/api/users_api.rb +452 -0
- data/lib/openapi_client/api_client.rb +431 -0
- data/lib/openapi_client/api_error.rb +58 -0
- data/lib/openapi_client/configuration.rb +383 -0
- data/lib/openapi_client/models/app_info.rb +853 -0
- data/lib/openapi_client/models/app_response.rb +221 -0
- data/lib/openapi_client/models/auth_methods.rb +254 -0
- data/lib/openapi_client/models/create_magic_link_request.rb +374 -0
- data/lib/openapi_client/models/create_user_request.rb +234 -0
- data/lib/openapi_client/models/element_customization.rb +457 -0
- data/lib/openapi_client/models/font_family.rb +58 -0
- data/lib/openapi_client/models/github_social_connection.rb +271 -0
- data/lib/openapi_client/models/google_social_connection.rb +271 -0
- data/lib/openapi_client/models/layout_config.rb +285 -0
- data/lib/openapi_client/models/layouts.rb +241 -0
- data/lib/openapi_client/models/list_devices_response.rb +223 -0
- data/lib/openapi_client/models/magic_link.rb +387 -0
- data/lib/openapi_client/models/magic_link_auth_method.rb +302 -0
- data/lib/openapi_client/models/magic_link_channel.rb +40 -0
- data/lib/openapi_client/models/magic_link_response.rb +221 -0
- data/lib/openapi_client/models/magic_link_type.rb +40 -0
- data/lib/openapi_client/models/model400_error.rb +271 -0
- data/lib/openapi_client/models/model401_error.rb +271 -0
- data/lib/openapi_client/models/model404_error.rb +271 -0
- data/lib/openapi_client/models/model500_error.rb +271 -0
- data/lib/openapi_client/models/otp_auth_method.rb +302 -0
- data/lib/openapi_client/models/passkeys_auth_method.rb +228 -0
- data/lib/openapi_client/models/technologies.rb +46 -0
- data/lib/openapi_client/models/ttl_display_unit.rb +42 -0
- data/lib/openapi_client/models/update_magic_link_auth_method.rb +276 -0
- data/lib/openapi_client/models/update_otp_auth_method.rb +276 -0
- data/lib/openapi_client/models/update_passkeys_auth_method.rb +216 -0
- data/lib/openapi_client/models/update_user_request.rb +232 -0
- data/lib/openapi_client/models/user_event_info.rb +285 -0
- data/lib/openapi_client/models/user_info.rb +486 -0
- data/lib/openapi_client/models/user_metadata_field.rb +323 -0
- data/lib/openapi_client/models/user_metadata_field_type.rb +44 -0
- data/lib/openapi_client/models/user_response.rb +221 -0
- data/lib/openapi_client/models/user_social_connections.rb +223 -0
- data/lib/openapi_client/models/user_status.rb +41 -0
- data/lib/openapi_client/models/web_authn_devices.rb +378 -0
- data/lib/openapi_client/models/web_authn_icons.rb +230 -0
- data/lib/openapi_client/models/web_authn_type.rb +41 -0
- data/lib/openapi_client/version.rb +15 -0
- data/lib/openapi_client.rb +83 -0
- data/lib/passageidentity/auth.rb +32 -5
- data/lib/passageidentity/client.rb +17 -121
- data/lib/passageidentity/user_api.rb +29 -131
- data/lib/passageidentity/version.rb +5 -0
- data/openapitools.json +7 -0
- data/passageidentity.gemspec +3 -1
- data/tests/auth_test.rb +6 -1
- data/tests/magic_link_test.rb +5 -4
- data/tests/user_api_test.rb +2 -2
- metadata +103 -2
@@ -0,0 +1,56 @@
|
|
1
|
+
# OpenapiClient::ElementCustomization
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **passage_container_background_color** | **String** | Container background color in hex. Default is `#ffffff` in light mode & `#383838` in dark mode. | [optional] |
|
8
|
+
| **passage_container_max_width** | **Integer** | Maximum width of container (px) | [optional][default to 300] |
|
9
|
+
| **passage_input_box_background_color** | **String** | Input box background color in hex. Default is `#ffffff` in light mode & `#4b4b4b` in dark mode. | [optional] |
|
10
|
+
| **passage_input_box_border_radius** | **Integer** | Input box border radius (px) | [optional][default to 5] |
|
11
|
+
| **passage_header_font_family** | [**FontFamily**](FontFamily.md) | | [optional][default to 'Helvetica'] |
|
12
|
+
| **passage_body_font_family** | [**FontFamily**](FontFamily.md) | | [optional][default to 'Helvetica'] |
|
13
|
+
| **passage_header_text_color** | **String** | Header text color in hex. Default is `#222222` in light mode & `#f3f3f3` in dark mode. | [optional] |
|
14
|
+
| **passage_body_text_color** | **String** | Body text color in hex. Default is `#222222` in light mode & `#f3f3f3` in dark mode. | [optional] |
|
15
|
+
| **passage_primary_button_background_color** | **String** | Primary button background colour (hex) | [optional][default to '#121212'] |
|
16
|
+
| **passage_primary_button_text_color** | **String** | Primary button font colour (hex) | [optional][default to '#f3f3f3'] |
|
17
|
+
| **passage_primary_button_hover_color** | **String** | Primary button background on hover (hex) | [optional][default to '#4d4d4d'] |
|
18
|
+
| **passage_primary_button_border_radius** | **Integer** | Primary button border radius (px) | [optional][default to 5] |
|
19
|
+
| **passage_primary_button_border_color** | **String** | Primary button border color | [optional][default to '#121212'] |
|
20
|
+
| **passage_primary_button_border_width** | **Integer** | Primary button border width (px) | [optional][default to 0] |
|
21
|
+
| **passage_secondary_button_background_color** | **String** | Secondary button background colour (hex) | [optional][default to '#ffffff'] |
|
22
|
+
| **passage_secondary_button_text_color** | **String** | Secondary button font colour (hex) | [optional][default to '#222222'] |
|
23
|
+
| **passage_secondary_button_hover_color** | **String** | Secondary button background on hover (hex) | [optional][default to '#d7d7d7'] |
|
24
|
+
| **passage_secondary_button_border_radius** | **Integer** | Secondary button border radius (px) | [optional][default to 5] |
|
25
|
+
| **passage_secondary_button_border_color** | **String** | Secondary button border color | [optional][default to '#d7d7d7'] |
|
26
|
+
| **passage_secondary_button_border_width** | **Integer** | Secondary button border width (px) | [optional][default to 1] |
|
27
|
+
|
28
|
+
## Example
|
29
|
+
|
30
|
+
```ruby
|
31
|
+
require 'openapi_client'
|
32
|
+
|
33
|
+
instance = OpenapiClient::ElementCustomization.new(
|
34
|
+
passage_container_background_color: #ffffff,
|
35
|
+
passage_container_max_width: null,
|
36
|
+
passage_input_box_background_color: #ffffff,
|
37
|
+
passage_input_box_border_radius: null,
|
38
|
+
passage_header_font_family: null,
|
39
|
+
passage_body_font_family: null,
|
40
|
+
passage_header_text_color: #222222,
|
41
|
+
passage_body_text_color: #222222,
|
42
|
+
passage_primary_button_background_color: null,
|
43
|
+
passage_primary_button_text_color: null,
|
44
|
+
passage_primary_button_hover_color: null,
|
45
|
+
passage_primary_button_border_radius: null,
|
46
|
+
passage_primary_button_border_color: null,
|
47
|
+
passage_primary_button_border_width: null,
|
48
|
+
passage_secondary_button_background_color: null,
|
49
|
+
passage_secondary_button_text_color: null,
|
50
|
+
passage_secondary_button_hover_color: null,
|
51
|
+
passage_secondary_button_border_radius: null,
|
52
|
+
passage_secondary_button_border_color: null,
|
53
|
+
passage_secondary_button_border_width: null
|
54
|
+
)
|
55
|
+
```
|
56
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# OpenapiClient::GithubSocialConnection
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **provider_id** | **String** | The external ID of the Social Connection. | |
|
8
|
+
| **created_at** | **Time** | | |
|
9
|
+
| **last_login_at** | **Time** | | |
|
10
|
+
| **provider_identifier** | **String** | The email of connected social user. | |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'openapi_client'
|
16
|
+
|
17
|
+
instance = OpenapiClient::GithubSocialConnection.new(
|
18
|
+
provider_id: null,
|
19
|
+
created_at: null,
|
20
|
+
last_login_at: null,
|
21
|
+
provider_identifier: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# OpenapiClient::GoogleSocialConnection
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **provider_id** | **String** | The external ID of the Social Connection. | |
|
8
|
+
| **created_at** | **Time** | | |
|
9
|
+
| **last_login_at** | **Time** | | |
|
10
|
+
| **provider_identifier** | **String** | The email of connected social user. | |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'openapi_client'
|
16
|
+
|
17
|
+
instance = OpenapiClient::GoogleSocialConnection.new(
|
18
|
+
provider_id: null,
|
19
|
+
created_at: null,
|
20
|
+
last_login_at: null,
|
21
|
+
provider_identifier: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# OpenapiClient::LayoutConfig
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **h** | **Integer** | | |
|
8
|
+
| **id** | **String** | | |
|
9
|
+
| **w** | **Integer** | | |
|
10
|
+
| **x** | **Integer** | | |
|
11
|
+
| **y** | **Integer** | | |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'openapi_client'
|
17
|
+
|
18
|
+
instance = OpenapiClient::LayoutConfig.new(
|
19
|
+
h: null,
|
20
|
+
id: null,
|
21
|
+
w: null,
|
22
|
+
x: null,
|
23
|
+
y: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# OpenapiClient::Layouts
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **profile** | [**Array<LayoutConfig>**](LayoutConfig.md) | | |
|
8
|
+
| **registration** | [**Array<LayoutConfig>**](LayoutConfig.md) | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'openapi_client'
|
14
|
+
|
15
|
+
instance = OpenapiClient::Layouts.new(
|
16
|
+
profile: null,
|
17
|
+
registration: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# OpenapiClient::ListDevicesResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **devices** | [**Array<WebAuthnDevices>**](WebAuthnDevices.md) | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'openapi_client'
|
13
|
+
|
14
|
+
instance = OpenapiClient::ListDevicesResponse.new(
|
15
|
+
devices: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,36 @@
|
|
1
|
+
# OpenapiClient::MagicLink
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **activated** | **Boolean** | | |
|
8
|
+
| **app_id** | **String** | | |
|
9
|
+
| **id** | **String** | | |
|
10
|
+
| **identifier** | **String** | | |
|
11
|
+
| **redirect_url** | **String** | | |
|
12
|
+
| **secret** | **String** | | |
|
13
|
+
| **ttl** | **Integer** | | |
|
14
|
+
| **type** | [**MagicLinkType**](MagicLinkType.md) | | |
|
15
|
+
| **url** | **String** | | |
|
16
|
+
| **user_id** | **String** | | |
|
17
|
+
|
18
|
+
## Example
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'openapi_client'
|
22
|
+
|
23
|
+
instance = OpenapiClient::MagicLink.new(
|
24
|
+
activated: null,
|
25
|
+
app_id: null,
|
26
|
+
id: null,
|
27
|
+
identifier: null,
|
28
|
+
redirect_url: null,
|
29
|
+
secret: null,
|
30
|
+
ttl: null,
|
31
|
+
type: null,
|
32
|
+
url: null,
|
33
|
+
user_id: null
|
34
|
+
)
|
35
|
+
```
|
36
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# OpenapiClient::MagicLinkAuthMethod
|
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::MagicLinkAuthMethod.new(
|
17
|
+
enabled: null,
|
18
|
+
ttl: null,
|
19
|
+
ttl_display_unit: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# OpenapiClient::MagicLinkChannel
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
|
8
|
+
## Example
|
9
|
+
|
10
|
+
```ruby
|
11
|
+
require 'openapi_client'
|
12
|
+
|
13
|
+
instance = OpenapiClient::MagicLinkChannel.new()
|
14
|
+
```
|
15
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# OpenapiClient::MagicLinkResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **magic_link** | [**MagicLink**](MagicLink.md) | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'openapi_client'
|
13
|
+
|
14
|
+
instance = OpenapiClient::MagicLinkResponse.new(
|
15
|
+
magic_link: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,79 @@
|
|
1
|
+
# OpenapiClient::MagicLinksApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.passage.id/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**create_magic_link**](MagicLinksApi.md#create_magic_link) | **POST** /apps/{app_id}/magic-links | Create Embeddable Magic Link |
|
8
|
+
|
9
|
+
|
10
|
+
## create_magic_link
|
11
|
+
|
12
|
+
> <MagicLinkResponse> create_magic_link(app_id, create_magic_link_request)
|
13
|
+
|
14
|
+
Create Embeddable Magic Link
|
15
|
+
|
16
|
+
Create magic link 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::MagicLinksApi.new
|
30
|
+
app_id = 'app_id_example' # String | App ID
|
31
|
+
create_magic_link_request = OpenapiClient::CreateMagicLinkRequest.new({channel: OpenapiClient::MagicLinkChannel::EMAIL, email: 'email_example', magic_link_path: 'magic_link_path_example', phone: 'phone_example', redirect_url: 'redirect_url_example', _send: false, ttl: 37, user_id: 'user_id_example'}) # CreateMagicLinkRequest | magic link request
|
32
|
+
|
33
|
+
begin
|
34
|
+
# Create Embeddable Magic Link
|
35
|
+
result = api_instance.create_magic_link(app_id, create_magic_link_request)
|
36
|
+
p result
|
37
|
+
rescue OpenapiClient::ApiError => e
|
38
|
+
puts "Error when calling MagicLinksApi->create_magic_link: #{e}"
|
39
|
+
end
|
40
|
+
```
|
41
|
+
|
42
|
+
#### Using the create_magic_link_with_http_info variant
|
43
|
+
|
44
|
+
This returns an Array which contains the response data, status code and headers.
|
45
|
+
|
46
|
+
> <Array(<MagicLinkResponse>, Integer, Hash)> create_magic_link_with_http_info(app_id, create_magic_link_request)
|
47
|
+
|
48
|
+
```ruby
|
49
|
+
begin
|
50
|
+
# Create Embeddable Magic Link
|
51
|
+
data, status_code, headers = api_instance.create_magic_link_with_http_info(app_id, create_magic_link_request)
|
52
|
+
p status_code # => 2xx
|
53
|
+
p headers # => { ... }
|
54
|
+
p data # => <MagicLinkResponse>
|
55
|
+
rescue OpenapiClient::ApiError => e
|
56
|
+
puts "Error when calling MagicLinksApi->create_magic_link_with_http_info: #{e}"
|
57
|
+
end
|
58
|
+
```
|
59
|
+
|
60
|
+
### Parameters
|
61
|
+
|
62
|
+
| Name | Type | Description | Notes |
|
63
|
+
| ---- | ---- | ----------- | ----- |
|
64
|
+
| **app_id** | **String** | App ID | |
|
65
|
+
| **create_magic_link_request** | [**CreateMagicLinkRequest**](CreateMagicLinkRequest.md) | magic link request | |
|
66
|
+
|
67
|
+
### Return type
|
68
|
+
|
69
|
+
[**MagicLinkResponse**](MagicLinkResponse.md)
|
70
|
+
|
71
|
+
### Authorization
|
72
|
+
|
73
|
+
[bearerAuth](../README.md#bearerAuth)
|
74
|
+
|
75
|
+
### HTTP request headers
|
76
|
+
|
77
|
+
- **Content-Type**: application/json
|
78
|
+
- **Accept**: application/json
|
79
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# OpenapiClient::Model400Error
|
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::Model400Error.new(
|
16
|
+
code: null,
|
17
|
+
error: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# OpenapiClient::Model401Error
|
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::Model401Error.new(
|
16
|
+
code: null,
|
17
|
+
error: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,20 @@
|
|
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
|
+
|
@@ -0,0 +1,20 @@
|
|
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
|
+
|
@@ -0,0 +1,22 @@
|
|
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
|
+
|
@@ -0,0 +1,18 @@
|
|
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
|
+
|
@@ -0,0 +1,152 @@
|
|
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* | [**update_user**](docs/UsersApi.md#update_user) | **PATCH** /apps/{app_id}/users/{user_id} | Update User
|
100
|
+
|
101
|
+
|
102
|
+
## Documentation for Models
|
103
|
+
|
104
|
+
- [OpenapiClient::AppInfo](docs/AppInfo.md)
|
105
|
+
- [OpenapiClient::AppResponse](docs/AppResponse.md)
|
106
|
+
- [OpenapiClient::AuthMethods](docs/AuthMethods.md)
|
107
|
+
- [OpenapiClient::CreateMagicLinkRequest](docs/CreateMagicLinkRequest.md)
|
108
|
+
- [OpenapiClient::CreateUserRequest](docs/CreateUserRequest.md)
|
109
|
+
- [OpenapiClient::ElementCustomization](docs/ElementCustomization.md)
|
110
|
+
- [OpenapiClient::FontFamily](docs/FontFamily.md)
|
111
|
+
- [OpenapiClient::GithubSocialConnection](docs/GithubSocialConnection.md)
|
112
|
+
- [OpenapiClient::GoogleSocialConnection](docs/GoogleSocialConnection.md)
|
113
|
+
- [OpenapiClient::LayoutConfig](docs/LayoutConfig.md)
|
114
|
+
- [OpenapiClient::Layouts](docs/Layouts.md)
|
115
|
+
- [OpenapiClient::ListDevicesResponse](docs/ListDevicesResponse.md)
|
116
|
+
- [OpenapiClient::MagicLink](docs/MagicLink.md)
|
117
|
+
- [OpenapiClient::MagicLinkAuthMethod](docs/MagicLinkAuthMethod.md)
|
118
|
+
- [OpenapiClient::MagicLinkChannel](docs/MagicLinkChannel.md)
|
119
|
+
- [OpenapiClient::MagicLinkResponse](docs/MagicLinkResponse.md)
|
120
|
+
- [OpenapiClient::MagicLinkType](docs/MagicLinkType.md)
|
121
|
+
- [OpenapiClient::Model400Error](docs/Model400Error.md)
|
122
|
+
- [OpenapiClient::Model401Error](docs/Model401Error.md)
|
123
|
+
- [OpenapiClient::Model404Error](docs/Model404Error.md)
|
124
|
+
- [OpenapiClient::Model500Error](docs/Model500Error.md)
|
125
|
+
- [OpenapiClient::OtpAuthMethod](docs/OtpAuthMethod.md)
|
126
|
+
- [OpenapiClient::PasskeysAuthMethod](docs/PasskeysAuthMethod.md)
|
127
|
+
- [OpenapiClient::Technologies](docs/Technologies.md)
|
128
|
+
- [OpenapiClient::TtlDisplayUnit](docs/TtlDisplayUnit.md)
|
129
|
+
- [OpenapiClient::UpdateMagicLinkAuthMethod](docs/UpdateMagicLinkAuthMethod.md)
|
130
|
+
- [OpenapiClient::UpdateOtpAuthMethod](docs/UpdateOtpAuthMethod.md)
|
131
|
+
- [OpenapiClient::UpdatePasskeysAuthMethod](docs/UpdatePasskeysAuthMethod.md)
|
132
|
+
- [OpenapiClient::UpdateUserRequest](docs/UpdateUserRequest.md)
|
133
|
+
- [OpenapiClient::UserEventInfo](docs/UserEventInfo.md)
|
134
|
+
- [OpenapiClient::UserInfo](docs/UserInfo.md)
|
135
|
+
- [OpenapiClient::UserMetadataField](docs/UserMetadataField.md)
|
136
|
+
- [OpenapiClient::UserMetadataFieldType](docs/UserMetadataFieldType.md)
|
137
|
+
- [OpenapiClient::UserResponse](docs/UserResponse.md)
|
138
|
+
- [OpenapiClient::UserSocialConnections](docs/UserSocialConnections.md)
|
139
|
+
- [OpenapiClient::UserStatus](docs/UserStatus.md)
|
140
|
+
- [OpenapiClient::WebAuthnDevices](docs/WebAuthnDevices.md)
|
141
|
+
- [OpenapiClient::WebAuthnIcons](docs/WebAuthnIcons.md)
|
142
|
+
- [OpenapiClient::WebAuthnType](docs/WebAuthnType.md)
|
143
|
+
|
144
|
+
|
145
|
+
## Documentation for Authorization
|
146
|
+
|
147
|
+
|
148
|
+
Authentication schemes defined for the API:
|
149
|
+
### bearerAuth
|
150
|
+
|
151
|
+
- **Type**: Bearer authentication (JWT)
|
152
|
+
|