Usage

When OAuth is enabled in the JFrog Platform, users may choose to sign in through any of the supported OAuth providers. To log in through a provider, simply click on the provider's button in the login screen.

You will be redirected to the login screen of the corresponding provider.

If you are already logged in to any of that provider's applications you will not need to log in again, but you may have to authorize the JFrog Platform to access your account information, depending on the provider type.

Configuring OAuth

To access OAuth integration settings, in the Administration module, select Authentication Providers | OAuth SSO.

Adding a New Provider

The list of providers defined in Artifactory is displayed in the Providers section. 

To add a new provider, click New. The JFrog Platform displays a dialog letting you enter the provider details. These may vary slightly depending on the provider you are configuring.

The following table describes the settings required by each supported provider, and the corresponding values you should use (where available):

Using Query Params

You may pass query params along with the Authorization URL. 

https://github.com/login/oauth/authorize?realm=Employees

Multiple query params should be separated with an ampersand. 

https://github.com/login/oauth/authorize?realm=Employees?client_id=XXXXXXXXXXX&scope=openid%20profile%20email

Enabling Authorization Code Flow with PKCE

From Artifactory version 7.38, you can apply the Authorization Code Flow with PKCE (Proof Key for Code Exchange) flow for your OAuth Provider authorization provider. This flow is the alternative to the usage of Secrets, which is automatically disabled once you enable PKCE on your OAuth provider.

To enable PKCE on your OAuth provider:

1. In the Administration module, navigate to the Administration module, and select Authentication Providers | OAuth SSO.

2. Scroll to the Providers section and click New or edit an existing provider.
   

   
3. Select the PKCE Enabled check box.
   As a result, the Secret field is disabled.

Enabling and Disabling Personal OAuth SSO

1. To enable Personal OAuth SSO, in the Administration module, select User Management | Security.
2. Scroll down to Personal Sign On, and select Enable sign up via external providers.
   
3. Then, from the Providers dropdown list, select the providers you wish to enable in the sign up screen, for example Google, GitHub, etc.

Binding Existing User Accounts

To log in using any of your OAuth provider accounts If you already have an internal (not external realms such as LDAP, SAML...) account in the system,  bind your JFrog Platform account to the corresponding account.

To bind your account, go to your Profile page and enter your JFrog Platform password to unlock it.

Under OAuth User Binding, select Click to bind next to the OAuth provider you wish to bind to.

Creating OAuth Provider Accounts

In order to use OAuth authentication, you need to set up an account with each OAuth provider you wish to use in order to get the various parameters (such as Provider ID and Secret) you will need to set up OAuth integration in the system.

GitHub OAuth Setup

To set up your OAuth account on GitHub:

1. Log in to your GitHub account. Under your personal profile settings, select Applications and click the .
   

2. Click Register new application.
   

3. Set the Application name. For example, the JFrog Platform Cloud OAuth.

4. Set the Homepage Url. This is your Artifactory server host URL (https://<artifactory-server>/). 
   For example, https://mycompany.jfrog.io/mycompany/

5. Set the Authorization Callback URL as follows: 

   1. For on-prem installation: http://<server_host>/artifactory/api/oauth2/loginResponse
For example, http://mycompany.artifactory.com/artifactory/api/oauth2/loginResponse

   2. For cloud: https://<server_name>.jfrog.io/artifactory/api/oauth2/loginResponse
      For example, https://mycompany.jfrog.io/artifactory/api/oauth2/loginResponse

6. Click Register application to  generate your Client ID and Client Secret. 
   Make a note of these; you will need them to configure OAuth authentication through GitHub on the JPD.

Google OAuth Provider Setup

To set up your OAuth account on Google, execute the following steps:

1. Login to .

2. Create a new project. For example, "Artifactory OAuth".

3. Once the project is created, in the left navigation bar, select APIs & auth | Credentials.

4. Select the OAuth consent screen tab and configure the consent page that the end users will see when logging in with the Google credentials.
    

5. Back in the Credentials tab, Click Add Credential and select OAuth 2.0 client ID.
   
    

6. Under Create client ID, select Web application.

7. Enter a Name and set the Authorized redirect URIs
   For on-prem: https://<server_host>/artifactory/api/auth/oauth2/loginResponse
   For cloud: https://<server_name>.jfrog.io/artifactory/api/oauth2/loginResponse



8. Click Create to generate your Client ID and Client Secret. 
   
   Make a note of these; you will need them to configure OAuth authentication through Google on the JFrog Platform.

Cloud Foundry UAA Setup

OAuth authentication with Cloud Foundry UAA is supported.

To setup your OAuth authentication with Cloud Foundry UAA, fill in the fields as needed.

Using Secure OAuth 

To use secure OAuth with a valid certificate from a CA trusted by Java, all you need to do is use a secure OAuth URL in your settings.

If you want to use OAuth with a non-trusted (self-signed) certificate, please see Trusting a new CA or a Self-Signed Certificate.

Using API Key with OAuth Users

While OAuth provides access to the UI, it is also possible for OAuth users to generate an API Key that can be used instead of a password for basic authentication or in a dedicated REST API header, this is very useful when working with different clients, e.g. docker, npm, maven, etc. or using Artifactory REST API.

In order to allow OAuth users access to an API key you will need to make sure that the "Auto Create System Users" and "Allow Created Users Access To Profile Page" check boxes are checked. This means that OAuth users are also saved in the database and can access their profile page in order to generate, retrieve and revoke their API key.

Using OAuth on High Availability Setup

The OAuth protocol requires the client to give permission to a specific application. JPD will redirect the user to the configured application URL and one permission is granted user will be navigated back.

The limitation on this process when working in High Availability setup is that the user must return to the same node, otherwise the authentication process will fail, in order to achieve this a sticky session configuration should include the /artifactory/api/oauth2/.

The example below shows NGINX configuration. 

location ~ (/artifactory/webapp/|/artifactory/ui/|/artifactory/api/oauth2/) {
        proxy_http_version      1.1;
        proxy_pass              http://<UPSTREAM_NAME>;
        proxy_intercept_errors  on;
        proxy_pass_header       Server;
        proxy_connect_timeout   75s;
        proxy_send_timeout      2400s;
        proxy_read_timeout      2400s;
        proxy_set_header        Host $host;
        proxy_set_header        X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header        X-Forwarded-Proto $http_x_forwarded_proto;
        proxy_set_header        X-Real-IP $remote_addr;
        proxy_set_header        X-JFrog-Override-Base-Url $http_x_forwarded_proto://$host;
}