workos 0.9.0 → 0.10.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/CODEOWNERS +5 -0
- data/.rubocop.yml +4 -0
- data/Gemfile.lock +2 -2
- data/README.md +118 -55
- data/docs/WorkOS/SSO.html +235 -235
- data/docs/file.README.html +20 -20
- data/lib/workos.rb +1 -0
- data/lib/workos/audit_trail.rb +1 -0
- data/lib/workos/client.rb +22 -1
- data/lib/workos/connection.rb +0 -2
- data/lib/workos/organization.rb +0 -2
- data/lib/workos/passwordless.rb +3 -2
- data/lib/workos/portal.rb +1 -7
- data/lib/workos/profile.rb +2 -4
- data/lib/workos/sso.rb +121 -13
- data/lib/workos/types/intent_enum.rb +1 -0
- data/lib/workos/version.rb +1 -1
- data/spec/lib/workos/passwordless_spec.rb +1 -0
- data/spec/lib/workos/portal_spec.rb +18 -3
- data/spec/lib/workos/sso_spec.rb +212 -7
- data/spec/support/fixtures/vcr_cassettes/audit_trail/get_events.yml +2 -2
- data/spec/support/fixtures/vcr_cassettes/directory_sync/list_directories.yml +1 -1
- data/spec/support/fixtures/vcr_cassettes/directory_sync/list_directories_with_domain_param.yml +1 -1
- data/spec/support/fixtures/vcr_cassettes/portal/generate_link_dsync.yml +72 -0
- data/spec/support/fixtures/vcr_cassettes/portal/{generate_link.yml → generate_link_sso.yml} +1 -1
- data/spec/support/fixtures/vcr_cassettes/sso/delete_connection_with_invalid_id.yml +72 -0
- data/spec/support/fixtures/vcr_cassettes/sso/delete_connection_with_valid_id.yml +70 -0
- data/spec/support/fixtures/vcr_cassettes/sso/get_connection_with_invalid_id.yml +72 -0
- data/spec/support/fixtures/vcr_cassettes/sso/get_connection_with_valid_id.yml +74 -0
- data/spec/support/fixtures/vcr_cassettes/sso/list_connections.yml +72 -0
- data/spec/support/fixtures/vcr_cassettes/sso/list_connections_with_after_param.yml +72 -0
- data/spec/support/fixtures/vcr_cassettes/sso/list_connections_with_before_param.yml +73 -0
- data/spec/support/fixtures/vcr_cassettes/sso/list_connections_with_connection_type_param.yml +72 -0
- data/spec/support/fixtures/vcr_cassettes/sso/list_connections_with_domain_param.yml +72 -0
- data/spec/support/fixtures/vcr_cassettes/sso/list_connections_with_limit_param.yml +72 -0
- data/spec/support/fixtures/vcr_cassettes/sso/list_connections_with_organization_id_param.yml +72 -0
- metadata +30 -6
- data/CODEOWNERS +0 -1
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 84def52db9a12c4c5563af30a992f43e68441e7139624b787c588f39827d4843
|
4
|
+
data.tar.gz: 1d378bfefbdeae33688496031448bac6eea97a96e1179e91496c8f8ba69c87ca
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 37117a2ea0851f35e83bbe4f17cf04dfb4ab2c7769e7f797ddd3e3d910849e0ae58e07647a72c7a21b4cf7f31f60a17fe60f78da149a422c9c211db284bc19f2
|
7
|
+
data.tar.gz: 5747ba824f3aceda49c56ae5154264d153f59befd01f89465df6bb6f1e29b14edd04c9cc2f66f73442e4e31fa2766bed76ce705c4c1b4609c4b6da1bbc8f701b
|
data/.github/CODEOWNERS
ADDED
data/.rubocop.yml
CHANGED
@@ -10,8 +10,12 @@ Layout/LineLength:
|
|
10
10
|
- '(\A|\s)/.*?/'
|
11
11
|
Metrics/BlockLength:
|
12
12
|
ExcludedMethods: ['describe', 'context']
|
13
|
+
Metrics/MethodLength:
|
14
|
+
Max: 15
|
13
15
|
Metrics/ModuleLength:
|
14
16
|
Max: 150
|
17
|
+
Metrics/ParameterLists:
|
18
|
+
Max: 6
|
15
19
|
Style/TrailingCommaInArguments:
|
16
20
|
EnforcedStyleForMultiline: 'consistent_comma'
|
17
21
|
Style/TrailingCommaInHashLiteral:
|
data/Gemfile.lock
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
PATH
|
2
2
|
remote: .
|
3
3
|
specs:
|
4
|
-
workos (0.
|
4
|
+
workos (0.10.2)
|
5
5
|
sorbet-runtime (~> 0.5)
|
6
6
|
|
7
7
|
GEM
|
@@ -54,7 +54,7 @@ GEM
|
|
54
54
|
simplecov-html (0.12.2)
|
55
55
|
sorbet (0.5.5560)
|
56
56
|
sorbet-static (= 0.5.5560)
|
57
|
-
sorbet-runtime (0.5.
|
57
|
+
sorbet-runtime (0.5.6317)
|
58
58
|
sorbet-static (0.5.5560-universal-darwin-14)
|
59
59
|
unicode-display_width (1.6.0)
|
60
60
|
vcr (5.0.0)
|
data/README.md
CHANGED
@@ -42,50 +42,9 @@ Alternatively, you may set the key yourself, such as in an initializer in your a
|
|
42
42
|
WorkOS.key = '[your api key]'
|
43
43
|
```
|
44
44
|
|
45
|
-
## The Audit Trail Module
|
46
|
-
|
47
|
-
The Audit Trail Module provides methods for creating Audit Trail events on
|
48
|
-
WorkOS.
|
49
|
-
|
50
|
-
See our [Audit Trail
|
51
|
-
Overview](https://docs.workos.com/audit-trail/overview) for
|
52
|
-
more information.
|
53
|
-
|
54
|
-
```ruby
|
55
|
-
payload = {
|
56
|
-
group: 'Foo Corp',
|
57
|
-
location: '127.0.0.1',
|
58
|
-
action: 'user.created',
|
59
|
-
action_type: 'C',
|
60
|
-
actor_name: 'Foo',
|
61
|
-
actor_id: 'user_12345',
|
62
|
-
target_name: 'Bar',
|
63
|
-
target_id: 'user_67890',
|
64
|
-
occurred_at: '2020-01-10T15:30:00-05:00',
|
65
|
-
metadata: {
|
66
|
-
source: 'Email',
|
67
|
-
}
|
68
|
-
}
|
69
|
-
|
70
|
-
WorkOS::AuditTrail.create_event(event: payload)
|
71
|
-
```
|
72
|
-
|
73
|
-
### Idempotency
|
74
|
-
|
75
|
-
To perform an idempotent request, provide an additional idempotency_key
|
76
|
-
parameter to the `create_event` options.
|
77
|
-
|
78
|
-
```ruby
|
79
|
-
WorkOS::AuditTrail.create_event(event: payload, idempotency_key: 'key123456')
|
80
|
-
```
|
81
|
-
|
82
|
-
See our [API
|
83
|
-
Reference](https://docs.workos.com/audit-trail/api-reference#idempotency)
|
84
|
-
for more information on idempotency keys.
|
85
|
-
|
86
45
|
## The SSO Module
|
87
46
|
|
88
|
-
The SSO Module provides
|
47
|
+
The SSO Module provides convenient methods for authenticating a Single Sign On (SSO) user via WorkOS. WorkOS SSO follows the OAuth 2.0 specification.
|
89
48
|
|
90
49
|
First, you'll direct your SSO users to an `authorization_url`. They will sign in to their SSO account with their Identity Provider, and be redirected to a
|
91
50
|
callback URL that you set in your WorkOS Dashboard. The user will be redirected with a `code` URL parameter, which you can then exchange for a WorkOS::Profile
|
@@ -94,7 +53,7 @@ using the `WorkOS::SSO.get_profile` method.
|
|
94
53
|
See our Ruby SSO example app for a [complete example](https://github.com/workos-inc/ruby-sso-example).
|
95
54
|
|
96
55
|
```ruby
|
97
|
-
WorkOS::SSO.authorization_url(domain:,
|
56
|
+
WorkOS::SSO.authorization_url(domain:, client_id:, redirect_uri:, state: {})
|
98
57
|
```
|
99
58
|
|
100
59
|
> Generate an authorization URL to intitiate the WorkOS OAuth2 workflow.
|
@@ -102,25 +61,25 @@ WorkOS::SSO.authorization_url(domain:, project_id:, redirect_uri:, state: {})
|
|
102
61
|
`WorkOS::SSO.authorization_url` accepts four arguments:
|
103
62
|
|
104
63
|
- `domain` (string) — the authenticating user's company domain, without protocol (ex. `example.com`)
|
105
|
-
- `
|
64
|
+
- `client_id` (string) — your application's WorkOS [Client ID](https://dashboard.workos.com/sso/configuration) (ex. `project_01JG3BCPTRTSTTWQR4VSHXGWCQ`)
|
106
65
|
- `state` (optional, hash) — an optional hash used to manage state across authorization transactions (ex. `{ next_page: '/docs'}`)
|
107
|
-
- `redirect_uri` (string) — a callback URL where your application redirects the user-agent after an authorization code is granted (ex. `workos.dev/callback`). This must match one of your configured callback URLs for the associated
|
66
|
+
- `redirect_uri` (string) — a callback URL where your application redirects the user-agent after an authorization code is granted (ex. `workos.dev/callback`). This must match one of your configured callback URLs for the associated environment on your WorkOS dashboard.
|
108
67
|
|
109
68
|
This method will return an OAuth2 query string of the form:
|
110
69
|
|
111
|
-
`https://${domain}/sso/authorize?response_type=code&client_id=${
|
70
|
+
`https://${domain}/sso/authorize?response_type=code&client_id=${clientID}&redirect_uri=${redirectURI}&state=${state}`
|
112
71
|
|
113
72
|
For example, when used in a [Sinatra app](http://sinatrarb.com/):
|
114
73
|
|
115
74
|
```ruby
|
116
75
|
DOMAIN = 'example.com'
|
117
|
-
|
76
|
+
CLIENT_ID = '{clientId}'
|
118
77
|
REDIRECT_URI = 'http://localhost:4567/callback'
|
119
78
|
|
120
79
|
get '/auth' do
|
121
80
|
authorization_url = WorkOS::SSO.authorization_url(
|
122
81
|
domain: DOMAIN,
|
123
|
-
|
82
|
+
client_id: CLIENT_ID,
|
124
83
|
redirect_uri: REDIRECT_URI,
|
125
84
|
)
|
126
85
|
|
@@ -130,14 +89,14 @@ end
|
|
130
89
|
|
131
90
|
The user would be redirected to:
|
132
91
|
|
133
|
-
`https://api.workos.com/sso/authorize?response_type=code&client_id={
|
92
|
+
`https://api.workos.com/sso/authorize?response_type=code&client_id={clientID}&redirect_uri=http://localhost:4567/callback`
|
134
93
|
|
135
94
|
WorkOS takes over from here, sending the user to authenticate with their IDP, and on successful login, returns
|
136
95
|
the user to your callback URL with a `code` parameter. You'll use `WorkOS::SSO.profile` to exchange the
|
137
96
|
code for a `WorkOS::Profile`.
|
138
97
|
|
139
98
|
```ruby
|
140
|
-
WorkOS::SSO.profile(code:,
|
99
|
+
WorkOS::SSO.profile(code:, client_id:)
|
141
100
|
```
|
142
101
|
|
143
102
|
> Fetch a WorkOS::Profile for an authorized user.
|
@@ -145,7 +104,7 @@ WorkOS::SSO.profile(code:, project_id:)</h4>
|
|
145
104
|
`WorkOS::SSO.profile` accepts two arguments:
|
146
105
|
|
147
106
|
- `code` (string) — an opaque string provided by the authorization server; will be exchanged for an Access Token when the user's profile is sent
|
148
|
-
- `
|
107
|
+
- `client_id` (string) — your application's WorkOS [Client ID](https://dashboard.workos.com/sso/configuration) (ex. `project_01JG3BCPTRTSTTWQR4VSHXGWCQ`)
|
149
108
|
|
150
109
|
This method will return an instance of a `WorkOS::Profile` with the following attributes:
|
151
110
|
|
@@ -168,17 +127,17 @@ This method will return an instance of a `WorkOS::Profile` with the following at
|
|
168
127
|
>
|
169
128
|
```
|
170
129
|
|
171
|
-
Our
|
130
|
+
Our Sinatra app can be extended to use this method:
|
172
131
|
|
173
132
|
```ruby
|
174
133
|
DOMAIN = 'example.com'
|
175
|
-
|
134
|
+
CLIENT_ID = '{clientId}'
|
176
135
|
REDIRECT_URI = 'http://localhost:4567/callback'
|
177
136
|
|
178
137
|
get '/auth' do
|
179
138
|
authorization_url = WorkOS::SSO.authorization_url(
|
180
139
|
domain: DOMAIN,
|
181
|
-
|
140
|
+
client_id: CLIENT_ID,
|
182
141
|
redirect_uri: REDIRECT_URI,
|
183
142
|
)
|
184
143
|
|
@@ -188,7 +147,7 @@ end
|
|
188
147
|
get '/callback' do
|
189
148
|
profile = WorkOS::SSO.profile(
|
190
149
|
code: params['code'],
|
191
|
-
|
150
|
+
client_id: CLIENT_ID,
|
192
151
|
)
|
193
152
|
|
194
153
|
session[:user] = profile.to_json
|
@@ -198,3 +157,107 @@ end
|
|
198
157
|
```
|
199
158
|
|
200
159
|
Given the `WorkOS::Profile`, you can now sign the user in according to your own authentication setup.
|
160
|
+
|
161
|
+
## The Magic Link Module
|
162
|
+
|
163
|
+
The Magic Link Module provides methods for authenticating a Passwordless user via WorkOS.
|
164
|
+
|
165
|
+
First, you'll create a Passwordless Session for a Magic Link connection.
|
166
|
+
Then, using the session ID, you'll email a user the Magic Link confirmation URL.
|
167
|
+
The user can then click on that link to be authenticated to your application.
|
168
|
+
|
169
|
+
> Create a Passwordless Session for a Magic Link Connection.
|
170
|
+
|
171
|
+
`WorkOS::Passwordless.create_session` accepts four arguments:
|
172
|
+
|
173
|
+
- `email` (string) - the email of the user to authenticate.
|
174
|
+
- `type` (string) - The type of Passwordless Session to create. Currently, the only supported value is `MagicLink`.
|
175
|
+
- `state` (optional, string) - Optional parameter that a Developer can choose to include in their authorization URL. If included, then the redirect URI received from WorkOS will contain the exact `state` that was passed in the authorization URL.
|
176
|
+
- `redirect_uri` (string) - a callback URL where your application redirects the user-agent after an authorization code is granted (ex. `workos.dev/callback`). This must match one of your configured callback URLs for the associated environment on your WorkOS dashboard.
|
177
|
+
|
178
|
+
This method will return a Passwordless Session object, containing the following attributes:
|
179
|
+
|
180
|
+
- `id` (string) - the unique ID of the session.
|
181
|
+
- `email` (string) - the email address of the user for the session.
|
182
|
+
- `expires_at` (date) - the ISO-8601 datetime at which the session expires.
|
183
|
+
- `link` (string) - the link for the user to authenticate with. You can use this link to send a custom email to the user, or send an email using the `WorkOS::Passwordless.send_session` method, described below.
|
184
|
+
|
185
|
+
> Email a user the Magic Link confirmation URL.
|
186
|
+
|
187
|
+
`WorkOS::Passwordless.send_session` accepts one argument:
|
188
|
+
|
189
|
+
- `id` (string) - the unique identifier of the Passwordless Session to send an email for.
|
190
|
+
|
191
|
+
This method will return a boolean confirming the Magic Link was sent.
|
192
|
+
|
193
|
+
> Example with Sinatra application
|
194
|
+
|
195
|
+
Our Sinatra app can be altered to use Magic Link:
|
196
|
+
|
197
|
+
```ruby
|
198
|
+
CLIENT_ID = '{clientId}'
|
199
|
+
REDIRECT_URI = 'http://localhost:4567/callback'
|
200
|
+
|
201
|
+
post '/passwordless-auth' do
|
202
|
+
session = WorkOS::Passwordless.create_session(
|
203
|
+
email: params[:email],
|
204
|
+
type: 'MagicLink',
|
205
|
+
redirect_uri: REDIRECT_URI
|
206
|
+
)
|
207
|
+
WorkOS::Passwordless.send_session(session.id)
|
208
|
+
|
209
|
+
redirect '/check-email'
|
210
|
+
end
|
211
|
+
|
212
|
+
get '/callback' do
|
213
|
+
profile = WorkOS::SSO.profile(
|
214
|
+
code: params['code'],
|
215
|
+
client_id: CLIENT_ID,
|
216
|
+
)
|
217
|
+
|
218
|
+
session[:user] = profile.to_json
|
219
|
+
|
220
|
+
redirect '/'
|
221
|
+
end
|
222
|
+
```
|
223
|
+
|
224
|
+
## The Audit Trail Module
|
225
|
+
|
226
|
+
The Audit Trail Module provides methods for creating Audit Trail events on
|
227
|
+
WorkOS.
|
228
|
+
|
229
|
+
See our [Audit Trail
|
230
|
+
Overview](https://docs.workos.com/audit-trail/overview) for
|
231
|
+
more information.
|
232
|
+
|
233
|
+
```ruby
|
234
|
+
payload = {
|
235
|
+
group: 'Foo Corp',
|
236
|
+
location: '127.0.0.1',
|
237
|
+
action: 'user.created',
|
238
|
+
action_type: 'C',
|
239
|
+
actor_name: 'Foo',
|
240
|
+
actor_id: 'user_12345',
|
241
|
+
target_name: 'Bar',
|
242
|
+
target_id: 'user_67890',
|
243
|
+
occurred_at: '2020-01-10T15:30:00-05:00',
|
244
|
+
metadata: {
|
245
|
+
source: 'Email',
|
246
|
+
}
|
247
|
+
}
|
248
|
+
|
249
|
+
WorkOS::AuditTrail.create_event(event: payload)
|
250
|
+
```
|
251
|
+
|
252
|
+
### Idempotency
|
253
|
+
|
254
|
+
To perform an idempotent request, provide an additional idempotency_key
|
255
|
+
parameter to the `create_event` options.
|
256
|
+
|
257
|
+
```ruby
|
258
|
+
WorkOS::AuditTrail.create_event(event: payload, idempotency_key: 'key123456')
|
259
|
+
```
|
260
|
+
|
261
|
+
See our [API
|
262
|
+
Reference](https://docs.workos.com/audit-trail/api-reference#idempotency)
|
263
|
+
for more information on idempotency keys.
|
data/docs/WorkOS/SSO.html
CHANGED
@@ -5,9 +5,9 @@
|
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
6
6
|
<title>
|
7
7
|
Module: WorkOS::SSO
|
8
|
-
|
8
|
+
|
9
9
|
— Documentation by YARD 0.9.22
|
10
|
-
|
10
|
+
|
11
11
|
</title>
|
12
12
|
|
13
13
|
<link rel="stylesheet" href="../css/style.css" type="text/css" />
|
@@ -35,16 +35,16 @@
|
|
35
35
|
<div id="main" tabindex="-1">
|
36
36
|
<div id="header">
|
37
37
|
<div id="menu">
|
38
|
-
|
38
|
+
|
39
39
|
<a href="../_index.html">Index (S)</a> »
|
40
40
|
<span class='title'><span class='object_link'><a href="../WorkOS.html" title="WorkOS (module)">WorkOS</a></span></span>
|
41
|
-
»
|
41
|
+
»
|
42
42
|
<span class="title">SSO</span>
|
43
|
-
|
43
|
+
|
44
44
|
</div>
|
45
45
|
|
46
46
|
<div id="search">
|
47
|
-
|
47
|
+
|
48
48
|
<a class="full_list_link" id="class_list_link"
|
49
49
|
href="../class_list.html">
|
50
50
|
|
@@ -54,74 +54,74 @@
|
|
54
54
|
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
55
55
|
</svg>
|
56
56
|
</a>
|
57
|
-
|
57
|
+
|
58
58
|
</div>
|
59
59
|
<div class="clear"></div>
|
60
60
|
</div>
|
61
61
|
|
62
62
|
<div id="content"><h1>Module: WorkOS::SSO
|
63
|
-
|
64
|
-
|
65
|
-
|
63
|
+
|
64
|
+
|
65
|
+
|
66
66
|
</h1>
|
67
67
|
<div class="box_info">
|
68
|
-
|
69
68
|
|
70
|
-
|
71
|
-
|
69
|
+
|
70
|
+
|
71
|
+
|
72
72
|
<dl>
|
73
73
|
<dt>Extended by:</dt>
|
74
74
|
<dd>T::Sig, <span class='object_link'><a href="Base.html" title="WorkOS::Base (module)">Base</a></span>, <span class='object_link'><a href="Client.html" title="WorkOS::Client (module)">Client</a></span></dd>
|
75
75
|
</dl>
|
76
|
-
|
77
|
-
|
78
|
-
|
79
|
-
|
80
76
|
|
81
|
-
|
82
77
|
|
83
|
-
|
78
|
+
|
79
|
+
|
80
|
+
|
81
|
+
|
82
|
+
|
83
|
+
|
84
84
|
<dl>
|
85
85
|
<dt>Defined in:</dt>
|
86
86
|
<dd>lib/workos/sso.rb</dd>
|
87
87
|
</dl>
|
88
|
-
|
88
|
+
|
89
89
|
</div>
|
90
90
|
|
91
91
|
<h2>Overview</h2><div class="docstring">
|
92
92
|
<div class="discussion">
|
93
|
-
|
94
|
-
<p>The SSO module provides convenience methods for working with the WorkOS SSO platform. You'll need a valid API key, a
|
93
|
+
|
94
|
+
<p>The SSO module provides convenience methods for working with the WorkOS SSO platform. You'll need a valid API key, a client ID, and to have created an SSO connection on your WorkOS dashboard.</p>
|
95
95
|
|
96
96
|
|
97
97
|
</div>
|
98
98
|
</div>
|
99
99
|
<div class="tags">
|
100
|
-
|
100
|
+
|
101
101
|
|
102
102
|
<p class="tag_title">See Also:</p>
|
103
103
|
<ul class="see">
|
104
|
-
|
104
|
+
|
105
105
|
<li><a href="https://docs.workos.com/sso/overview" target="_parent" title="https://docs.workos.com/sso/overview">https://docs.workos.com/sso/overview</a></li>
|
106
|
-
|
106
|
+
|
107
107
|
</ul>
|
108
108
|
|
109
109
|
</div>
|
110
|
-
|
110
|
+
|
111
111
|
<h2>
|
112
112
|
Constant Summary
|
113
113
|
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
114
114
|
</h2>
|
115
115
|
|
116
116
|
<dl class="constants">
|
117
|
-
|
117
|
+
|
118
118
|
<dt id="PROVIDERS-constant" class="">PROVIDERS =
|
119
|
-
|
119
|
+
|
120
120
|
</dt>
|
121
121
|
<dd><pre class="code"><span class='const'><span class='object_link'><a href="../WorkOS.html" title="WorkOS (module)">WorkOS</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Types.html" title="WorkOS::Types (module)">Types</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Types/Provider.html" title="WorkOS::Types::Provider (class)">Provider</a></span></span><span class='period'>.</span><span class='id identifier rubyid_values'>values</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:serialize</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
|
122
|
-
|
122
|
+
|
123
123
|
</dl>
|
124
|
-
|
124
|
+
|
125
125
|
|
126
126
|
|
127
127
|
|
@@ -129,147 +129,147 @@
|
|
129
129
|
|
130
130
|
|
131
131
|
<h2>Instance Attribute Summary</h2>
|
132
|
-
|
132
|
+
|
133
133
|
<h3 class="inherited">Attributes included from <span class='object_link'><a href="Base.html" title="WorkOS::Base (module)">Base</a></span></h3>
|
134
134
|
<p class="inherited"><span class='object_link'><a href="Base.html#key-instance_method" title="WorkOS::Base#key (method)">#key</a></span></p>
|
135
135
|
|
136
136
|
|
137
|
-
|
137
|
+
|
138
138
|
<h2>
|
139
139
|
Class Method Summary
|
140
140
|
<small><a href="#" class="summary_toggle">collapse</a></small>
|
141
141
|
</h2>
|
142
142
|
|
143
143
|
<ul class="summary">
|
144
|
-
|
144
|
+
|
145
145
|
<li class="public ">
|
146
146
|
<span class="summary_signature">
|
147
|
-
|
148
|
-
<a href="#authorization_url-class_method" title="authorization_url (class method)">.<strong>authorization_url</strong>(project_id:, redirect_uri:, domain: nil, provider: nil, state: {}) ⇒ String </a>
|
149
|
-
|
150
147
|
|
151
|
-
|
148
|
+
<a href="#authorization_url-class_method" title="authorization_url (class method)">.<strong>authorization_url</strong>(client_id:, redirect_uri:, domain: nil, provider: nil, state: {}) ⇒ String </a>
|
149
|
+
|
150
|
+
|
151
|
+
|
152
152
|
</span>
|
153
|
-
|
154
|
-
|
155
|
-
|
156
|
-
|
157
|
-
|
158
|
-
|
159
|
-
|
160
|
-
|
161
|
-
|
153
|
+
|
154
|
+
|
155
|
+
|
156
|
+
|
157
|
+
|
158
|
+
|
159
|
+
|
160
|
+
|
161
|
+
|
162
162
|
<span class="summary_desc"><div class='inline'>
|
163
163
|
<p>Generate an Oauth2 authorization URL where your users will authenticate using the configured SSO Identity Provider.</p>
|
164
164
|
</div></span>
|
165
|
-
|
165
|
+
|
166
166
|
</li>
|
167
167
|
|
168
|
-
|
168
|
+
|
169
169
|
<li class="public ">
|
170
170
|
<span class="summary_signature">
|
171
|
-
|
172
|
-
<a href="#profile-class_method" title="profile (class method)">.<strong>profile</strong>(code:, project_id:) ⇒ WorkOS::Profile </a>
|
173
|
-
|
174
171
|
|
175
|
-
|
172
|
+
<a href="#profile-class_method" title="profile (class method)">.<strong>profile</strong>(code:, client_id:) ⇒ WorkOS::Profile </a>
|
173
|
+
|
174
|
+
|
175
|
+
|
176
176
|
</span>
|
177
|
-
|
178
|
-
|
179
|
-
|
180
|
-
|
181
|
-
|
182
|
-
|
183
|
-
|
184
|
-
|
185
|
-
|
177
|
+
|
178
|
+
|
179
|
+
|
180
|
+
|
181
|
+
|
182
|
+
|
183
|
+
|
184
|
+
|
185
|
+
|
186
186
|
<span class="summary_desc"><div class='inline'>
|
187
187
|
<p>Fetch the profile details for the authenticated SSO user.</p>
|
188
188
|
</div></span>
|
189
|
-
|
189
|
+
|
190
190
|
</li>
|
191
191
|
|
192
|
-
|
192
|
+
|
193
193
|
<li class="public ">
|
194
194
|
<span class="summary_signature">
|
195
|
-
|
195
|
+
|
196
196
|
<a href="#promote_draft_connection-class_method" title="promote_draft_connection (class method)">.<strong>promote_draft_connection</strong>(token:) ⇒ Bool </a>
|
197
|
-
|
198
197
|
|
199
|
-
|
198
|
+
|
199
|
+
|
200
200
|
</span>
|
201
|
-
|
202
|
-
|
203
|
-
|
204
|
-
|
205
|
-
|
206
|
-
|
207
|
-
|
208
|
-
|
209
|
-
|
201
|
+
|
202
|
+
|
203
|
+
|
204
|
+
|
205
|
+
|
206
|
+
|
207
|
+
|
208
|
+
|
209
|
+
|
210
210
|
<span class="summary_desc"><div class='inline'>
|
211
211
|
<p>Promote a DraftConnection created via the WorkOS.js embed such that the Enterprise users can begin signing into your application.</p>
|
212
212
|
</div></span>
|
213
|
-
|
213
|
+
|
214
214
|
</li>
|
215
215
|
|
216
|
-
|
216
|
+
|
217
217
|
</ul>
|
218
|
-
|
219
218
|
|
220
219
|
|
221
|
-
|
222
|
-
|
223
|
-
|
224
|
-
|
225
|
-
|
226
|
-
|
227
|
-
|
228
|
-
|
220
|
+
|
221
|
+
|
222
|
+
|
223
|
+
|
224
|
+
|
225
|
+
|
226
|
+
|
227
|
+
|
228
|
+
|
229
229
|
<h3 class="inherited">Methods included from <span class='object_link'><a href="Client.html" title="WorkOS::Client (module)">Client</a></span></h3>
|
230
230
|
<p class="inherited"><span class='object_link'><a href="Client.html#client-instance_method" title="WorkOS::Client#client (method)">client</a></span>, <span class='object_link'><a href="Client.html#execute_request-instance_method" title="WorkOS::Client#execute_request (method)">execute_request</a></span>, <span class='object_link'><a href="Client.html#handle_error_response-instance_method" title="WorkOS::Client#handle_error_response (method)">handle_error_response</a></span>, <span class='object_link'><a href="Client.html#post_request-instance_method" title="WorkOS::Client#post_request (method)">post_request</a></span>, <span class='object_link'><a href="Client.html#user_agent-instance_method" title="WorkOS::Client#user_agent (method)">user_agent</a></span></p>
|
231
231
|
|
232
|
-
|
233
|
-
|
234
|
-
|
235
|
-
|
236
|
-
|
237
|
-
|
238
|
-
|
239
|
-
|
240
|
-
|
241
|
-
|
232
|
+
|
233
|
+
|
234
|
+
|
235
|
+
|
236
|
+
|
237
|
+
|
238
|
+
|
239
|
+
|
240
|
+
|
241
|
+
|
242
242
|
|
243
243
|
<div id="class_method_details" class="method_details_list">
|
244
244
|
<h2>Class Method Details</h2>
|
245
245
|
|
246
|
-
|
246
|
+
|
247
247
|
<div class="method_details first">
|
248
248
|
<h3 class="signature first" id="authorization_url-class_method">
|
249
|
-
|
250
|
-
.<strong>authorization_url</strong>(project_id:, redirect_uri:, domain: nil, provider: nil, state: {}) ⇒ <tt>String</tt>
|
251
|
-
|
252
249
|
|
253
|
-
|
250
|
+
.<strong>authorization_url</strong>(client_id:, redirect_uri:, domain: nil, provider: nil, state: {}) ⇒ <tt>String</tt>
|
251
|
+
|
252
|
+
|
253
|
+
|
254
|
+
|
254
255
|
|
255
|
-
|
256
256
|
</h3><div class="docstring">
|
257
257
|
<div class="discussion">
|
258
|
-
|
258
|
+
|
259
259
|
<p>Generate an Oauth2 authorization URL where your users will authenticate using the configured SSO Identity Provider.</p>
|
260
260
|
|
261
261
|
|
262
262
|
</div>
|
263
263
|
</div>
|
264
264
|
<div class="tags">
|
265
|
-
|
265
|
+
|
266
266
|
<div class="examples">
|
267
267
|
<p class="tag_title">Examples:</p>
|
268
|
-
|
269
|
-
|
268
|
+
|
269
|
+
|
270
270
|
<pre class="example code"><code>WorkOS::SSO.authorization_url(
|
271
271
|
domain: 'acme.com',
|
272
|
-
|
272
|
+
client_id: 'project_01DG5TGK363GRVXP3ZS40WNGEZ',
|
273
273
|
redirect_uri: 'https://workos.com/callback',
|
274
274
|
state: {
|
275
275
|
next_page: '/docs'
|
@@ -280,111 +280,111 @@
|
|
280
280
|
"&client_id=project_01DG5TGK363GRVXP3ZS40WNGEZ" \
|
281
281
|
"&redirect_uri=https%3A%2F%2Fworkos.com%2Fcallback&" \
|
282
282
|
"response_type=code&state=%7B%3Anext_page%3D%3E%22%2Fdocs%22%7D"</code></pre>
|
283
|
-
|
283
|
+
|
284
284
|
</div>
|
285
285
|
<p class="tag_title">Parameters:</p>
|
286
286
|
<ul class="param">
|
287
|
-
|
287
|
+
|
288
288
|
<li>
|
289
|
-
|
289
|
+
|
290
290
|
<span class='name'>domain</span>
|
291
|
-
|
292
|
-
|
291
|
+
|
292
|
+
|
293
293
|
<span class='type'>(<tt>String</tt>)</span>
|
294
|
-
|
295
|
-
|
294
|
+
|
295
|
+
|
296
296
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
297
|
-
|
298
|
-
|
297
|
+
|
298
|
+
|
299
299
|
—
|
300
300
|
<div class='inline'>
|
301
301
|
<p>The domain for the relevant SSO Connection configured on your WorkOS dashboard. One of provider or domain is required</p>
|
302
302
|
</div>
|
303
|
-
|
303
|
+
|
304
304
|
</li>
|
305
|
-
|
305
|
+
|
306
306
|
<li>
|
307
|
-
|
307
|
+
|
308
308
|
<span class='name'>provider</span>
|
309
|
-
|
310
|
-
|
309
|
+
|
310
|
+
|
311
311
|
<span class='type'>(<tt>String</tt>)</span>
|
312
|
-
|
313
|
-
|
312
|
+
|
313
|
+
|
314
314
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
315
|
-
|
316
|
-
|
315
|
+
|
316
|
+
|
317
317
|
—
|
318
318
|
<div class='inline'>
|
319
319
|
<p>A provider name for an Identity Provider configured on your WorkOS dashboard. Only 'Google' is supported.</p>
|
320
320
|
</div>
|
321
|
-
|
321
|
+
|
322
322
|
</li>
|
323
|
-
|
323
|
+
|
324
324
|
<li>
|
325
|
-
|
326
|
-
<span class='name'>
|
327
|
-
|
328
|
-
|
325
|
+
|
326
|
+
<span class='name'>client_id</span>
|
327
|
+
|
328
|
+
|
329
329
|
<span class='type'>(<tt>String</tt>)</span>
|
330
|
-
|
331
|
-
|
332
|
-
|
330
|
+
|
331
|
+
|
332
|
+
|
333
333
|
—
|
334
334
|
<div class='inline'>
|
335
|
-
<p>The WorkOS
|
335
|
+
<p>The WorkOS client ID for the environment where you've configured your SSO connection.</p>
|
336
336
|
</div>
|
337
|
-
|
337
|
+
|
338
338
|
</li>
|
339
|
-
|
339
|
+
|
340
340
|
<li>
|
341
|
-
|
341
|
+
|
342
342
|
<span class='name'>redirect_uri</span>
|
343
|
-
|
344
|
-
|
343
|
+
|
344
|
+
|
345
345
|
<span class='type'>(<tt>String</tt>)</span>
|
346
|
-
|
347
|
-
|
348
|
-
|
346
|
+
|
347
|
+
|
348
|
+
|
349
349
|
—
|
350
350
|
<div class='inline'>
|
351
351
|
<p>The URI where users are directed after completing the authentication step. Must match a configured redirect URI on your WorkOS dashboard.</p>
|
352
352
|
</div>
|
353
|
-
|
353
|
+
|
354
354
|
</li>
|
355
|
-
|
355
|
+
|
356
356
|
<li>
|
357
|
-
|
357
|
+
|
358
358
|
<span class='name'>state</span>
|
359
|
-
|
360
|
-
|
359
|
+
|
360
|
+
|
361
361
|
<span class='type'>(<tt>Hash</tt>)</span>
|
362
|
-
|
363
|
-
|
362
|
+
|
363
|
+
|
364
364
|
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
365
|
-
|
366
|
-
|
365
|
+
|
366
|
+
|
367
367
|
—
|
368
368
|
<div class='inline'>
|
369
369
|
<p>An aribtrary state object that is preserved and available to the client in the response.</p>
|
370
370
|
</div>
|
371
|
-
|
371
|
+
|
372
372
|
</li>
|
373
|
-
|
373
|
+
|
374
374
|
</ul>
|
375
375
|
|
376
376
|
<p class="tag_title">Returns:</p>
|
377
377
|
<ul class="return">
|
378
|
-
|
378
|
+
|
379
379
|
<li>
|
380
|
-
|
381
|
-
|
380
|
+
|
381
|
+
|
382
382
|
<span class='type'>(<tt>String</tt>)</span>
|
383
|
-
|
384
|
-
|
385
|
-
|
383
|
+
|
384
|
+
|
385
|
+
|
386
386
|
</li>
|
387
|
-
|
387
|
+
|
388
388
|
</ul>
|
389
389
|
|
390
390
|
</div><table class="source_code">
|
@@ -414,12 +414,12 @@
|
|
414
414
|
<pre class="code"><span class="info file"># File 'lib/workos/sso.rb', line 62</span>
|
415
415
|
|
416
416
|
<span class='kw'>def</span> <span class='id identifier rubyid_authorization_url'>authorization_url</span><span class='lparen'>(</span>
|
417
|
-
<span class='label'>
|
417
|
+
<span class='label'>client_id:</span><span class='comma'>,</span> <span class='label'>redirect_uri:</span><span class='comma'>,</span> <span class='label'>domain:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>provider:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>state:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
418
418
|
<span class='rparen'>)</span>
|
419
419
|
<span class='id identifier rubyid_validate_domain_and_provider'>validate_domain_and_provider</span><span class='lparen'>(</span><span class='label'>provider:</span> <span class='id identifier rubyid_provider'>provider</span><span class='comma'>,</span> <span class='label'>domain:</span> <span class='id identifier rubyid_domain'>domain</span><span class='rparen'>)</span>
|
420
420
|
|
421
421
|
<span class='id identifier rubyid_query'>query</span> <span class='op'>=</span> <span class='const'>URI</span><span class='period'>.</span><span class='id identifier rubyid_encode_www_form'>encode_www_form</span><span class='lparen'>(</span><span class='lbrace'>{</span>
|
422
|
-
<span class='label'>client_id:</span> <span class='id identifier rubyid_project_id'>
|
422
|
+
<span class='label'>client_id:</span> <span class='id identifier rubyid_project_id'>client_id</span><span class='comma'>,</span>
|
423
423
|
<span class='label'>redirect_uri:</span> <span class='id identifier rubyid_redirect_uri'>redirect_uri</span><span class='comma'>,</span>
|
424
424
|
<span class='label'>response_type:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>code</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
425
425
|
<span class='label'>state:</span> <span class='id identifier rubyid_state'>state</span><span class='comma'>,</span>
|
@@ -433,33 +433,33 @@
|
|
433
433
|
</tr>
|
434
434
|
</table>
|
435
435
|
</div>
|
436
|
-
|
436
|
+
|
437
437
|
<div class="method_details ">
|
438
438
|
<h3 class="signature " id="profile-class_method">
|
439
|
-
|
440
|
-
.<strong>profile</strong>(code:, project_id:) ⇒ <tt><span class='object_link'><a href="Profile.html" title="WorkOS::Profile (class)">WorkOS::Profile</a></span></tt>
|
441
|
-
|
442
439
|
|
443
|
-
|
440
|
+
.<strong>profile</strong>(code:, client_id:) ⇒ <tt><span class='object_link'><a href="Profile.html" title="WorkOS::Profile (class)">WorkOS::Profile</a></span></tt>
|
441
|
+
|
442
|
+
|
443
|
+
|
444
|
+
|
444
445
|
|
445
|
-
|
446
446
|
</h3><div class="docstring">
|
447
447
|
<div class="discussion">
|
448
|
-
|
448
|
+
|
449
449
|
<p>Fetch the profile details for the authenticated SSO user.</p>
|
450
450
|
|
451
451
|
|
452
452
|
</div>
|
453
453
|
</div>
|
454
454
|
<div class="tags">
|
455
|
-
|
455
|
+
|
456
456
|
<div class="examples">
|
457
457
|
<p class="tag_title">Examples:</p>
|
458
|
-
|
459
|
-
|
458
|
+
|
459
|
+
|
460
460
|
<pre class="example code"><code>WorkOS::SSO.profile(
|
461
461
|
code: 'acme.com',
|
462
|
-
|
462
|
+
client_id: 'project_01DG5TGK363GRVXP3ZS40WNGEZ'
|
463
463
|
)
|
464
464
|
=> #<WorkOS::Profile:0x00007fb6e4193d20
|
465
465
|
@id="prof_01DRA1XNSJDZ19A31F183ECQW5",
|
@@ -470,57 +470,57 @@
|
|
470
470
|
@idp_id="00u1klkowm8EGah2H357",
|
471
471
|
@access_token="01DVX6QBS3EG6FHY2ESAA5Q65X"
|
472
472
|
></code></pre>
|
473
|
-
|
473
|
+
|
474
474
|
</div>
|
475
475
|
<p class="tag_title">Parameters:</p>
|
476
476
|
<ul class="param">
|
477
|
-
|
477
|
+
|
478
478
|
<li>
|
479
|
-
|
479
|
+
|
480
480
|
<span class='name'>code</span>
|
481
|
-
|
482
|
-
|
481
|
+
|
482
|
+
|
483
483
|
<span class='type'>(<tt>String</tt>)</span>
|
484
|
-
|
485
|
-
|
486
|
-
|
484
|
+
|
485
|
+
|
486
|
+
|
487
487
|
—
|
488
488
|
<div class='inline'>
|
489
489
|
<p>The authorization code provided in the callback URL</p>
|
490
490
|
</div>
|
491
|
-
|
491
|
+
|
492
492
|
</li>
|
493
|
-
|
493
|
+
|
494
494
|
<li>
|
495
|
-
|
496
|
-
<span class='name'>
|
497
|
-
|
498
|
-
|
495
|
+
|
496
|
+
<span class='name'>client_id</span>
|
497
|
+
|
498
|
+
|
499
499
|
<span class='type'>(<tt>String</tt>)</span>
|
500
|
-
|
501
|
-
|
502
|
-
|
500
|
+
|
501
|
+
|
502
|
+
|
503
503
|
—
|
504
504
|
<div class='inline'>
|
505
|
-
<p>The WorkOS
|
505
|
+
<p>The WorkOS client ID for the environment where you've configured your SSO connection</p>
|
506
506
|
</div>
|
507
|
-
|
507
|
+
|
508
508
|
</li>
|
509
|
-
|
509
|
+
|
510
510
|
</ul>
|
511
511
|
|
512
512
|
<p class="tag_title">Returns:</p>
|
513
513
|
<ul class="return">
|
514
|
-
|
514
|
+
|
515
515
|
<li>
|
516
|
-
|
517
|
-
|
516
|
+
|
517
|
+
|
518
518
|
<span class='type'>(<tt><span class='object_link'><a href="Profile.html" title="WorkOS::Profile (class)">WorkOS::Profile</a></span></tt>)</span>
|
519
|
-
|
520
|
-
|
521
|
-
|
519
|
+
|
520
|
+
|
521
|
+
|
522
522
|
</li>
|
523
|
-
|
523
|
+
|
524
524
|
</ul>
|
525
525
|
|
526
526
|
</div><table class="source_code">
|
@@ -546,9 +546,9 @@
|
|
546
546
|
<td>
|
547
547
|
<pre class="code"><span class="info file"># File 'lib/workos/sso.rb', line 108</span>
|
548
548
|
|
549
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_profile'>profile</span><span class='lparen'>(</span><span class='label'>code:</span><span class='comma'>,</span> <span class='label'>
|
549
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_profile'>profile</span><span class='lparen'>(</span><span class='label'>code:</span><span class='comma'>,</span> <span class='label'>client_id:</span><span class='rparen'>)</span>
|
550
550
|
<span class='id identifier rubyid_body'>body</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
551
|
-
<span class='label'>client_id:</span> <span class='id identifier rubyid_project_id'>
|
551
|
+
<span class='label'>client_id:</span> <span class='id identifier rubyid_project_id'>client_id</span><span class='comma'>,</span>
|
552
552
|
<span class='label'>client_secret:</span> <span class='const'><span class='object_link'><a href="../WorkOS.html" title="WorkOS (module)">WorkOS</a></span></span><span class='period'>.</span><span class='id identifier rubyid_key!'><span class='object_link'><a href="../WorkOS.html#key!-class_method" title="WorkOS.key! (method)">key!</a></span></span><span class='comma'>,</span>
|
553
553
|
<span class='label'>grant_type:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>authorization_code</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
554
554
|
<span class='label'>code:</span> <span class='id identifier rubyid_code'>code</span><span class='comma'>,</span>
|
@@ -563,19 +563,19 @@
|
|
563
563
|
</tr>
|
564
564
|
</table>
|
565
565
|
</div>
|
566
|
-
|
566
|
+
|
567
567
|
<div class="method_details ">
|
568
568
|
<h3 class="signature " id="promote_draft_connection-class_method">
|
569
|
-
|
570
|
-
.<strong>promote_draft_connection</strong>(token:) ⇒ <tt>Bool</tt>
|
571
|
-
|
572
569
|
|
573
|
-
|
570
|
+
.<strong>promote_draft_connection</strong>(token:) ⇒ <tt>Bool</tt>
|
571
|
+
|
572
|
+
|
573
|
+
|
574
|
+
|
574
575
|
|
575
|
-
|
576
576
|
</h3><div class="docstring">
|
577
577
|
<div class="discussion">
|
578
|
-
|
578
|
+
|
579
579
|
<p>Promote a DraftConnection created via the WorkOS.js embed such that the Enterprise users can begin signing into your application.</p>
|
580
580
|
|
581
581
|
<p>you by the WorkOS.js embed</p>
|
@@ -584,63 +584,63 @@
|
|
584
584
|
</div>
|
585
585
|
</div>
|
586
586
|
<div class="tags">
|
587
|
-
|
587
|
+
|
588
588
|
<div class="examples">
|
589
589
|
<p class="tag_title">Examples:</p>
|
590
|
-
|
591
|
-
|
590
|
+
|
591
|
+
|
592
592
|
<pre class="example code"><code>WorkOS::SSO.promote_draft_connection(
|
593
593
|
token: 'draft_conn_429u59js',
|
594
594
|
)
|
595
595
|
=> true</code></pre>
|
596
|
-
|
596
|
+
|
597
597
|
</div>
|
598
598
|
<p class="tag_title">Parameters:</p>
|
599
599
|
<ul class="param">
|
600
|
-
|
600
|
+
|
601
601
|
<li>
|
602
|
-
|
602
|
+
|
603
603
|
<span class='name'>token</span>
|
604
|
-
|
605
|
-
|
604
|
+
|
605
|
+
|
606
606
|
<span class='type'>(<tt>String</tt>)</span>
|
607
|
-
|
608
|
-
|
609
|
-
|
607
|
+
|
608
|
+
|
609
|
+
|
610
610
|
—
|
611
611
|
<div class='inline'>
|
612
612
|
<p>The draft connection token that's been provided to</p>
|
613
613
|
</div>
|
614
|
-
|
614
|
+
|
615
615
|
</li>
|
616
|
-
|
616
|
+
|
617
617
|
</ul>
|
618
618
|
|
619
619
|
<p class="tag_title">Returns:</p>
|
620
620
|
<ul class="return">
|
621
|
-
|
621
|
+
|
622
622
|
<li>
|
623
|
-
|
624
|
-
|
623
|
+
|
624
|
+
|
625
625
|
<span class='type'>(<tt>Bool</tt>)</span>
|
626
|
-
|
627
|
-
|
628
|
-
|
626
|
+
|
627
|
+
|
628
|
+
|
629
629
|
—
|
630
630
|
<div class='inline'><ul><li>
|
631
631
|
<p>returns `true` if successful, `false` otherwise.</p>
|
632
632
|
</li></ul>
|
633
633
|
</div>
|
634
|
-
|
634
|
+
|
635
635
|
</li>
|
636
|
-
|
636
|
+
|
637
637
|
</ul>
|
638
638
|
|
639
639
|
<p class="tag_title">See Also:</p>
|
640
640
|
<ul class="see">
|
641
|
-
|
641
|
+
|
642
642
|
<li><a href="https://github.com/workos-inc/ruby-idp-link-example" target="_parent" title="https://github.com/workos-inc/ruby-idp-link-example">https://github.com/workos-inc/ruby-idp-link-example</a></li>
|
643
|
-
|
643
|
+
|
644
644
|
</ul>
|
645
645
|
|
646
646
|
</div><table class="source_code">
|
@@ -675,7 +675,7 @@
|
|
675
675
|
</tr>
|
676
676
|
</table>
|
677
677
|
</div>
|
678
|
-
|
678
|
+
|
679
679
|
</div>
|
680
680
|
|
681
681
|
</div>
|
@@ -688,4 +688,4 @@
|
|
688
688
|
|
689
689
|
</div>
|
690
690
|
</body>
|
691
|
-
</html>
|
691
|
+
</html>
|