# WorkOS

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

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/workos

## Actions

### Create organization

Create organization.

**Inputs**

- Name (`name`, text, required): Returned value.
- External ID (`external_id`, text): Returned value.
- Metadata (`metadata`, object): Returned value.
- Domain data (`domain_data`, list): Returned value.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "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_id`, text, required): Returned value.
- User (`member_id`, text, required): Choose a WorkOS user or use a user ID from an earlier step.
- Role slug (`role_slug`, text): Returned value.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "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 (`email`, text, required): Returned value.
- First name (`first_name`, text): Returned value.
- Last name (`last_name`, text): Returned value.
- Email verified (`email_verified`, true/false): Returned value.
- External ID (`external_id`, text): Returned value.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "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_id`, text, required): Returned value.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {}
}
```

### Delete organization membership

Delete organization membership.

**Inputs**

- Organization membership (`membership_id`, text, required): Returned value.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {}
}
```

### Delete user

Delete user.

**Inputs**

- User (`user_id_value`, text, required): Choose a WorkOS user or use a user ID from an earlier step.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {}
}
```

### Get directory

Get directory.

**Inputs**

- Directory (`directory_id`, text, required): Returned value.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "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_id`, text, required): Returned value.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "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_id`, text, required): Returned value.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "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_value`, text, required): Choose a WorkOS user or use a user ID from an earlier step.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "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 (`limit`, number): Returned value. From 1 to 100.
- After (`after`, text): Returned value.
- Before (`before`, text): Returned value.
- Order (`order`, text): Returned value. One of: `asc`, `desc`.
- Organization (`organization_id`, text): Returned value.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "data": [],
    "list_metadata": {
      "after": "example",
      "before": "example"
    }
  }
}
```

### List directories

List directories.

**Inputs**

- Limit (`limit`, number): Returned value. From 1 to 100.
- After (`after`, text): Returned value.
- Before (`before`, text): Returned value.
- Order (`order`, text): Returned value. One of: `asc`, `desc`.
- Organization (`organization_id`, text): Returned value.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "data": [],
    "list_metadata": {
      "after": "example",
      "before": "example"
    }
  }
}
```

### List directory groups

List directory groups.

**Inputs**

- Limit (`limit`, number): Returned value. From 1 to 100.
- After (`after`, text): Returned value.
- Before (`before`, text): Returned value.
- Order (`order`, text): Returned value. One of: `asc`, `desc`.
- Directory (`directory`, text, required): Returned value.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "data": [],
    "list_metadata": {
      "after": "example",
      "before": "example"
    }
  }
}
```

### List directory users

List directory users.

**Inputs**

- Limit (`limit`, number): Returned value. From 1 to 100.
- After (`after`, text): Returned value.
- Before (`before`, text): Returned value.
- Order (`order`, text): Returned value. One of: `asc`, `desc`.
- Directory (`directory`, text, required): Returned value.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "data": [],
    "list_metadata": {
      "after": "example",
      "before": "example"
    }
  }
}
```

### List events

List events.

**Inputs**

- Limit (`limit`, number): Returned value. From 1 to 100.
- After (`after`, text): Returned value.
- Before (`before`, text): Returned value.
- Order (`order`, text): Returned value. One of: `asc`, `desc`.
- Events (`events`, list, required): 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_start`, date and time): Returned value.
- Range end (`range_end`, date and time): Returned value.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "data": [],
    "list_metadata": {
      "after": "example",
      "before": "example"
    }
  }
}
```

### List organization memberships

List organization memberships.

**Inputs**

- Limit (`limit`, number): Returned value. From 1 to 100.
- After (`after`, text): Returned value.
- Before (`before`, text): Returned value.
- Order (`order`, text): Returned value. One of: `asc`, `desc`.
- Organization (`organization_id`, text): Returned value.
- User (`member_id`, text): Choose a WorkOS user or use a user ID from an earlier step.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "data": [],
    "list_metadata": {
      "after": "example",
      "before": "example"
    }
  }
}
```

### List organizations

List organizations.

**Inputs**

- Limit (`limit`, number): Returned value. From 1 to 100.
- After (`after`, text): Returned value.
- Before (`before`, text): Returned value.
- Order (`order`, text): Returned value. One of: `asc`, `desc`.
- Domains (`domains`, list): Returned value.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "data": [],
    "list_metadata": {
      "after": "example",
      "before": "example"
    }
  }
}
```

### List users

List users.

**Inputs**

- Limit (`limit`, number): Returned value. From 1 to 100.
- After (`after`, text): Returned value.
- Before (`before`, text): Returned value.
- Order (`order`, text): Returned value. One of: `asc`, `desc`.
- Email (`email`, text): Returned value.
- Organization (`organization_id`, text): Returned value.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "data": [],
    "list_metadata": {
      "after": "example",
      "before": "example"
    }
  }
}
```

### Update organization

Update organization.

**Inputs**

- Organization (`organization_id`, text, required): Returned value.
- Name (`name`, text): Returned value.
- External ID (`external_id`, text): Returned value.
- Metadata (`metadata`, object): Returned value.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "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_value`, text, required): Choose a WorkOS user or use a user ID from an earlier step.
- First name (`first_name`, text): Returned value.
- Last name (`last_name`, text): Returned value.
- Email (`email`, text): Returned value.
- Email verified (`email_verified`, true/false): Returned value.

**Outputs**

- `data` (object): Returned value.

**Example output**

```json
{
  "data": {
    "email": "example",
    "first_name": "example",
    "id": "example",
    "last_name": "example",
    "name": "example",
    "organization_id": "example",
    "status": "example",
    "user_id": "example"
  }
}
```
