Create an OAuth application

To use the Helm chart to deploy Ansible automation portal, you must have set up an OAuth application on your Ansible Automation Platform instance.

About this task
Copy link

However, you cannot run automation on your Ansible Automation Platform instance until you have deployed your Ansible automation portal Helm chart, because the OAuth configuration requires the URL for your deployment.

Create the OAuth Application on your Ansible Automation Platform instance, using a placeholder name for the deployment URL.

After deploying Ansible automation portal, you must replace the placeholder value with a URL derived from your deployment URL in your OAuth application.

The steps below describe how to create an OAuth Application in the Ansible Automation Platform Platform console.

Procedure
Copy link

  1. Open your Ansible Automation Platform instance in a browser and log in.
  2. Navigate to Access Management > OAuth Applications.
  3. Click Create OAuth Application.
  4. Complete the fields in the form.
    • Name: Add a name for your application.
    • Organization: Choose the organization.
    • Authorization grant type: Choose Authorization code.
    • Client type: choose Confidential.
    • Redirect URIs: Add placeholder text for the deployment URL (for example https://example.com).
      Create OAuth application
  5. Click Create OAuth application.

    The Application information popup displays the clientId and clientSecret values.

  6. Copy the clientId and clientSecret values and save them.

    These values are used in an OpenShift secret for Ansible Automation Platform authentication.

Enable Oauth token creation for external users
Copy link

Ansible automation portal uses Ansible Automation Platform or authentication and as an OAuth provider.

About this task
Copy link

You must enable OAuth token creation in Ansible Automation Platform so that users can authenticate with the platform from Ansible automation portal.

Note

Users who do not have permission to log in to Ansible Automation Platform cannot log in to Self-service portal, because Ansible Automation Platform provides the OAuth tokens. Therefore, a user who is removed from an external IdP (for example LDAP, SAML, Azure) can no longer log into Ansible Automation Platform or Ansible automation portal. This prevents potential external token issues. For more information, refer to the Manage OAuth2 token creation for external users section of Configure central authentication for Ansible Automation Platform.

Procedure
Copy link

  1. In a browser, log in to your Ansible Automation Platform instance as a user with admin privileges.
  2. In the navigation pane, select Settings > Platform gateway.
  3. Locate the Allow external users to create OAuth2 tokens setting.
  4. Enable Allow external users to create OAuth2 tokens if it is not already enabled:
    1. Click Edit platform gateway settings.
    2. Set Allow external users to create OAuth2 tokens to Enabled.
      Allow external users to create OAuth2 tokens setting
    3. Click Save platform gateway settings to save your updates and return to the Platform gateway settings page.
  5. In the Platform gateway settings page, verify that the Allow external users to create OAuth2 tokens setting is enabled.

Generate an API token for Ansible Automation Platform authentication
Copy link

You must create an API token in Ansible Automation Platform. The token is used in an OpenShift secret for Ansible Automation Platform authentication.

Procedure
Copy link

  1. Log in to your instance of Ansible Automation Platform as a user with Ansible Automation Platform administrator privileges.
  2. Navigate to Access Management > API Tokens to display the API Tokens page.
  3. Click Create API Token.
  4. Add a description and select your OAuth application.
  5. In the Scope menu, select Write.

    Create API Token dialog showing the Scope set to Write
  6. Click Create Token to generate the token.
  7. Save the new token.

    The token is used in an OpenShift secret that is fetched by the Helm chart.