Chapter 1. Creating the Red Hat automation hub API token
Before you can interact with automation hub by uploading or downloading collections, you must create an API token. The automation hub API token authenticates your ansible-galaxy
client to the Red Hat automation hub server.
You can create an API token by using Token management in automation hub or API Token Management in private automation hub (PAH).
1.1. Creating the Red Hat automation hub API token
Before you can interact with automation hub by uploading or downloading collections, you need to create an API token. The automation hub API token authenticates your ansible-galaxy
client to the Red Hat automation hub server.
You can create an API token using automation hub Token management.
Prerequisites
- Valid subscription credentials for Red Hat Ansible Automation Platform.
Procedure
- Navigate to https://cloud.redhat.com/ansible/automation-hub/token/.
- Click .
- Click icon to copy the API token to the clipboard.
- Paste the API token into a file and store in a secure location.
The API token is a secret token used to protect your content. Store your API token in a secure location.
The API token is now available for configuring automation hub as your default collections server or uploading collections using the ansible-galaxy
command line tool.
1.2. Creating the API token in private automation hub
You can create an API token by using API Token Management in private automation hub.
Prerequisites
- Valid subscription credentials for Red Hat Ansible Automation Platform.
Procedure
- Navigate to your PAH.
-
From the sidebar, navigate to
. - Click .
- Click the copy icon to copy the API token to the clipboard.
- Paste the API token into a file and store in a secure location.
The API token is a secret token used to protect your content. Store your API token in a secure location.
The API token is now available for configuring automation hub as your default collections server or uploading collections using the ansible-galaxy
command line tool.
1.3. Keeping your offline token active
Keeping an offline token active is useful when an application needs to perform action on behalf of the user, even when the user is offline. For example, a routine data backup.
Offline tokens expire after 30 days of inactivity. You can keep your offline token from expiring by periodically refreshing your offline token.
Once your offline token expires, you must request a new one.
Run the following command periodically to prevent your token from expiring:
curl https://sso.redhat.com/auth/realms/redhat-external/protocol/openid-connect/token -d grant_type=refresh_token -d client_id="cloud-services" -d refresh_token="{{ user_token }}" --fail --silent --show-error --output /dev/null