lti-tool Documentation
    Preparing search index...

    Variable RegistrationResponseSchemaConst

    RegistrationResponseSchema: ZodObject<
        {
            application_type: ZodLiteral<"web">;
            client_id: ZodString;
            client_name: ZodString;
            contacts: ZodOptional<ZodArray<ZodEmail>>;
            grant_types: ZodArray<
                ZodEnum<
                    { client_credentials: "client_credentials"; implicit: "implicit" },
                >,
            >;
            "https://purl.imsglobal.org/spec/lti-tool-configuration": ZodObject<
                {
                    claims: ZodArray<ZodString>;
                    custom_parameters: ZodOptional<ZodRecord<ZodString, ZodString>>;
                    deployment_id: ZodOptional<ZodString>;
                    domain: ZodString;
                    messages: ZodArray<
                        ZodDiscriminatedUnion<
                            [
                                ZodObject<{ type: ZodLiteral<"LtiResourceLinkRequest"> }, $strip>,
                                ZodObject<
                                    {
                                        custom_parameters: ZodOptional<ZodRecord<(...), (...)>>;
                                        label: ZodOptional<ZodString>;
                                        placements: ZodOptional<ZodArray<(...)>>;
                                        roles: ZodOptional<ZodArray<(...)>>;
                                        supported_media_types: ZodOptional<ZodArray<(...)>>;
                                        supported_types: ZodOptional<ZodArray<(...)>>;
                                        target_link_uri: ZodOptional<ZodURL>;
                                        type: ZodLiteral<"LtiDeepLinkingRequest">;
                                    },
                                    $strip,
                                >,
                            ],
                            "type",
                        >,
                    >;
                    target_link_uri: ZodOptional<ZodURL>;
                    version: ZodOptional<ZodString>;
                },
                $strip,
            >;
            initiate_login_uri: ZodURL;
            jwks_uri: ZodURL;
            logo_uri: ZodUnion<[ZodOptional<ZodURL>, ZodLiteral<"">]>;
            redirect_uris: ZodArray<ZodURL>;
            registration_access_token: ZodOptional<ZodString>;
            registration_client_uri: ZodOptional<ZodURL>;
            response_types: ZodArray<ZodLiteral<"id_token">>;
            scope: ZodUnion<[ZodOptional<ZodString>, ZodLiteral<"">]>;
            token_endpoint_auth_method: ZodLiteral<"private_key_jwt">;
        },
        $strip,
    > = ...

    Zod schema for validating LTI 1.3 dynamic registration response from platforms. This response is returned after successfully registering a tool with an LTI platform. Contains the registered client credentials and configuration that the tool needs to store.