Product UpdatesStatus PageWorkato Academy
English
日本語
Get a trial
Embedded API
Resources

Custom OAuth profiles ​

Use the following endpoints to manage custom OAuth profiles assigned to customers.

Rate limits ​

Custom OAuth profile resources have the following rate limit:

Quick reference ​

TypeResourceDescription
POST/api/managed_users/:managed_user_id/
custom_oauth_profiles/:id/assign		Assign a Custom OAuth profile to customer workspace
DELETE/api/managed_users/:managed_user_id/
custom_oauth_profiles/:id/unassign		Unassigns a Custom OAuth profile to a customer workspace.

Assign a custom OAuth profile ​

Assigns a custom OAuth profile to a customer workspace.

POST /api/managed_users/:managed_user_id/custom_oauth_profiles/:id/assign

URL parameters ​

NameTypeDescription
managed_user_idstring
required		Embedded customer ID/external ID.
External ID must be prefixed with an E (for example, EA2300) and the resulting ID should be URL encoded.
idinteger
required		ID of the custom OAuth profile within the Embedded partner workspace you plan to assign to a customer workspace.

Sample request ​

shell
curl  -X POST 'https://www.workato.com/api/managed_users/123/custom_oauth_profiles/322/assign' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \

Response ​

json
{
  "result": { 
    "success": true
  }
}

Unassign a custom OAuth profile ​

Unassigns a custom OAuth profile to a customer workspace.

DELETE /api/managed_users/:managed_user_id/custom_oauth_profiles/:id/unassign

URL parameters ​

NameTypeDescription
managed_user_idstring
required		Embedded customer ID/external ID.
External ID must be prefixed with an E (for example, EA2300) and the resulting ID should be URL encoded.
idinteger
required		ID of the custom OAuth profile within the Embedded partner workspace to assign to a customer workspace.

Query parameters ​

NameTypeDescription
forcebooleanWhen true unassigns the custom OAuth profile even if it is used in a customer workspace. Defaults to false.

Sample request ​

shell
curl  -X DELETE 'https://www.workato.com/api/managed_users/123/custom_oauth_profiles/322/unassign' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \

Response ​

json
{
  "result": { 
    "success": true
  }
}

Last updated: