OAuth 2.0 authentication for clone targets
OAuth 2.0 authenticates clone requests to target instances without requiring admin credentials for each request.
Why OAuth 2.0 replaces basic authentication
Previously, Instance Clone used basic authentication to confirm access to a target instance. Administrators had to use an admin account and re-enter the credentials for each clone request.
OAuth 2.0 Authorization Code Flow enhances security and convenience by providing the following benefits:
- No admin credentials required for each clone request.
- One-time target instance registration using your existing target instance login.
- Automatic token generation and expiration for each clone request.
How it works
The source instance acts as the OAuth client, and the target instance acts as the OAuth authorization server. Authentication happens once per target instance during setup and repeats only if the session expires or is revoked.
During setup, the target instance generates a Client ID that uniquely identifies the source instance as an authorized OAuth client. Administrators copy this Client ID and return it to the source instance to complete registration.
After setup is complete, Instance Clone uses a short-lived JSON Web Token (JWT) access token to authenticate each clone request to the target. The source instance obtains this token automatically before each clone operation.
The clone_admin role is required on the source instance to request clones. The oauth_admin role is required on the target instance during initial setup only.
Token lifecycle
The JWT access token has a short time-to-live (TTL) and expires automatically after each use. If a token has expired, the system automatically redirects the user to reauthorize on the target instance from the Clone Admin Console before a clone can be requested.
One-time setup per target instance
OAuth setup is required once per target instance. If a token has expired, select Authorize on the target instance to submit a clone request.
For more information, see Set up OAuth authentication for a clone target.