steampipe plugin install workos

Table: workos_organization - Query WorkOS Organizations using SQL

WorkOS is a platform that helps developers to quickly implement enterprise-ready features into their applications. It provides features such as Single Sign-On, Directory Sync, and more, enabling seamless integration with various enterprise environments. An organization in WorkOS represents a group of users, typically corresponding to a company, that uses the same WorkOS settings and features.

Table Usage Guide

The workos_organization table provides insights into organizations managed by WorkOS. As a developer or system administrator, you can explore organization-specific details through this table, including domain, name, and associated metadata. Utilize it to manage and monitor the organizations, their settings, and to understand the usage of WorkOS features across different organizations.

Examples

Basic info

Explore the settings of your organization to understand whether profiles from outside the organization are permitted, and assess when these settings were last updated. This is useful for maintaining security and ensuring only authorized profiles have access.

select
id,
name,
allow_profiles_outside_organization,
created_at,
updated_at
from
workos_organization;
select
id,
name,
allow_profiles_outside_organization,
created_at,
updated_at
from
workos_organization;

List organizations that allow outside profiles

Explore which organizations permit profiles from outside their own, providing insights into their openness to external collaboration. This can assist in identifying potential partners or assessing the openness of your competitive landscape.

select
id,
name,
allow_profiles_outside_organization,
created_at,
updated_at
from
workos_organization
where
allow_profiles_outside_organization;
select
id,
name,
allow_profiles_outside_organization,
created_at,
updated_at
from
workos_organization
where
allow_profiles_outside_organization = 1;

List domains of a particular organization

Explore which domains are associated with a specific organization to better manage or monitor the organization's online presence and activities. This is especially useful for IT administrators or cybersecurity professionals who need to keep track of all the domains under an organization's purview.

select
workos_organization.id as organization_id,
name as organization_name,
d ->> 'domain' as domain,
d ->> 'id' as domain_id
from
workos_organization,
jsonb_array_elements(domains) as d
where
name = 'test';
select
workos_organization.id as organization_id,
name as organization_name,
json_extract(d.value, '$.domain') as domain,
json_extract(d.value, '$.id') as domain_id
from
workos_organization,
json_each(domains) as d
where
name = 'test';

List organizations created in the last 30 days

Discover the organizations that have been established in the past month. This is useful to keep track of new additions and ensure all recent organizations are accounted for.

select
id,
name,
allow_profiles_outside_organization,
created_at,
updated_at
from
workos_organization
where
created_at >= now() - interval '30' day;
select
id,
name,
allow_profiles_outside_organization,
created_at,
updated_at
from
workos_organization
where
created_at >= datetime('now', '-30 day');

Schema for workos_organization

NameTypeOperatorsDescription
_ctxjsonbSteampipe context in JSON form, e.g. connection_name.
allow_profiles_outside_organizationbooleanWhether connections within the organization allow profiles that are outside of the organization's configured user email domains.
created_attimestamp with time zoneThe timestamp of when the organization was created.
domainsjsonbThe organization's domains.
idtext=The Organization's unique identifier.
nametextThe Organization's name.
titletextTitle of the resource.
updated_attimestamp with time zoneThe timestamp of when the organization was updated.

Export

This table is available as a standalone Exporter CLI. Steampipe exporters are stand-alone binaries that allow you to extract data using Steampipe plugins without a database.

You can download the tarball for your platform from the Releases page, but it is simplest to install them with the steampipe_export_installer.sh script:

/bin/sh -c "$(curl -fsSL https://steampipe.io/install/export.sh)" -- workos

You can pass the configuration to the command with the --config argument:

steampipe_export_workos --config '<your_config>' workos_organization