Articles in this section

Transfer Ownership

Avatar
Owen Harrington-Woodard
Updated
Follow

Overview

Transfer Ownership allows you to transfer a Platform object to a teammate. As the new owner of the object, your teammate will have manage permission on the object and, where applicable, become the job runner and be included on success and failure notifications. When transferring an object, you have the option to share dependencies as well. For example, if a script has a custom credential parameter, you can share the credential with the new owner as well to ensure they can run the script successfully.

All objects are transferable via the API, for ex:jobs,notebooks,workflows. You can transfer scripts, credentials, reports, notebooks, and projects in the UI by clicking “Transfer Ownership” in the standard action menu. By default, all dependencies will be shared when possible if a transfer is executed from the UI. 

image1.gif

 

Transfer Requirements

In order to successfully transfer an object to a new owner, a user must have all of the following permissions:

  • Must be current object owner OR have manage permission on the current object owner
  • Manage permission on the object
  • Manage permission on the target user

The target user will receive manage permissions on dependencies if the user executing the transfer has permissions to share the dependent object. 

 

Dependencies

When transferring ownership of an object, you can also share dependencies the object might have with the target user. You can usedependency endpoints to read dependencies and determine whether or not to include them in the transfer. By default, all dependencies will be shared when possible if a transfer is executed from the UI.

Possible dependencies include Credentials, and Remote Hosts. When transferring ownership of a project, dependencies include any object that can be added to a project, such as Jobs, Scripts, and Notebooks and Services.

 

Permissions for Sharing Dependencies

In order for dependencies to be shared with the target user, it is required that the user who is requesting the Transfer Ownership of an object and sharing dependent objects  (whether through the API or the UI) be able to share the dependent object. To do so, the requesting user must either be the owner of the dependent object, or have manage permissions on the dependent object. Dependencies which the requesting user does not have manage permission on will be skipped, allowing the rest of the transfer process to proceed.

 

Troubleshooting

Below are some common errors/blockers that you might encounter when attempting to transfer ownership of an object and how to resolve them.

 

Common Issues/ Errors

Resolution / Workaround

Reason

Transfer failed: Sharing failed: Cannot modify an archived object

Unarchive the object first before retrying

  

Validation failed: From template User (ID: user_id) does not have read permission on template script (ID: ts_id)

Grant the target user “read” permission on the template script with ID ts_id.

This may require reaching out to a manager of the template script.

To run a custom script, it is required that the target user has read access on the custom script’s template script. Attempting to transfer ownership of a custom script to a user who does not have read access on the associated template script will fail.

When dependencies are included, Platform will attempt to share the template script automatically. If this error occurs, you may not be able to share the template yourself. To resolve this issue, please reach out to a manager of the template script and request that they grant read access on it to the target user.

Transfer failed. No credential exists for target user user_name on the Remote Host (Source|Destination) 'rh_name' (ID: rh_id)

Share an existing credential or create a new one for the remote host rh_id for the target user

Imports require that the target user has a credential for both the Source and Destination Remote Hosts associated with the Import. Platform goes through the following checks to find a suitable credential for the target user before raising an error.

1. If the import uses a non-default credential, and the user requesting the transfer of the import has manage permission on the credential, Platform will share the credential with the target user. Default credentials will not be shared as part of this process.

2. If the import uses a default credential, Platform will look for an existing default credential owned by the target user for the relevant remote host. Platform will use this default credential if one is found.

3. If the import’s credential is not a default credential and the target user has at least read access on the credential, Platform will continue to use the same credential.

4. If the import’s credential is a non-default credential and the target user does not have at least read access on it, Platform will search for a credential owned by the target user for the remote host. If one is found, Platform will use this credential.


If none of the above checks are satisfied, Platform will raise an error.

Cannot find the desired target user in the Transfer Ownership drop down.

If you need to transfer an object to another user in your organization whom you do not have manage permission over, then you can ask one of your Organization Admins to transfer the object for you.

  1. Grant manage permission on the object to your Org Admin
  2. Ask them to transfer the object to the target user for you

Must have manage permission over the user you are transferring ownership to.

Organization Admins can manage all users in the org, and can manage most objects by enabling Superadmin Mode, so will be able to fulfill the transfer requirements. If the object in question is a credential, you will need to grant manage permission on the object to the org admin first.

No option is shown in the UI to transfer object

Only certain types of objects can be transferred through the UI, these types are:

  • Scripts
  • Credentials
  • Projects
  • Notebooks
  • Reports

Bulk transfers can be performed programmatically via the API, or CS may be able to assist if you have a large number of objects to move. Please note: Only scheduled jobs can be transferred in bulk.

Related articles

Comments

0 comments

Article is closed for comments.