Managed Users

Use the following endpoints to manage OEM users.

Supported Formats

  • Json

Create new OEM users

POST /api/managed_users

Description

Creates a new OEM user. Requires 'oem_vendor' privilege.

  • The new account is assigned the plan specified in the master account's OEM configuration.
  • Configures preferred authentication mode for the child account based on the value specified in the master account's OEM configuration.
  • Sets the plan of the new account based on the OEM configuration.
Details

Parameters

Parameter name Description
name
required
Full name of the user
Validations:
  • Must be string
oauth_id
required
Identifier used for OAuth
Validations:
  • Must be string
notification_email
required
Email for error notifications
Validations:
  • Must be string
external_id
optional
External identifier for the user
Validations:
  • Must be string

Example

{
  "name": "Kevin O'Leary",
  "oauth_id": "AAA0932808240:UU0239093498",
  "notification_email": "kevinl@acme.com",
  "external_id": "UU0239093498"
}

Responses

Code Description
200 Success
400 Bad request
401 Unauthorized
500 Server error

Examples

Success: 200

POST /api/managed_users
{
  "id": 3498583,
  "plan_id": "oem_plan",
  "trial": false
}

Server error: 500

{
  "message":"Server error",
  "id": "32y2298sjbjdwejweg"
}

Add member to OEM account

POST /api/managed_users/:id/member

Description

Adds a member to the OEM account. Requires 'oem_vendor' privilege.

  • Creates a new Workato member account and makes the user member of the given team.
  • Configures preferred authentication mode for the member based on the value specified in the master account's OEM configuration.
Details

Parameters

Parameter name Description
name
required
Full name of the user
Validations:
  • Must be string
oauth_id
required
Identifier used for OAuth
Validations:
  • Must be string
role_name
optional
Membership role name
Validations:
  • Must be string
external_id
optional
External identifier for the user
Validations:
  • Must be string

Example

{
  "name": "Jack Smith",
  "oauth_id": "AAA0932808240:UU0239093499",
  "role_name": "Admin",
  "external_id": "UU0239093499"
}

Responses

Code Description
200 Success
400 Bad request
401 Unauthorized
404 Not found
500 Server error

Examples

Success: 200

POST /api/managed_users/12/member
{
  "id": 3498583,
  "plan_id": "oem_plan",
  "trial": false
}

Server error: 500

{
  "message":"Server error",
  "id": "32y2298sjbjdwejweg"
}

results matching ""

    No results matching ""