@scalar/api-reference/dist/components/Content/Auth/helpers/get-default-security.d.ts

Generate beautiful API references from OpenAPI documents

import type { MergedSecuritySchemes } from '@scalar/api-client/v2/blocks/scalar-auth-selector-block';
import type { AuthenticationConfiguration } from '@scalar/types/api-reference';
import type { SecurityRequirementObject, SecuritySchemeObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
/**
 * Extracts the default scopes for a security scheme.
 * Only OAuth2 schemes can have default scopes via the x-default-scopes extension.
 */
export declare const getDefaultScopes: (scheme: SecuritySchemeObject | undefined) => string[];
/**
 * Determines the default security scheme to use for an operation.
 *
 * Priority order:
 * 1. User-configured preferred security scheme (if provided)
 * 2. First security requirement from the OpenAPI spec
 * 3. null (no security required)
 */
export declare const getDefaultSecurity: (securityRequirements: SecurityRequirementObject[], preferredSecurityScheme: AuthenticationConfiguration["preferredSecurityScheme"], securitySchemes: MergedSecuritySchemes) => SecurityRequirementObject | null;
//# sourceMappingURL=get-default-security.d.ts.map