Skip to main content

Registering Mondoo Client Using a Credentials File

Mondoo Client must be registered with Mondoo Platform in order to authenticate, download policies, and report results. Typically you register Mondoo Client using a temporary token. However, to ease automation, you may need to use a client credentials file instead. A common example is when you're integrating Mondoo into your CI/CD pipeline.

danger

The credentials file includes a private key. Keep this credential safe!

  1. Open the Mondoo Console.
  2. Select the space where you want to register your Mondoo Client.
  3. Select the INTEGRATIONS tab.
  4. Select Add Another Integration.
  5. Select Generate Long-Lived Credentials.
  6. Select Download Credentials from the left sidebar.
  7. Select Generate New Credentials.

This generates a new credentials JSON string for you copy to a file.

Validating registration

The mondoo status command validates Mondoo Client registration and ensures that communication with Mondoo Platform is successful.

Unregistered Mondoo Client
mondoo status
→ API ConnectionConfig:    https://us.api.mondoo.com
→ API Status:    SERVING
→ API Version:    6
→ Space:
x client is not registered
x could not connect to mondoo platform
Correctly registered Client
mondoo status
→ API ConnectionConfig: https://us.api.mondoo.com
→ API Status: SERVING
→ API Version: 6
→ Space: //captain.api.mondoo.app/spaces/gallant-kilby-587371
→ Client: //agents.api.mondoo.app/spaces/gallant-kilby-587371/agents/1N9EGTzvlizF1n7vPtz21y7XFA3
→ Service Account: //agents.api.mondoo.app/spaces/gallant-kilby-587371/serviceaccounts/1N9EGTzvlizF1n7vPtz21y7XFA3
→ client is registered
→ client authenticated successfully
Invalid Mondoo Client registration
mondoo status
→ Space: //captain.api.mondoo.app/spaces/gallant-kilby-587371
→ Client: //agents.api.mondoo.app/spaces/gallant-kilby-587371/agents/1N9EGTzvlizF1n7vPtz21y7XFA3
→ Service Account: //agents.api.mondoo.app/spaces/gallant-kilby-587371/serviceaccounts/1N9EGTzvlizF1n7vPtz21y7XFA3
→ client is registered
x could not connect to mondoo platform error="rpc error: code = Unauthenticated desc = request permission unauthenticated"
No current system time (clock skew detected)
mondoo status
→ Space: //captain.api.mondoo.app/spaces/gallant-kilby-587371
→ Client: //agents.api.mondoo.app/spaces/gallant-kilby-587371/agents/1N9EGTzvlizF1n7vPtz21y7XFA3
→ Service Account: //agents.api.mondoo.app/spaces/gallant-kilby-587371/serviceaccounts/1N9EGTzvlizF1n7vPtz21y7XFA3
→ client is registered
x could not connect to mondoo platform error="rpc error: code = Unauthenticated desc = request permission unauthenticated"
! possible clock skew detected: 27m55.32301447s