Class: WorkOS::AdminPortal

Inherits:
Object
  • Object
show all
Defined in:
lib/workos/admin_portal.rb

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ AdminPortal

Returns a new instance of AdminPortal.



9
10
11
 
# File 'lib/workos/admin_portal.rb', line 9

def initialize(client)
  @client = client
end

Instance Method Details

Generate a Portal Link

Parameters:

  • return_url (String, nil) (defaults to: nil) —

    The URL to go to when an admin clicks on your logo in the Admin Portal. If not specified, the return URL configured on the Admin Portal page will be used.

  • success_url (String, nil) (defaults to: nil) —

    The URL to redirect the admin to when they finish setup. If not specified, the success URL configured on the Admin Portal page will be used.

  • organization (String) —

    An Organization identifier.

  • external_user_id (String, nil) (defaults to: nil) —

    The ID of the user in your application the link is generated for. The link and any Admin Portal sessions started from it can later be revoked by this ID, for example when that user is deprovisioned from your application.

  • intent (WorkOS::Types::GenerateLinkIntent, nil) (defaults to: nil) —

    The intent of the Admin Portal. - sso - Launch Admin Portal for creating SSO connections - dsync - Launch Admin Portal for creating Directory Sync connections - audit_logs - Launch Admin Portal for viewing Audit Logs - log_streams - Launch Admin Portal for creating Log Streams - domain_verification - Launch Admin Portal for Domain Verification - certificate_renewal - Launch Admin Portal for renewing SAML Certificates - bring_your_own_key - Launch Admin Portal for configuring Bring Your Own Key

  • it_contact_emails (Array<String>, nil) (defaults to: nil) —

    The email addresses of the IT contacts to grant access to the Admin Portal for the given organization. Accepts up to 20 emails.

  • request_options (Hash) (defaults to: {}) —

    (see WorkOS::Types::RequestOptions)

Returns:



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/workos/admin_portal.rb', line 22

def generate_link(
  organization:,
  return_url: nil,
  success_url: nil,
  external_user_id: nil,
  intent: nil,
  it_contact_emails: nil,
  request_options: {}
)
  body = {
    "return_url" => return_url,
    "success_url" => success_url,
    "organization" => organization,
    "external_user_id" => external_user_id,
    "intent" => intent,
    "it_contact_emails" => it_contact_emails
  }.compact
  response = @client.request(
    method: :post,
    path: "/portal/generate_link",
    auth: true,
    body: body,
    request_options: request_options
  )
  result = WorkOS::PortalLinkResponse.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

#revoke_link(organization:, external_user_id:, request_options: {}) ⇒ void

This method returns an undefined value.

Revoke a Portal Link

Parameters:

  • organization (String) —

    An Organization identifier.

  • external_user_id (String) —

    The external_user_id the Portal Links were generated with for this organization. Every matching link is revoked, along with any Admin Portal sessions started from those links.

  • request_options (Hash) (defaults to: {}) —

    (see WorkOS::Types::RequestOptions)



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/workos/admin_portal.rb', line 56

def revoke_link(
  organization:,
  external_user_id:,
  request_options: {}
)
  body = {
    "organization" => organization,
    "external_user_id" => external_user_id
  }
  @client.request(
    method: :post,
    path: "/portal/revoke_link",
    auth: true,
    body: body,
    request_options: request_options
  )
  nil
end