WorkOS | Operate As Docs

Connect your client's WorkOS with a key they paste, and call its API through Operate As.

Website: workos.com
Connects by: Pasting a API key
Category: Developer tools
Services: 1
Tools: 264

Service	Key	Base URL
WorkOS	`workos`	`https://api.workos.com`

Connecting

Your client makes a API key in their WorkOS settings and pastes it on their link. Operate As tries it with WorkOS before saving it, and stores it encrypted. See Services connected with an API key.

Check they're connected

curl https://api.operate.as/v1/me/clients \
  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

curl https://api.operate.as/v1/me/clients \  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

Response

[
  {
    "id": "6f1c2a7e-...",
    "name": "Miller Dental",
    "services": [
      "workos"
    ]
  }
]

[  {    "id": "6f1c2a7e-...",    "name": "Miller Dental",    "services": [      "workos"    ]  }]

Permissions

What the client reads	Permission it asks for
Use the WorkOS key you paste, with only the access you gave that key	Chosen on the provider's screen

Tools

Install WorkOS's typed package for your language:

pip install operate-as-workos

pip install operate-as-workos

Run workos.agent_admin_controller_get_registration

curl -X POST https://api.operate.as/v1/actions/workos.agent_admin_controller_get_registration \
  -H "Authorization: Bearer $OPERATE_AS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "clientId": "6f1c2a7e-...",
    "input": {
      "id": "<id>"
    }
  }'

curl -X POST https://api.operate.as/v1/actions/workos.agent_admin_controller_get_registration \  -H "Authorization: Bearer $OPERATE_AS_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "clientId": "6f1c2a7e-...",    "input": {      "id": "<id>"    }  }'

Shows the required inputs. Every input, with its JSON Schema: GET /v1/actions/workos.agent_admin_controller_get_registration

Response

{
  "status": 200,
  "data": {
    "…": "the service's own response"
  },
  "encoding": "json"
}

{  "status": 200,  "data": {    "…": "the service's own response"  },  "encoding": "json"}

Pass-through

Paths continue from https://api.workos.com. Your Operate As key goes in Authorization; the client's access is added for you.

See Pass-through requests for the full request and response format.

Call any endpoint

curl "https://api.operate.as/v1/clients/6f1c2a7e-.../workos/organizations" \
  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

curl "https://api.operate.as/v1/clients/6f1c2a7e-.../workos/organizations" \  -H "Authorization: Bearer $OPERATE_AS_API_KEY"

Response

{
  "status": 200,
  "data": {
    "…": "the service's own response"
  },
  "encoding": "json"
}

{  "status": 200,  "data": {    "…": "the service's own response"  },  "encoding": "json"}

When access ends

A key works until your client deletes it in WorkOS. They can paste a new one on the same link at any time, and your workflows carry on without changes.

See Keeping access alive and Removing access.

Calls answer, once the key is deleted

{
  "status": 401,
  "data": {
    "…": "the service's own error"
  },
  "encoding": "json"
}

{  "status": 401,  "data": {    "…": "the service's own error"  },  "encoding": "json"}