diff --git a/.changeset/friendly-olives-breathe.md b/.changeset/friendly-olives-breathe.md new file mode 100644 index 0000000000..9dce3b9709 --- /dev/null +++ b/.changeset/friendly-olives-breathe.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-auth-backend': patch +--- + +Added configuration schema for the commonly used properties diff --git a/plugins/auth-backend/config.d.ts b/plugins/auth-backend/config.d.ts new file mode 100644 index 0000000000..c971528e14 --- /dev/null +++ b/plugins/auth-backend/config.d.ts @@ -0,0 +1,71 @@ +/* + * Copyright 2020 Spotify AB + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +export interface Config { + /** Configuration options for the auth plugin */ + auth?: { + /** + * The 'environment' attribute + * @visibility frontend + */ + environment?: string; + + session?: { + /** + * The secret attribute of session object. + * @visibility secret + */ + secret?: string; + }; + + /** + * The available auth-provider options and attributes + */ + providers?: { + google?: { + development: { [key: string]: string }; + }; + github?: { + development: { [key: string]: string }; + }; + gitlab?: { + development: { [key: string]: string }; + }; + saml?: { + entryPoint: string; + issuer: string; + }; + okta?: { + development: { [key: string]: string }; + }; + oauth2?: { + development: { [key: string]: string }; + }; + oidc?: { + development: { [key: string]: string }; + }; + auth0?: { + development: { [key: string]: string }; + }; + microsoft?: { + development: { [key: string]: string }; + }; + onelogin?: { + development: { [key: string]: string }; + }; + }; + }; +} diff --git a/plugins/auth-backend/package.json b/plugins/auth-backend/package.json index 1c9ebbe261..dc452b45f2 100644 --- a/plugins/auth-backend/package.json +++ b/plugins/auth-backend/package.json @@ -83,25 +83,5 @@ "dist", "migrations" ], - "configSchema": { - "$schema": "https://backstage.io/schema/config-v1", - "title": "@backstage/auth-backend", - "type": "object", - "properties": { - "auth": { - "type": "object", - "properties": { - "session": { - "type": "object", - "properties": { - "secret": { - "type": "string", - "visibility": "secret" - } - } - } - } - } - } - } + "configSchema": "config.d.ts" }