@devopness/sdk-js/dist/api/generated/models/source-provider-auth-method-settings.d.ts

Devopness API JS/TS SDK - Painless essential DevOps to everyone

/**
 * devopness API
 * Devopness API - Painless essential DevOps to everyone
 *
 * The version of the OpenAPI document: latest
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import { ProviderCallbackConfig } from './provider-callback-config';
import { ProviderInputSettings } from './provider-input-settings';
/**
 * Authentication method settings for source providers
 * @export
 * @interface SourceProviderAuthMethodSettings
 */
export interface SourceProviderAuthMethodSettings {
    /**
     * The authentication type identifier
     * @type {string}
     * @memberof SourceProviderAuthMethodSettings
     */
    auth_type: string;
    /**
     * Human-readable name for the authentication method
     * @type {string}
     * @memberof SourceProviderAuthMethodSettings
     */
    auth_type_human_readable?: string;
    /**
     * Hint text explaining the authentication flow
     * @type {string}
     * @memberof SourceProviderAuthMethodSettings
     */
    hint?: string;
    /**
     * Whether this authentication method is recommended for this provider
     * @type {boolean}
     * @memberof SourceProviderAuthMethodSettings
     */
    recommended?: boolean;
    /**
     * The URL to redirect the user for authentication. For OAuth methods, this is the authorization URL. For application installation methods (e.g., GitHub App), this is the installation URL.
     * @type {string}
     * @memberof SourceProviderAuthMethodSettings
     */
    connect_url?: string;
    /**
     * The list of input settings for credentials of specific provider
     * @type {Array<ProviderInputSettings>}
     * @memberof SourceProviderAuthMethodSettings
     */
    input_settings: Array<ProviderInputSettings>;
    /**
     * Configuration mapping for extracting authentication parameters from OAuth/provider callback URLs.
     * @type {Array<ProviderCallbackConfig>}
     * @memberof SourceProviderAuthMethodSettings
     */
    provider_config?: Array<ProviderCallbackConfig>;
}