Authentication

Authentication

The License Hub Platform API supports the following methods to authenticate requests. Individual operations in the documentation will include their specific authentication types.


enterprise_admin

Supported on SSP Installer, License Hub, and SSP instance types. Provide the username and password in the Authorization header using the Basic scheme (RFC 1945). The credentials must be a base64-encoded string of username:password. Sample curl commands:

  • curl -H "Authorization: Basic <base64_auth_params>" https://api.example.com
  • curl -u "username:password" https://api.example.com


Type : apiKey
In : header
Name : Authorization

auditor

Supported on SSP Installer, License Hub, and SSP instance types. Provide the username and password in the Authorization header using the Basic scheme (RFC 1945). The credentials must be a base64-encoded string of username:password. Sample curl commands:

  • curl -H "Authorization: Basic <base64_auth_params>" https://api.example.com
  • curl -u "username:password" https://api.example.com


Type : apiKey
In : header
Name : Authorization

security_engineer

Supported on SSP instance type only. Provide the username and password in the Authorization header using the Basic scheme (RFC 1945). The credentials must be a base64-encoded string of username:password. Sample curl commands:

  • curl -H "Authorization: Basic <base64_auth_params>" https://api.example.com
  • curl -u "username:password" https://api.example.com


Type : apiKey
In : header
Name : Authorization

security_op

Supported on SSP instance type only. Provide the username and password in the Authorization header using the Basic scheme (RFC 1945). The credentials must be a base64-encoded string of username:password. Sample curl commands:

  • curl -H "Authorization: Basic <base64_auth_params>" https://api.example.com
  • curl -u "username:password" https://api.example.com


Type : apiKey
In : header
Name : Authorization

support_bundle_collector

Supported on SSP Installer, License Hub, and SSP instance types. Provide the username and password in the Authorization header using the Basic scheme (RFC 1945). The credentials must be a base64-encoded string of username:password. Sample curl commands:

  • curl -H "Authorization: Basic <base64_auth_params>" https://api.example.com
  • curl -u "username:password" https://api.example.com


Type : apiKey
In : header
Name : Authorization

license_admin

Supported on License Hub instance type only. Allowed for user with license admin role


Type : apiKey
In : header
Name : license_admin

license_auditor

Supported on License Hub instance type only. Allowed for user with license auditor role


Type : apiKey
In : header
Name : auditor