WorkOS

App · 20 actions

Manage organizations, users and memberships; read SSO connections, directories and events.

Actions

ActionWhat it does
Create organizationCreate organization.
Create organization membershipCreate organization membership.
Create userCreate user.
Delete organizationDelete organization.
Delete organization membershipDelete organization membership.
Delete userDelete user.
Get directoryGet directory.
Get organizationGet organization.
Get organization membershipGet organization membership.
Get userGet user.
List connectionsList connections.
List directoriesList directories.
List directory groupsList directory groups.
List directory usersList directory users.
List eventsList events.
List organization membershipsList organization memberships.
List organizationsList organizations.
List usersList users.
Update organizationUpdate organization.
Update userUpdate user.

Create organization

Create organization.

Inputs

NamenametextRequired
Returned value.
External IDexternal_idtext
Returned value.
Metadatametadataobject
Returned value.
Domain datadomain_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

Organizationorganization_idtextRequired
Returned value.
Usermember_idtextRequired
Choose a WorkOS user or use a user ID from an earlier step.
Role slugrole_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

EmailemailtextRequired
Returned value.
First namefirst_nametext
Returned value.
Last namelast_nametext
Returned value.
Email verifiedemail_verifiedtrue/false
Returned value.
External IDexternal_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

Organizationorganization_idtextRequired
Returned value.

Outputs

dataobject
Returned value.
Example output
{
  "data": {}
}

Delete organization membership

Delete organization membership.

Inputs

Organization membershipmembership_idtextRequired
Returned value.

Outputs

dataobject
Returned value.
Example output
{
  "data": {}
}

Delete user

Delete user.

Inputs

Useruser_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

Directorydirectory_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

Organizationorganization_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 membershipmembership_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

Useruser_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

Limitlimitnumber
Returned value.From 1 to 100.
Afteraftertext
Returned value.
Beforebeforetext
Returned value.
Orderordertext
Returned value.One of: asc, desc.
Organizationorganization_idtext
Returned value.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": [],
    "list_metadata": {
      "after": "example",
      "before": "example"
    }
  }
}

List directories

List directories.

Inputs

Limitlimitnumber
Returned value.From 1 to 100.
Afteraftertext
Returned value.
Beforebeforetext
Returned value.
Orderordertext
Returned value.One of: asc, desc.
Organizationorganization_idtext
Returned value.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": [],
    "list_metadata": {
      "after": "example",
      "before": "example"
    }
  }
}

List directory groups

List directory groups.

Inputs

Limitlimitnumber
Returned value.From 1 to 100.
Afteraftertext
Returned value.
Beforebeforetext
Returned value.
Orderordertext
Returned value.One of: asc, desc.
DirectorydirectorytextRequired
Returned value.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": [],
    "list_metadata": {
      "after": "example",
      "before": "example"
    }
  }
}

List directory users

List directory users.

Inputs

Limitlimitnumber
Returned value.From 1 to 100.
Afteraftertext
Returned value.
Beforebeforetext
Returned value.
Orderordertext
Returned value.One of: asc, desc.
DirectorydirectorytextRequired
Returned value.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": [],
    "list_metadata": {
      "after": "example",
      "before": "example"
    }
  }
}

List events

List events.

Inputs

Limitlimitnumber
Returned value.From 1 to 100.
Afteraftertext
Returned value.
Beforebeforetext
Returned value.
Orderordertext
Returned value.One of: asc, desc.
EventseventslistRequired
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 startrange_startdate and time
Returned value.
Range endrange_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

Limitlimitnumber
Returned value.From 1 to 100.
Afteraftertext
Returned value.
Beforebeforetext
Returned value.
Orderordertext
Returned value.One of: asc, desc.
Organizationorganization_idtext
Returned value.
Usermember_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

Limitlimitnumber
Returned value.From 1 to 100.
Afteraftertext
Returned value.
Beforebeforetext
Returned value.
Orderordertext
Returned value.One of: asc, desc.
Domainsdomainslist
Returned value.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": [],
    "list_metadata": {
      "after": "example",
      "before": "example"
    }
  }
}

List users

List users.

Inputs

Limitlimitnumber
Returned value.From 1 to 100.
Afteraftertext
Returned value.
Beforebeforetext
Returned value.
Orderordertext
Returned value.One of: asc, desc.
Emailemailtext
Returned value.
Organizationorganization_idtext
Returned value.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "data": [],
    "list_metadata": {
      "after": "example",
      "before": "example"
    }
  }
}

Update organization

Update organization.

Inputs

Organizationorganization_idtextRequired
Returned value.
Namenametext
Returned value.
External IDexternal_idtext
Returned value.
Metadatametadataobject
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

Useruser_id_valuetextRequired
Choose a WorkOS user or use a user ID from an earlier step.
First namefirst_nametext
Returned value.
Last namelast_nametext
Returned value.
Emailemailtext
Returned value.
Email verifiedemail_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"
  }
}

On this page