Setup API Client

Set up Machine-to-Machine (M2M) authentication for automated integrations and CI/CD pipelines.

​

SaaS Customers

When contacting support, please provide:

• Your organization name
• Intended use case (CI/CD, automation, integration)
• Any specific permission requirements

You will receive:

• Client ID - Your API client identifier
• Client Secret - Your secure API key
• Auth URL - Your authentication endpoint

Once you receive your credentials, proceed to M2M Authentication.

​

On-Premises Customers

On-Premises customers have full access to Keycloak and can create API clients directly.

​

Step 1: Navigate to Keycloak

1. Open your Keycloak Admin Console: https://<YOUR_KEYCLOAK_HOST>/admin
2. Log in with your administrator credentials.

​

Step 2: Select Realm

1. Near the top-left corner, click Manage realms
2. Select BinarlyRealm from the list
3. Verify you are in the correct realm

​

Step 3: Create a Client

1. Select Clients from the left-hand menu.
2. Click Create client.

​

General Settings

• Client type: OpenID Connect
• Client ID: Enter a descriptive ID (e.g., api-client or ci-cd-automation).
• Name: (Optional) Enter a friendly name.

Click Next.

​

Capability Config

• Client authentication: On (This enables Client Credentials).
• Authorization: Off (unless specifically required).
• Authentication flow:
  • Set Service accounts roles only

Click Next and then Save.

​

Step 4: Obtain Credentials

1. After saving, select the Credentials tab at the top of the client details page.
2. Copy the Client Secret. This is your secure key for API access.

​

Next Steps

Now that you have your Client ID and Secret, you are ready to generate an access token. Go to M2M Authentication ->