Class: WorkOS::SSO
- Inherits:
-
Object
- Object
- WorkOS::SSO
- Defined in:
- lib/workos/sso.rb
Defined Under Namespace
Classes: CreateProtocolOptionsOIDC, CreateProtocolOptionsSAML, PatchProtocolOptionsOIDC, PatchProtocolOptionsSAML
Instance Method Summary collapse
-
#authorize_logout(profile_id:, request_options: {}) ⇒ WorkOS::SSOLogoutAuthorizeResponse
Logout Authorize.
-
#build_logout_url(token:) ⇒ Object
H17 — Build the SSO logout redirect URL (no HTTP call).
-
#create_connection(organization_id:, protocol_options:, name: nil, external_id: nil, connection_type: nil, attribute_maps: nil, request_options: {}) ⇒ WorkOS::Connection
Create a Connection.
-
#create_connection_saml_idp_signing_cert(connection_id:, value:, request_options: {}) ⇒ WorkOS::SAMLIdpSigningCertificate
Create an IdP signing certificate.
-
#create_connection_saml_sp_encryption_cert(connection_id:, request_options: {}) ⇒ WorkOS::SAMLSpEncryptionCertificate
Create an SP encryption certificate.
-
#create_connection_saml_sp_signing_cert(connection_id:, request_options: {}) ⇒ WorkOS::SAMLSpSigningCertificate
Create an SP signing certificate.
-
#delete_connection(id:, request_options: {}) ⇒ void
Delete a Connection.
-
#delete_connection_saml_idp_signing_cert(connection_id:, certificate_id:, request_options: {}) ⇒ void
Delete an IdP signing certificate.
-
#delete_connection_saml_sp_encryption_cert(connection_id:, certificate_id:, request_options: {}) ⇒ void
Delete an SP encryption certificate.
-
#delete_connection_saml_sp_signing_cert(connection_id:, certificate_id:, request_options: {}) ⇒ void
Delete the SP signing certificate.
-
#get_authorization_url(redirect_uri:, provider_scopes: nil, provider_query_params: nil, client_id: nil, domain: nil, provider: nil, state: nil, connection: nil, organization: nil, domain_hint: nil, login_hint: nil, nonce: nil, prompt: nil) ⇒ String
Initiate SSO Builds the URL client-side; no HTTP request is made.
-
#get_authorization_url_with_pkce(redirect_uri:, client_id: nil, **opts) ⇒ Object
H15 — SSO authorization URL with auto-generated PKCE pair + state.
-
#get_connection(id:, request_options: {}) ⇒ WorkOS::Connection
Get a Connection.
-
#get_logout_url(token:) ⇒ String
Logout Redirect Builds the URL client-side; no HTTP request is made.
-
#get_profile(request_options: {}) ⇒ WorkOS::Profile
Get a User Profile.
-
#get_profile_and_token(code: nil, code_verifier: nil, subject_token: nil, subject_token_type: nil, organization_id: nil, request_options: {}) ⇒ WorkOS::SSOTokenResponse
Get a Profile and Token.
-
#get_profile_and_token_with_pkce(code:, code_verifier:, client_id: nil, request_options: {}) ⇒ Object
H16 — Exchange an SSO authorization code for a profile/token, with PKCE support for public clients (no client_secret).
-
#initialize(client) ⇒ SSO
constructor
A new instance of SSO.
-
#list_connection_saml_idp_signing_certs(connection_id:, request_options: {}) ⇒ WorkOS::SAMLIdpSigningCertificateList
List IdP signing certificates.
-
#list_connection_saml_sp_encryption_certs(connection_id:, request_options: {}) ⇒ WorkOS::SAMLSpEncryptionCertificateList
List SP encryption certificates.
-
#list_connection_saml_sp_signing_cert(connection_id:, request_options: {}) ⇒ WorkOS::SAMLSpSigningCertificate
Get the SP signing certificate.
-
#list_connections(before: nil, after: nil, limit: 10, order: "desc", connection_type: nil, domain: nil, organization_id: nil, search: nil, state: nil, request_options: {}) ⇒ WorkOS::Types::ListStruct<WorkOS::Connection>
List Connections.
-
#update_connection(id:, name: nil, external_id: WorkOS::OMIT, connection_type: nil, attribute_maps: nil, protocol_options: nil, request_options: {}) ⇒ WorkOS::Connection
Update a Connection.
Constructor Details
#initialize(client) ⇒ SSO
Returns a new instance of SSO.
34 35 36 |
# File 'lib/workos/sso.rb', line 34 def initialize(client) @client = client end |
Instance Method Details
#authorize_logout(profile_id:, request_options: {}) ⇒ WorkOS::SSOLogoutAuthorizeResponse
Logout Authorize
478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 |
# File 'lib/workos/sso.rb', line 478 def ( profile_id:, request_options: {} ) body = { "profile_id" => profile_id } response = @client.request( method: :post, path: "/sso/logout/authorize", auth: true, body: body, request_options: ) result = WorkOS::SSOLogoutAuthorizeResponse.new(response.body) result.last_response = WorkOS::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"]) result end |
#build_logout_url(token:) ⇒ Object
H17 — Build the SSO logout redirect URL (no HTTP call).
587 588 589 |
# File 'lib/workos/sso.rb', line 587 def build_logout_url(token:) build_url("/sso/logout", {"token" => token}) end |
#create_connection(organization_id:, protocol_options:, name: nil, external_id: nil, connection_type: nil, attribute_maps: nil, request_options: {}) ⇒ WorkOS::Connection
Create a Connection
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 |
# File 'lib/workos/sso.rb', line 111 def create_connection( organization_id:, protocol_options:, name: nil, external_id: nil, connection_type: nil, attribute_maps: nil, request_options: {} ) body = { "organization_id" => organization_id, "name" => name, "external_id" => external_id, "connection_type" => connection_type, "attribute_maps" => attribute_maps }.compact case when WorkOS::SSO::CreateProtocolOptionsSAML body["saml_options"] = . when WorkOS::SSO::CreateProtocolOptionsOIDC body["oidc_options"] = . else raise ArgumentError, "expected protocol_options to be one of: WorkOS::SSO::CreateProtocolOptionsSAML, WorkOS::SSO::CreateProtocolOptionsOIDC, got #{.class}" end response = @client.request( method: :post, path: "/connections", auth: true, body: body, request_options: ) result = WorkOS::Connection.new(response.body) result.last_response = WorkOS::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"]) result end |
#create_connection_saml_idp_signing_cert(connection_id:, value:, request_options: {}) ⇒ WorkOS::SAMLIdpSigningCertificate
Create an IdP signing certificate
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 |
# File 'lib/workos/sso.rb', line 171 def create_connection_saml_idp_signing_cert( connection_id:, value:, request_options: {} ) body = { "value" => value } response = @client.request( method: :post, path: "/connections/#{WorkOS::Util.encode_path(connection_id)}/saml_idp_signing_certs", auth: true, body: body, request_options: ) result = WorkOS::SAMLIdpSigningCertificate.new(response.body) result.last_response = WorkOS::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"]) result end |
#create_connection_saml_sp_encryption_cert(connection_id:, request_options: {}) ⇒ WorkOS::SAMLSpEncryptionCertificate
Create an SP encryption certificate
233 234 235 236 237 238 239 240 241 242 243 244 245 246 |
# File 'lib/workos/sso.rb', line 233 def create_connection_saml_sp_encryption_cert( connection_id:, request_options: {} ) response = @client.request( method: :post, path: "/connections/#{WorkOS::Util.encode_path(connection_id)}/saml_sp_encryption_certs", auth: true, request_options: ) result = WorkOS::SAMLSpEncryptionCertificate.new(response.body) result.last_response = WorkOS::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"]) result end |
#create_connection_saml_sp_signing_cert(connection_id:, request_options: {}) ⇒ WorkOS::SAMLSpSigningCertificate
Create an SP signing certificate
290 291 292 293 294 295 296 297 298 299 300 301 302 303 |
# File 'lib/workos/sso.rb', line 290 def create_connection_saml_sp_signing_cert( connection_id:, request_options: {} ) response = @client.request( method: :post, path: "/connections/#{WorkOS::Util.encode_path(connection_id)}/saml_sp_signing_cert", auth: true, request_options: ) result = WorkOS::SAMLSpSigningCertificate.new(response.body) result.last_response = WorkOS::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"]) result end |
#delete_connection(id:, request_options: {}) ⇒ void
This method returns an undefined value.
Delete a Connection
393 394 395 396 397 398 399 400 401 402 403 404 |
# File 'lib/workos/sso.rb', line 393 def delete_connection( id:, request_options: {} ) @client.request( method: :delete, path: "/connections/#{WorkOS::Util.encode_path(id)}", auth: true, request_options: ) nil end |
#delete_connection_saml_idp_signing_cert(connection_id:, certificate_id:, request_options: {}) ⇒ void
This method returns an undefined value.
Delete an IdP signing certificate
196 197 198 199 200 201 202 203 204 205 206 207 208 |
# File 'lib/workos/sso.rb', line 196 def delete_connection_saml_idp_signing_cert( connection_id:, certificate_id:, request_options: {} ) @client.request( method: :delete, path: "/connections/#{WorkOS::Util.encode_path(connection_id)}/saml_idp_signing_certs/#{WorkOS::Util.encode_path(certificate_id)}", auth: true, request_options: ) nil end |
#delete_connection_saml_sp_encryption_cert(connection_id:, certificate_id:, request_options: {}) ⇒ void
This method returns an undefined value.
Delete an SP encryption certificate
253 254 255 256 257 258 259 260 261 262 263 264 265 |
# File 'lib/workos/sso.rb', line 253 def delete_connection_saml_sp_encryption_cert( connection_id:, certificate_id:, request_options: {} ) @client.request( method: :delete, path: "/connections/#{WorkOS::Util.encode_path(connection_id)}/saml_sp_encryption_certs/#{WorkOS::Util.encode_path(certificate_id)}", auth: true, request_options: ) nil end |
#delete_connection_saml_sp_signing_cert(connection_id:, certificate_id:, request_options: {}) ⇒ void
This method returns an undefined value.
Delete the SP signing certificate
310 311 312 313 314 315 316 317 318 319 320 321 322 |
# File 'lib/workos/sso.rb', line 310 def delete_connection_saml_sp_signing_cert( connection_id:, certificate_id:, request_options: {} ) @client.request( method: :delete, path: "/connections/#{WorkOS::Util.encode_path(connection_id)}/saml_sp_signing_cert/#{WorkOS::Util.encode_path(certificate_id)}", auth: true, request_options: ) nil end |
#get_authorization_url(redirect_uri:, provider_scopes: nil, provider_query_params: nil, client_id: nil, domain: nil, provider: nil, state: nil, connection: nil, organization: nil, domain_hint: nil, login_hint: nil, nonce: nil, prompt: nil) ⇒ String
Initiate SSO Builds the URL client-side; no HTTP request is made.
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 |
# File 'lib/workos/sso.rb', line 422 def ( redirect_uri:, provider_scopes: nil, provider_query_params: nil, client_id: nil, domain: nil, provider: nil, state: nil, connection: nil, organization: nil, domain_hint: nil, login_hint: nil, nonce: nil, prompt: nil ) params = { "provider_scopes" => provider_scopes, "provider_query_params" => provider_query_params, "client_id" => client_id, "domain" => domain, "provider" => provider, "redirect_uri" => redirect_uri, "state" => state, "connection" => connection, "organization" => organization, "domain_hint" => domain_hint, "login_hint" => login_hint, "nonce" => nonce, "prompt" => prompt }.compact params["provider_scopes"] = provider_scopes.join(",") unless provider_scopes.nil? params["provider_query_params"] = JSON.generate(provider_query_params) unless provider_query_params.nil? params["response_type"] = "code" params["client_id"] = @client.client_id if !params.key?("client_id") && !@client.client_id.nil? uri = URI.join(@client.base_url, "/sso/authorize") uri.query = URI.encode_www_form(params) unless params.empty? uri.to_s end |
#get_authorization_url_with_pkce(redirect_uri:, client_id: nil, **opts) ⇒ Object
H15 — SSO authorization URL with auto-generated PKCE pair + state. Returns [url, code_verifier, state].
558 559 560 561 562 563 564 565 566 567 568 569 |
# File 'lib/workos/sso.rb', line 558 def (redirect_uri:, client_id: nil, **opts) pair = WorkOS::PKCE.generate_pair state = opts.delete(:state) || WorkOS::PKCE.generate_code_verifier url = ( redirect_uri: redirect_uri, client_id: client_id, state: state, **opts ) url = append_query(url, {"code_challenge" => pair[:code_challenge], "code_challenge_method" => "S256"}) [url, pair[:code_verifier], state] end |
#get_connection(id:, request_options: {}) ⇒ WorkOS::Connection
Get a Connection
328 329 330 331 332 333 334 335 336 337 338 339 340 341 |
# File 'lib/workos/sso.rb', line 328 def get_connection( id:, request_options: {} ) response = @client.request( method: :get, path: "/connections/#{WorkOS::Util.encode_path(id)}", auth: true, request_options: ) result = WorkOS::Connection.new(response.body) result.last_response = WorkOS::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"]) result end |
#get_logout_url(token:) ⇒ String
Logout Redirect Builds the URL client-side; no HTTP request is made.
465 466 467 468 469 470 471 472 |
# File 'lib/workos/sso.rb', line 465 def get_logout_url(token:) params = { "token" => token } uri = URI.join(@client.base_url, "/sso/logout") uri.query = URI.encode_www_form(params) unless params.empty? uri.to_s end |
#get_profile(request_options: {}) ⇒ WorkOS::Profile
Get a User Profile
500 501 502 503 504 505 506 507 508 509 510 |
# File 'lib/workos/sso.rb', line 500 def get_profile(request_options: {}) response = @client.request( method: :get, path: "/sso/profile", auth: true, request_options: ) result = WorkOS::Profile.new(response.body) result.last_response = WorkOS::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"]) result end |
#get_profile_and_token(code: nil, code_verifier: nil, subject_token: nil, subject_token_type: nil, organization_id: nil, request_options: {}) ⇒ WorkOS::SSOTokenResponse
Get a Profile and Token
520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 |
# File 'lib/workos/sso.rb', line 520 def get_profile_and_token( code: nil, code_verifier: nil, subject_token: nil, subject_token_type: nil, organization_id: nil, request_options: {} ) body = { "grant_type" => "authorization_code", "client_id" => [:client_id] || @client.client_id, "client_secret" => [:api_key] || @client.api_key, "code" => code, "code_verifier" => code_verifier, "subject_token" => subject_token, "subject_token_type" => subject_token_type, "organization_id" => organization_id }.compact response = @client.request( method: :post, path: "/sso/token", auth: true, body: body, request_options: ) result = WorkOS::SSOTokenResponse.new(response.body) result.last_response = WorkOS::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"]) result end |
#get_profile_and_token_with_pkce(code:, code_verifier:, client_id: nil, request_options: {}) ⇒ Object
H16 — Exchange an SSO authorization code for a profile/token, with PKCE support for public clients (no client_secret).
573 574 575 576 577 578 579 580 581 582 583 584 |
# File 'lib/workos/sso.rb', line 573 def get_profile_and_token_with_pkce(code:, code_verifier:, client_id: nil, request_options: {}) cid = client_id || @client.client_id raise ArgumentError, "client_id is required" if cid.nil? || cid.empty? body = { "grant_type" => "authorization_code", "client_id" => cid, "code" => code, "code_verifier" => code_verifier } response = @client.request(method: :post, path: "/sso/token", auth: false, body: body, request_options: ) WorkOS::SSOTokenResponse.new(response.body) end |
#list_connection_saml_idp_signing_certs(connection_id:, request_options: {}) ⇒ WorkOS::SAMLIdpSigningCertificateList
List IdP signing certificates
151 152 153 154 155 156 157 158 159 160 161 162 163 164 |
# File 'lib/workos/sso.rb', line 151 def list_connection_saml_idp_signing_certs( connection_id:, request_options: {} ) response = @client.request( method: :get, path: "/connections/#{WorkOS::Util.encode_path(connection_id)}/saml_idp_signing_certs", auth: true, request_options: ) result = WorkOS::SAMLIdpSigningCertificateList.new(response.body) result.last_response = WorkOS::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"]) result end |
#list_connection_saml_sp_encryption_certs(connection_id:, request_options: {}) ⇒ WorkOS::SAMLSpEncryptionCertificateList
List SP encryption certificates
214 215 216 217 218 219 220 221 222 223 224 225 226 227 |
# File 'lib/workos/sso.rb', line 214 def list_connection_saml_sp_encryption_certs( connection_id:, request_options: {} ) response = @client.request( method: :get, path: "/connections/#{WorkOS::Util.encode_path(connection_id)}/saml_sp_encryption_certs", auth: true, request_options: ) result = WorkOS::SAMLSpEncryptionCertificateList.new(response.body) result.last_response = WorkOS::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"]) result end |
#list_connection_saml_sp_signing_cert(connection_id:, request_options: {}) ⇒ WorkOS::SAMLSpSigningCertificate
Get the SP signing certificate
271 272 273 274 275 276 277 278 279 280 281 282 283 284 |
# File 'lib/workos/sso.rb', line 271 def list_connection_saml_sp_signing_cert( connection_id:, request_options: {} ) response = @client.request( method: :get, path: "/connections/#{WorkOS::Util.encode_path(connection_id)}/saml_sp_signing_cert", auth: true, request_options: ) result = WorkOS::SAMLSpSigningCertificate.new(response.body) result.last_response = WorkOS::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"]) result end |
#list_connections(before: nil, after: nil, limit: 10, order: "desc", connection_type: nil, domain: nil, organization_id: nil, search: nil, state: nil, request_options: {}) ⇒ WorkOS::Types::ListStruct<WorkOS::Connection>
List Connections
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 |
# File 'lib/workos/sso.rb', line 50 def list_connections( before: nil, after: nil, limit: 10, order: "desc", connection_type: nil, domain: nil, organization_id: nil, search: nil, state: nil, request_options: {} ) params = { "before" => before, "after" => after, "limit" => limit, "order" => order, "connection_type" => connection_type, "domain" => domain, "organization_id" => organization_id, "search" => search, "state" => state }.compact response = @client.request( method: :get, path: "/connections", auth: true, params: params, request_options: ) fetch_next = ->(cursor) { list_connections( before: before, after: cursor, limit: limit, order: order, connection_type: connection_type, domain: domain, organization_id: organization_id, search: search, state: state, request_options: ) } WorkOS::Types::ListStruct.from_response( response, model: WorkOS::Connection, filters: {before: before, limit: limit, order: order, connection_type: connection_type, domain: domain, organization_id: organization_id, search: search, state: state}, fetch_next: fetch_next ) end |
#update_connection(id:, name: nil, external_id: WorkOS::OMIT, connection_type: nil, attribute_maps: nil, protocol_options: nil, request_options: {}) ⇒ WorkOS::Connection
Update a Connection
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 |
# File 'lib/workos/sso.rb', line 352 def update_connection( id:, name: nil, external_id: WorkOS::OMIT, connection_type: nil, attribute_maps: nil, protocol_options: nil, request_options: {} ) body = { "name" => name, "connection_type" => connection_type, "attribute_maps" => attribute_maps }.compact body["external_id"] = external_id unless external_id.equal?(WorkOS::OMIT) if case when WorkOS::SSO::PatchProtocolOptionsSAML body["saml_options"] = . when WorkOS::SSO::PatchProtocolOptionsOIDC body["oidc_options"] = . else raise ArgumentError, "expected protocol_options to be one of: WorkOS::SSO::PatchProtocolOptionsSAML, WorkOS::SSO::PatchProtocolOptionsOIDC, got #{.class}" end end response = @client.request( method: :patch, path: "/connections/#{WorkOS::Util.encode_path(id)}", auth: true, body: body, request_options: ) result = WorkOS::Connection.new(response.body) result.last_response = WorkOS::Types::ApiResponse.new(http_status: response.code.to_i, http_headers: response.each_header.to_h, request_id: response["x-request-id"]) result end |