mirror of
https://github.com/outline/outline.git
synced 2026-11-20 21:23:06 +03:00
* chore: Move shared/types.ts to shared/types/index.ts * chore: Split shared/types into domain files shared/types/index.ts re-exports every file, so imports from @shared/types do not change. No definitions are changed. * docs: Add JSDoc to all exports in shared/types
45 lines
1.0 KiB
TypeScript
45 lines
1.0 KiB
TypeScript
/** Available user roles. */
|
|
export enum UserRole {
|
|
Admin = "admin",
|
|
Member = "member",
|
|
Viewer = "viewer",
|
|
Guest = "guest",
|
|
}
|
|
|
|
/** Scopes for OAuth and API keys. */
|
|
export enum Scope {
|
|
Read = "read",
|
|
Write = "write",
|
|
Create = "create",
|
|
}
|
|
|
|
/** The method used to authenticate a request. */
|
|
export enum AuthenticationType {
|
|
API = "api",
|
|
APP = "app",
|
|
MCP = "mcp",
|
|
OAUTH = "oauth",
|
|
}
|
|
|
|
/** The client application that a user signs in from. */
|
|
export enum Client {
|
|
Web = "web",
|
|
Desktop = "desktop",
|
|
}
|
|
|
|
/** Settings stored on an AuthenticationProvider for group synchronization. */
|
|
export interface AuthenticationProviderSettings {
|
|
/** Whether group sync from this provider is enabled. */
|
|
groupSyncEnabled?: boolean;
|
|
/**
|
|
* The claim path in the OIDC userinfo/id_token response that contains
|
|
* group data (e.g. "groups", "roles", "custom.groups").
|
|
*/
|
|
groupClaim?: string;
|
|
/**
|
|
* Additional scopes to request when group sync is enabled
|
|
* (e.g. "groups" for OIDC).
|
|
*/
|
|
groupSyncScopes?: string[];
|
|
}
|