WorkOS
App · 20 actions
Manage organizations, users and memberships; read SSO connections, directories and events.
Actions
| Action | What it does |
|---|---|
| Create organization | Create organization. |
| Create organization membership | Create organization membership. |
| Create user | Create user. |
| Delete organization | Delete organization. |
| Delete organization membership | Delete organization membership. |
| Delete user | Delete user. |
| Get directory | Get directory. |
| Get organization | Get organization. |
| Get organization membership | Get organization membership. |
| Get user | Get user. |
| List connections | List connections. |
| List directories | List directories. |
| List directory groups | List directory groups. |
| List directory users | List directory users. |
| List events | List events. |
| List organization memberships | List organization memberships. |
| List organizations | List organizations. |
| List users | List users. |
| Update organization | Update organization. |
| Update user | Update user. |
Create organization
Create organization.
Inputs
- Name
nametextRequired - Returned value.
- External ID
external_idtext - Returned value.
- Metadata
metadataobject - Returned value.
- Domain data
domain_datalist - Returned value.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"email": "example",
"first_name": "example",
"id": "example",
"last_name": "example",
"name": "example",
"organization_id": "example",
"status": "example",
"user_id": "example"
}
}Create organization membership
Create organization membership.
Inputs
- Organization
organization_idtextRequired - Returned value.
- User
member_idtextRequired - Choose a WorkOS user or use a user ID from an earlier step.
- Role slug
role_slugtext - Returned value.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"email": "example",
"first_name": "example",
"id": "example",
"last_name": "example",
"name": "example",
"organization_id": "example",
"status": "example",
"user_id": "example"
}
}Create user
Create user.
Inputs
- Email
emailtextRequired - Returned value.
- First name
first_nametext - Returned value.
- Last name
last_nametext - Returned value.
- Email verified
email_verifiedtrue/false - Returned value.
- External ID
external_idtext - Returned value.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"email": "example",
"first_name": "example",
"id": "example",
"last_name": "example",
"name": "example",
"organization_id": "example",
"status": "example",
"user_id": "example"
}
}Delete organization
Delete organization.
Inputs
- Organization
organization_idtextRequired - Returned value.
Outputs
dataobject- Returned value.
Example output
{
"data": {}
}Delete organization membership
Delete organization membership.
Inputs
- Organization membership
membership_idtextRequired - Returned value.
Outputs
dataobject- Returned value.
Example output
{
"data": {}
}Delete user
Delete user.
Inputs
- User
user_id_valuetextRequired - Choose a WorkOS user or use a user ID from an earlier step.
Outputs
dataobject- Returned value.
Example output
{
"data": {}
}Get directory
Get directory.
Inputs
- Directory
directory_idtextRequired - Returned value.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"email": "example",
"first_name": "example",
"id": "example",
"last_name": "example",
"name": "example",
"organization_id": "example",
"status": "example",
"user_id": "example"
}
}Get organization
Get organization.
Inputs
- Organization
organization_idtextRequired - Returned value.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"email": "example",
"first_name": "example",
"id": "example",
"last_name": "example",
"name": "example",
"organization_id": "example",
"status": "example",
"user_id": "example"
}
}Get organization membership
Get organization membership.
Inputs
- Organization membership
membership_idtextRequired - Returned value.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"email": "example",
"first_name": "example",
"id": "example",
"last_name": "example",
"name": "example",
"organization_id": "example",
"status": "example",
"user_id": "example"
}
}Get user
Get user.
Inputs
- User
user_id_valuetextRequired - Choose a WorkOS user or use a user ID from an earlier step.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"email": "example",
"first_name": "example",
"id": "example",
"last_name": "example",
"name": "example",
"organization_id": "example",
"status": "example",
"user_id": "example"
}
}List connections
List connections.
Inputs
- Limit
limitnumber - Returned value.From 1 to 100.
- After
aftertext - Returned value.
- Before
beforetext - Returned value.
- Order
ordertext - Returned value.One of:
asc,desc. - Organization
organization_idtext - Returned value.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"data": [],
"list_metadata": {
"after": "example",
"before": "example"
}
}
}List directories
List directories.
Inputs
- Limit
limitnumber - Returned value.From 1 to 100.
- After
aftertext - Returned value.
- Before
beforetext - Returned value.
- Order
ordertext - Returned value.One of:
asc,desc. - Organization
organization_idtext - Returned value.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"data": [],
"list_metadata": {
"after": "example",
"before": "example"
}
}
}List directory groups
List directory groups.
Inputs
- Limit
limitnumber - Returned value.From 1 to 100.
- After
aftertext - Returned value.
- Before
beforetext - Returned value.
- Order
ordertext - Returned value.One of:
asc,desc. - Directory
directorytextRequired - Returned value.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"data": [],
"list_metadata": {
"after": "example",
"before": "example"
}
}
}List directory users
List directory users.
Inputs
- Limit
limitnumber - Returned value.From 1 to 100.
- After
aftertext - Returned value.
- Before
beforetext - Returned value.
- Order
ordertext - Returned value.One of:
asc,desc. - Directory
directorytextRequired - Returned value.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"data": [],
"list_metadata": {
"after": "example",
"before": "example"
}
}
}List events
List events.
Inputs
- Limit
limitnumber - Returned value.From 1 to 100.
- After
aftertext - Returned value.
- Before
beforetext - Returned value.
- Order
ordertext - Returned value.One of:
asc,desc. - Events
eventslistRequired - Returned value.One or more of:
dsync.user.created,dsync.user.updated,dsync.user.deleted,dsync.group.created,dsync.group.updated,dsync.group.deleted,organization.created,organization.updated,organization.deleted,user.created, and 7 more. - Range start
range_startdate and time - Returned value.
- Range end
range_enddate and time - Returned value.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"data": [],
"list_metadata": {
"after": "example",
"before": "example"
}
}
}List organization memberships
List organization memberships.
Inputs
- Limit
limitnumber - Returned value.From 1 to 100.
- After
aftertext - Returned value.
- Before
beforetext - Returned value.
- Order
ordertext - Returned value.One of:
asc,desc. - Organization
organization_idtext - Returned value.
- User
member_idtext - Choose a WorkOS user or use a user ID from an earlier step.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"data": [],
"list_metadata": {
"after": "example",
"before": "example"
}
}
}List organizations
List organizations.
Inputs
- Limit
limitnumber - Returned value.From 1 to 100.
- After
aftertext - Returned value.
- Before
beforetext - Returned value.
- Order
ordertext - Returned value.One of:
asc,desc. - Domains
domainslist - Returned value.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"data": [],
"list_metadata": {
"after": "example",
"before": "example"
}
}
}List users
List users.
Inputs
- Limit
limitnumber - Returned value.From 1 to 100.
- After
aftertext - Returned value.
- Before
beforetext - Returned value.
- Order
ordertext - Returned value.One of:
asc,desc. - Email
emailtext - Returned value.
- Organization
organization_idtext - Returned value.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"data": [],
"list_metadata": {
"after": "example",
"before": "example"
}
}
}Update organization
Update organization.
Inputs
- Organization
organization_idtextRequired - Returned value.
- Name
nametext - Returned value.
- External ID
external_idtext - Returned value.
- Metadata
metadataobject - Returned value.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"email": "example",
"first_name": "example",
"id": "example",
"last_name": "example",
"name": "example",
"organization_id": "example",
"status": "example",
"user_id": "example"
}
}Update user
Update user.
Inputs
- User
user_id_valuetextRequired - Choose a WorkOS user or use a user ID from an earlier step.
- First name
first_nametext - Returned value.
- Last name
last_nametext - Returned value.
- Email
emailtext - Returned value.
- Email verified
email_verifiedtrue/false - Returned value.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"email": "example",
"first_name": "example",
"id": "example",
"last_name": "example",
"name": "example",
"organization_id": "example",
"status": "example",
"user_id": "example"
}
}