Skip to main content

Authorization

Follow this guide to create a new USAJOBS credential that will allow Nexla to authenticate to and exchange data with your USAJOBS account.
usajobs_api_auth.png

USAJobs

Prerequisites​

Before creating a USAJOBS credential, you need to obtain your API Key from your USAJOBS Developer account. USAJOBS uses API key authentication for all API requests, with the key sent as a Bearer token in the Authorization-Key header.

To obtain your USAJOBS API key, follow these steps:

  1. Sign in to your USAJOBS account using your administrator credentials.

  2. Navigate to the USAJOBS Developer Portal or visit developer.usajobs.gov to access your developer account.

  3. If you don't have a developer account yet, click Sign up or Register and complete the registration process. You may need to provide information about your intended use of the USAJOBS API.

  4. Once you have access to the USAJOBS Developer Portal, navigate to API Keys or My API Keys to access your API key management.

  5. If you don't have an API key yet, click Create API Key or Generate API Key to create a new API key.

  6. Configure your API key settings:

    • Enter a name for the API key (e.g., "Nexla Integration")
    • Review and accept the USAJOBS API Terms of Service
    • Click Create or Generate to create the API key

  7. After the API key is created, copy the API Key value immediately, as it may not be accessible again after you navigate away from the page.

  8. Store the API key securely, as you will need it to configure your Nexla credential. The API key is sensitive information and should be kept confidential.

The API key is sent as a Bearer token in the Authorization-Key header for all API requests to the USAJOBS API. The key authenticates your requests and grants access to USAJOBS resources based on your account permissions. If your API key is compromised, you should immediately revoke it in your USAJOBS Developer Portal and generate a new one. For detailed information about obtaining API keys, API authentication, and available endpoints, refer to the USAJOBS API documentation.

Create a USAJOBS Credential​

  • To create a new USAJOBS credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – USAjobs

USAJobsCred.png

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

API Key Authentication​

USAJOBS uses API key authentication for all API requests. The API key is sent as a Bearer token in the Authorization-Key header, along with User-Agent and Host headers.

  1. Enter your User Agent in the User Agent field. This should be a string that identifies your application (e.g., "Nexla Integration" or your organization name). The User Agent is sent in the User-Agent header for all API requests to the USAJOBS API. This field is required.

  2. Enter your Host in the Host field. This should be the hostname for the USAJOBS API (typically data.usajobs.gov). The Host is sent in the Host header for all API requests to the USAJOBS API. The default value is data.usajobs.gov. This field is required.

  3. Enter your API Key Value in the API Key Value field. This is the API key you obtained from your USAJOBS Developer Portal (API Keys or My API Keys). The API key is sent as a Bearer token in the Authorization-Key header for all API requests to the USAJOBS API. The API key is sensitive information and must be kept confidential.

    Your USAJOBS API key can be found in the USAJOBS Developer Portal under API Keys or My API Keys. The API key is sent as a Bearer token in the Authorization-Key header for all API requests to the USAJOBS API, along with User-Agent and Host headers.

    If your API key is compromised, you should immediately revoke it in your USAJOBS Developer Portal and generate a new one. The API key provides access to your USAJOBS account data and should be treated as sensitive information. Keep your API key secure and do not share it publicly.

    For detailed information about obtaining API keys, API authentication, and available endpoints, see the USAJOBS API documentation and USAJOBS Developer Portal.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.