@modelcontextprotocol/sdk
    Preparing search index...

    Function startAuthorization

    • Begins the authorization flow with the given server, by generating a PKCE challenge and constructing the authorization URL.

      Parameters

      • authorizationServerUrl: string | URL
      • __namedParameters: {
            clientInformation: {
                client_id: string;
                client_id_issued_at?: number;
                client_secret?: string;
                client_secret_expires_at?: number;
            };
            metadata?: objectOutputType<
                {
                    authorization_endpoint: ZodString;
                    code_challenge_methods_supported: ZodOptional<
                        ZodArray<ZodString, "many">,
                    >;
                    grant_types_supported: ZodOptional<ZodArray<ZodString, "many">>;
                    introspection_endpoint: ZodOptional<ZodString>;
                    introspection_endpoint_auth_methods_supported: ZodOptional<
                        ZodArray<ZodString, "many">,
                    >;
                    introspection_endpoint_auth_signing_alg_values_supported: ZodOptional<
                        ZodArray<ZodString, "many">,
                    >;
                    issuer: ZodString;
                    registration_endpoint: ZodOptional<ZodString>;
                    response_modes_supported: ZodOptional<ZodArray<ZodString, "many">>;
                    response_types_supported: ZodArray<ZodString, "many">;
                    revocation_endpoint: ZodOptional<ZodString>;
                    revocation_endpoint_auth_methods_supported: ZodOptional<
                        ZodArray<ZodString, "many">,
                    >;
                    revocation_endpoint_auth_signing_alg_values_supported: ZodOptional<
                        ZodArray<ZodString, "many">,
                    >;
                    scopes_supported: ZodOptional<ZodArray<ZodString, "many">>;
                    service_documentation: ZodOptional<ZodString>;
                    token_endpoint: ZodString;
                    token_endpoint_auth_methods_supported: ZodOptional<
                        ZodArray<ZodString, "many">,
                    >;
                    token_endpoint_auth_signing_alg_values_supported: ZodOptional<
                        ZodArray<ZodString, "many">,
                    >;
                },
                ZodTypeAny,
                "passthrough",
            >;
            redirectUrl: string
            | URL;
            resource?: URL;
            scope?: string;
            state?: string;
        }

      Returns Promise<{ authorizationUrl: URL; codeVerifier: string }>