@oneplatform/plugin-sdk / AuthProviderMetadata

Interface: AuthProviderMetadata¶

Defined in: packages/plugin-sdk/src/types/metadata.ts:103

Extends¶

BaseMetadata

Properties¶

author¶

author: string

Defined in: packages/plugin-sdk/src/types/metadata.ts:25

Plugin author name or organization.

Inherited from¶

BaseMetadata.author

configSchema¶

configSchema: JSONSchema

Defined in: packages/plugin-sdk/src/types/metadata.ts:31

JSON Schema for the tenant-admin configuration form.

Inherited from¶

BaseMetadata.configSchema

description¶

description: string

Defined in: packages/plugin-sdk/src/types/metadata.ts:19

Brief description shown in the marketplace. 10-500 characters.

Inherited from¶

BaseMetadata.description

icon?¶

optional icon?: string

Defined in: packages/plugin-sdk/src/types/metadata.ts:28

URL or data URI for the plugin icon. PNG or SVG, max 64KB.

Inherited from¶

BaseMetadata.icon

id¶

id: string

Defined in: packages/plugin-sdk/src/types/metadata.ts:13

Must match manifest.id exactly.

Inherited from¶

BaseMetadata.id

name¶

name: string

Defined in: packages/plugin-sdk/src/types/metadata.ts:16

Human-readable display name. 2-100 characters.

Inherited from¶

BaseMetadata.name

protocol¶

protocol: "oauth2" | "saml" | "oidc" | "ldap" | "custom"

Defined in: packages/plugin-sdk/src/types/metadata.ts:107

The identity protocol this provider implements.

scopes?¶

optional scopes?: string[]

Defined in: packages/plugin-sdk/src/types/metadata.ts:119

OAuth scopes this provider supports. Shown in the admin configuration UI. Omit for non-OAuth providers.

supportsTokenRefresh¶

supportsTokenRefresh: boolean

Defined in: packages/plugin-sdk/src/types/metadata.ts:113

True if the provider implements refreshToken().

supportsTokenValidation¶

supportsTokenValidation: boolean

Defined in: packages/plugin-sdk/src/types/metadata.ts:110

True if the provider implements validateToken().

tags?¶

optional tags?: string[]

Defined in: packages/plugin-sdk/src/types/metadata.ts:34

Discoverability tags shown in the marketplace filter UI.

Inherited from¶

BaseMetadata.tags

type¶

readonly type: "auth-provider"

Defined in: packages/plugin-sdk/src/types/metadata.ts:104

version¶

version: string

Defined in: packages/plugin-sdk/src/types/metadata.ts:22

Must match manifest.version exactly.

Inherited from¶

BaseMetadata.version