Migrate customer workspace system roles | Workato

1 curl -X POST https://www.workato.com/api/roles_migration/system_roles \ 2 -H "Authorization: Bearer <token>"

1 { 2 "environment_roles": [ 3 { 4 "name": "EnvironmentAdmin", 5 "config": { 6 "key": "value" 7 } 8 } 9 ], 10 "project_roles": [ 11 { 12 "name": "ProjectAdmin", 13 "config": { 14 "key": "value" 15 } 16 } 17 ], 18 "collaborators": [ 19 { 20 "id": 1, 21 "email": "collaborator@example.com", 22 "name": "Collaborator Name", 23 "roles": [ 24 { 25 "environment": "dev", 26 "name": "EnvironmentAdmin" 27 } 28 ] 29 } 30 ], 31 "projects": [ 32 { 33 "id": 101, 34 "name": "Dev Project", 35 "environment": "dev", 36 "collaborators": [ 37 { 38 "id": 1, 39 "email": "collaborator@example.com", 40 "name": "Collaborator Name", 41 "project_role": "ProjectAdmin" 42 } 43 ] 44 } 45 ], 46 "moderators": [ 47 { 48 "id": 201, 49 "email": "moderator@example.com", 50 "name": "Moderator Name", 51 "environment_role": "EnvironmentAdmin", 52 "project_role": "ProjectAdmin" 53 } 54 ] 55 }

Converts legacy system roles into environment and project roles in an Embedded customer workspace. This endpoint is used to migrate users to the access control model.

Path parameters

managed_user_idstringRequired

The Embedded customer ID or external ID. External IDs must be URL encoded and prefixed with an E, for example: EA2300.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

dry_runbooleanOptionalDefaults to false

When set to true, roles are not migrated, but the JSON response is still returned. The default value is false.

Response

Successful migration

environment_roleslist of objects or null

project_roleslist of objects or null

collaboratorslist of objects or null

projectslist of objects or null

moderatorslist of objects or null

Path parameters

Headers

Query parameters

Response

Errors