The Prisma AIRS API supports both API Key and OAuth 2.0 token-based
authentication methods for scan submissions. OAuth 2.0 token authentication
addresses several limitations of using API Keys exclusively, including the
maximum limit of API Keys per application, the requirement for SCM web interface
access to fetch API keys, and information security recommendations for using
industry-standard authentication protocols.
With OAuth 2.0 token authentication, administrators can distribute credentials to
authorized users or service accounts with specific roles. These users can then
generate OAuth tokens and use them in automation scripts and other integrations.
This approach aligns with information security best practices while providing
more flexible authentication options.
OAuth 2.0 tokens for AIRS API have configurable validity periods ranging from 1
hour to 30 days. However, these tokens are bound by the API Key expiration. That
is, even if a token was generated with a longer validity period, it will cease
to work once the underlying API Key expires. When generated through the SCM web
interface, OAuth tokens have a default validity of 24 hours and are displayed
only once.
The system applies the same quota policies to scan submissions regardless of
whether they use API Key or OAuth 2.0 token authentication. This ensures
consistent resource allocation and management across all authentication
methods.
Before configuring OAuth 2.0 token authentication, administrators should
understand the relationship between application roles, API Keys, and OAuth
tokens. The super user role has privileges to generate and manage both API Keys
and OAuth tokens, while other roles may have more limited permissions based on
their assigned capabilities. For reporting purposes, all scan submissions are
logged with the associated API key identifier, regardless of whether the actual
submission used an API Key or OAuth token.