@appsemble/utils
Version:
Utility functions used in Appsemble internally
58 lines • 2.01 kB
JavaScript
export const AppServiceSecret = {
type: 'object',
description: 'App service secret settings',
required: ['urlPatterns', 'authenticationMethod'],
additionalProperties: false,
properties: {
id: {
type: 'number',
description: 'An autogenerated ID.',
readOnly: true,
},
name: {
type: 'string',
description: 'An optional name to give extra clarity what the secret is used for.',
},
urlPatterns: {
type: 'string',
description: 'The url pattern that is matched when a proxied request action is called.',
},
authenticationMethod: {
enum: [
'http-basic',
'client-certificate',
'client-credentials',
'cookie',
'custom-header',
'query-parameter',
],
description: 'The method to authenticate the request action with.',
},
identifier: {
type: 'string',
description: 'The parameter name, header name, username or certificate that goes with the secret.',
},
secret: {
type: 'string',
description: 'The secret to authenticate the proxied outgoing request with.',
},
tokenUrl: {
type: 'string',
description: 'The URL to request access tokens from.',
},
scope: {
type: 'string',
description: 'The scope to request access tokens for.',
},
public: {
type: 'boolean',
description: 'If a secret is marked public, it can be applied to the unauthenticated users, e.g. in the requests originating in a custom sign up or login page.',
default: false,
},
ca: {
type: 'string',
description: 'The custom certificate authority.',
},
},
};
//# sourceMappingURL=AppServiceSecret.js.map