Module objects 

Generated transport-independent contract objects.

Structs

Application

The configuration and status of an Application. An Application belongs to one Project and cannot move to another. You cannot use the ID of a deleted Application again.

ApplicationConfiguration

The exact redirect URIs and the resource scopes that the Application can request. The Application calls the API of the stack that owns its Project. Each user still approves the scopes, and the user’s current permissions still apply. setupUrl returns the browser after installation setup. It uses HTTPS (or HTTP on loopback) and receives installation_id, setup_action and optional state; the Application checks the actual grant through the API. redirectOnUpdate also returns after changes to an existing installation; it defaults to false and requires setupUrl. installOnSignIn defaults to false. When enabled, sign-in requires an active installation and lets an Organization owner install during user consent. allowedCorsOrigins lists the exact browser origins (scheme, host and port) whose scripts may obtain tokens and call ScanDAL as the Application.

ApplicationPage

ApplicationPage contract value.

ApplicationScope

ApplicationScope contract value.

ApplicationScopes

ApplicationScopes contract value.

BackgroundIdentity

An OpenID Connect identity of the Application’s backend, such as a cloud service account. backgroundIdentity applies to installation tokens; jwtBearerIssuers applies to app tokens. A token must come from issuer and carry every listed claim value.

ClientAppAccess

ClientAppAccess contract value.

ConsentClient

The verified OAuth client and callback shown by the consent application.

ConsentDecision

Accept only the listed requested scopes, or reject the authorization.

ConsentRedirect

Return the initiating browser to this authorization-server URL to finish consent.

ConsentRequest

The requested delegation. A challenge contains no access or refresh token.

ConsentSubject

The authenticated user and Organization bound to this authorization.

InstallableApplication

Application details for an Organization member to review before installation. Credentials, sign-in callbacks and developer Project configuration are not included. The registered setup URL identifies where the browser returns after setup.

Installation

An Application installed in one Organization, where it acts as its own identity. requested is the latest request. approved is what an Organization owner approved, and it is the only grant that Spiral enforces. A request for more access takes effect only when an owner approves it.

InstallationDetails

Installation metadata and its API audience. configurationUrl is the Studio page where an Organization member changes this installation; it carries no state, so append your own. configurationUrl is absent when the deployment does not name its Studio.

InstallationGrant

InstallationGrant contract value.

InstallationPage

InstallationPage contract value.

InstallationProject

InstallationProject contract value.

InstallationProjectPage

InstallationProjectPage contract value.

InstallationProjects

Every Project in the Organization, including Projects created later, when all is true. Otherwise, only the listed Projects.

InstallationRequest

InstallationRequest contract value.

InstallationReview

Approve or decline the exact request shown to an Organization owner. A changed request returns Conflict and must be reviewed again. Declining an update preserves the existing approval; declining a new installation removes the request.

InstallationStatusChange

InstallationStatusChange contract value.

InstallationSummary

approvedAllProjects is true when the approved grant covers every Project in the Organization, including Projects created later, and false when it covers only listed Projects. It is absent while no grant is approved, and approvedScopes is then empty.

ListApplicationsRequest

ListApplicationsRequest contract value.

OrganizationAppAccess

The Applications and MCP clients that the users of an Organization can sign in to. The decision for a listed client applies first. unlisted applies to every other client.

UserInstallation

Setup state for the caller’s app and Organization. An absent installation means setup has not started. configurationUrl is the Studio page for this app and Organization: it starts setup when there is no installation and changes the existing one otherwise. It depends only on the app and Organization, so it is here and not on the installation. It carries no state, so append your own. It is absent when the deployment does not name its Studio. Project enumeration uses the user installation project list.

Enums

AppAccessDecision

AppAccessDecision contract value.

ApplicationAudience

Who can sign in to the Application. internal admits only users of the Organization that owns the Application’s Project. public also admits users of other Organizations after Spiral reviews the Application, subject to the app access of each Organization.

ApplicationStatus

ApplicationStatus contract value.

AppsError

Typed errors declared by this service contract.

InstallationStatus

InstallationStatus contract value.

UnlistedAppAccess

What happens to an Application that the Organization did not list. allow_reviewed allows Applications that Spiral reviewed. block blocks all of them.