Infraon API Guide
Product DocsSchemaAuthentication
  • Welcome
    • Base URL
    • Authorization
    • Responses
  • Modules
    • Schema
    • Authentication
    • Announcement
    • API Registration
    • Async Tasks
    • BusinessRule
    • BusinessServiceConfiguration
    • Service Catalogue
    • CMDBBlacklistWhitelist
    • CMDBCategory
    • CMDBConsumables
    • Ux
    • CMDBSoftwareLicense
    • Cmdb
    • CMDBRelation
    • CMDBSoftware
    • ContractManagement
    • Department
    • Events
    • Field Configuration
    • IMACD
    • Knowledge Base
    • Leaves
    • Chat
    • Marketplace
    • APIViewSet
    • BeepViewSet
    • SMSviewset
    • Suppressedviewset
    • Organization Location
    • Partner
    • Predicted Events
    • Requester
    • Service Feasibility Requests
    • Role Profile
    • Tag
    • Service_outage
    • Teams
    • Telecom Settings
    • Trap Configurations
    • User Profile
    • Vendor Managemment
    • Association Events
    • Device Template
    • Discovery Configuration
    • Jobs
    • MIB Explorer
    • Seasonal Events
    • IPAM
    • Log Grok Pattern Configuration
    • Log Pipeline Configuration
    • Log Integraion
    • Log Search
    • CLI Download Jobs
    • Configuration Profiles
    • Configuration Policies
    • Configuration Rules
    • Configuration Search
    • Configuration Template
    • Configuration Trigger
    • Jobs Account Audit
    • Manage Vulnerabilities
    • OS Image Download
    • Rule Group
    • Configuration Upload Jobs
    • Work Flow Jobs
    • Change
    • Checklist
    • Incident
    • Problem
    • Release
    • Request Process
    • Task
    • Models
Powered by GitBook
On this page
  • Authentication Method
  • Example Format:
  • Authorizing via Swagger UI
  • Steps to Authorize:
  • Authorizing Specific Endpoints
  • Once Authorized, You Can:
  • Logging Out
  1. Welcome

Authorization

All API requests to Infraon Infinity must be authenticated to ensure secure access and data protection. We use API key-based authentication via the Authorization header.

Authentication Method

httpCopyEditType: ApiKeyAuth
Location: header
Header Name: Authorization

Example Format:

makefileCopyEditAuthorization: ApiKey YOUR_API_KEY

You must include this header in every request to access secured endpoints.


Authorizing via Swagger UI

You can easily test and authorize API requests through the Swagger UI interface.

Tip: Use the Authorize button to quickly apply your API key for all endpoints in the Swagger UI.

Steps to Authorize:

  1. Click the 🔐 Authorize button at the top-right of the Swagger page.

  2. In the dialog, you'll see:

    • Name: Authorization

    • In: header

    • Type: apiKey

  3. Paste your API key into the Value field.

  4. Click Authorize.


Authorizing Specific Endpoints

You can authorize individual endpoints for more granular control:

  1. Click the lock icon next to any endpoint in the Swagger UI.

  2. Choose ApiKeyAuth (apiKey).

  3. Click Authorize to apply authentication to that endpoint.


Once Authorized, You Can:

  • Execute secured API calls directly from Swagger

  • View detailed responses, payloads, and headers

  • Test various scenarios using your API key’s access level


Logging Out

To remove your credentials:

  • Click the Authorize button again

  • Select Logout

PreviousBase URLNextResponses

Last updated 1 month ago