Managed Users

All API endpoints listed here require oem_vendor privilege. Talk to your Workato representative to enable this privilege in your account.

Quick reference

Type Resource Description
POST /api/managed_users Create customer account.
GET /api/managed_users/:id Get customer account.
PUT /api/managed_users/:id/upgrade Upgrade customer account.
PUT /api/managed_users/:id/downgrade Downgrade customer account.
POST /api/managed_users/:id/member Add member to customer account.
DELETE /api/managed_users/:id/member Remove member from customer account.
GET /api/managed_users/:id/connections List customer connections.

Create customer account

Create a new OEM customer account.

POST /api/managed_users

Request body

Name Type Description
name string
required
Full name of the user.
notification_email string
required
Email for error notifications.
plan_id string
optional
Plan id. Default plan id is used when not provided.
external_id string
optional
External identifier for the OEM customer.

Sample request

curl  -X POST http://workato.com/api/managed_users \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "name": "Kevin Leary",
            "notification_email": "kevinl@acme.com",
            "external_id": "UU0239093498"
          }'

Response

{
  "id": 3498583,
  "plan_id": "oem_plan",
  "trial": false
}

Get customer account

Get OEM customer account details.

GET /api/managed_users/:id

URL parameters

Name Type Description
id string
required
OEM customer Account ID/External ID.
External id should be prefixed with a E(eg: EA2300) and the resulting id should be URL encoded.

Sample request

curl  -X GET http://workato.com/api/managed_users/<account_id> \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>'

Response

{
    "id": 4676,
    "exteranl_id": "A298247",
    "name": "Customer A",
    "notification_email": "customer-a@a.com",
    "plan_id": "business_yearly",
    "in_trial": false,
    "created_at": "2019-07-11T10:08:41.693-07:00",
    "updated_at": "2019-07-11T10:22:35.132-07:00"
}

Upgrade customer account

Upgrade OEM customer account from trial OR free plan.

PUT /api/managed_users/:id/upgrade

URL parameters

Name Type Description
id string
required
OEM customer Account ID/External ID.
External id should be prefixed with a E(eg: EA2300) and the resulting id should be URL encoded.

Request body

Name Type Description
plan_id string
optional
Plan id. Default plan id is used when not provided.

Sample request

curl  -X PUT http://workato.com/api/managed_users/<account_id>/upgrade \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "plan_id": "oem_enterprise"
          }'

Response

{
  "id": 3498583,
  "plan_id": "oem_enterprise",
  "trial": false
}

Downgrade customer account

Downgrade OEM customer account to free plan.

PUT /api/managed_users/:id/downgrade

URL parameters

Name Type Description
id string
required
OEM customer Account ID/External ID.
External id should be prefixed with a E(eg: EA2300) and the resulting id should be URL encoded.

Sample request

curl  -X PUT http://workato.com/api/managed_users/<account_id>/downgrade \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>'

Response

{
  "id": 3498583,
  "plan_id": "free",
  "trial": false
}

Add member to customer account

Add a member to the OEM customer account.

POST /api/managed_users/:id/member

URL parameters

Name Type Description
id string
required
OEM customer Account ID/External ID.
External id should be prefixed with a E(eg: EA2300) and the resulting id should be URL encoded.

Request body

Name Type Description
name string
required
Full name of the user.
oauth_id string
required
Identifier used for oauth.
role_name string
optional
Role name.
external_id string
optional
External identifier for the member.

Sample request

curl  -X POST http://workato.com/api/managed_users/<account_id>/member \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "name": "Jack Smith",
            "oauth_id": "AAA0932808240:UU0239093499",
            "role_name": "Admin",
            "external_id": "UU0239093499"
          }'

Response

{
  "id": 3498583,
  "plan_id": "oem_plan",
  "trial": false
}

Remove member from customer account

Remove a member from the OEM customer's account.

DELETE /api/managed_users/:id/member

URL parameters

Name Type Description
id string
required
OEM customer Account ID/External ID.
External id should be prefixed with a E(eg: EA2300) and the resulting id should be URL encoded.

Request body

Name Type Description
member_id string
required
Member id

Sample request

curl  -X DELETE http://workato.com/api/managed_users/<account_id>/member \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "member_id": "3485434779"
          }'

Response

{
  "id": 3485434779
}

List customer connections

Get the list of connections in OEM customer's account.

GET /api/managed_users/:id/connections

URL parameters

Name Type Description
id string
required
OEM customer Account ID/External ID.
External id should be prefixed with a E(eg: EA2300) and the resulting id should be URL encoded.

Sample request

curl  -X GET http://workato.com/api/managed_users/<account_id>/connections \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>'

Response

{
  "result": [
    {
      "id": 6132,
      "name": "My Box account",
      "provider": "box",
      "authorization_status": "success",
      "authorized_at": "2019-09-10T18:20:08.854-07:00",
      "created_at": "2019-09-10T18:19:57.437-07:00",
      "updated_at": "2019-09-10T18:20:08.859-07:00"
    },
    {
      "id": 6131,
      "name": "My Salesforce account",
      "provider": "salesforce",
      "authorization_status": "success",
      "authorized_at": "2019-09-10T18:19:43.018-07:00",
      "created_at": "2019-09-10T18:19:12.902-07:00",
      "updated_at": "2019-09-10T18:19:43.021-07:00"
    }
  ]
}

results matching ""

    No results matching ""