@breadstone/archipel-mcp 0.0.7 → 0.0.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/data/packages/index.md +13 -6
- package/data/packages/platform-analytics/api/Class.AppInsightsAnalyticsClient.md +7 -7
- package/data/packages/platform-analytics/api/Class.DatadogAnalyticsClient.md +7 -7
- package/data/packages/platform-analytics/api/Class.SentryAnalyticsClient.md +7 -7
- package/data/packages/platform-authentication/api/{Class.AppleStrategy.md → Class.AppleConnector.md} +18 -12
- package/data/packages/platform-authentication/api/Class.AuthModule.md +3 -3
- package/data/packages/platform-authentication/api/Class.ChallengeService.md +6 -6
- package/data/packages/platform-authentication/api/Class.GithubConnector.md +79 -0
- package/data/packages/platform-authentication/api/{Class.GoogleStrategy.md → Class.GoogleConnector.md} +18 -12
- package/data/packages/platform-authentication/api/Class.MfaService.md +11 -11
- package/data/packages/platform-authentication/api/{Class.MicrosoftStrategy.md → Class.MicrosoftConnector.md} +18 -12
- package/data/packages/platform-authentication/api/Class.TotpMfaChannel.md +145 -0
- package/data/packages/platform-authentication/api/Class.VerificationService.md +7 -7
- package/data/packages/platform-authentication/api/Interface.IAuthModuleOptions.md +38 -8
- package/data/packages/platform-authentication/api/Interface.IMfaChallengeState.md +12 -12
- package/data/packages/platform-authentication/api/Variable.APPLE_AUTH_CONFIG_ENTRIES.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CALLBACK_URL.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_CLIENT_ID.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_KEY_ID.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_PRIVATE_KEY.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_SCOPE.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_APPLE_TEAM_ID.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CALLBACK_URL.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_ID.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_CLIENT_SECRET.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_GITHUB_SCOPE.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CALLBACK_URL.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_ID.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_CLIENT_SECRET.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_GOOGLE_SCOPE.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_CODE_TTL.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_EMAIL_MIN_RESEND.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_ISSUER.md +15 -0
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_CODE_TTL.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_PUSH_MIN_RESEND.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_CODE_TTL.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MFA_SMS_MIN_RESEND.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CALLBACK_URL.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_ID.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_CLIENT_SECRET.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_SCOPE.md +1 -1
- package/data/packages/platform-authentication/api/Variable.AUTH_MICROSOFT_TENANT.md +1 -1
- package/data/packages/platform-authentication/api/Variable.GITHUB_AUTH_CONFIG_ENTRIES.md +1 -1
- package/data/packages/platform-authentication/api/Variable.GOOGLE_AUTH_CONFIG_ENTRIES.md +1 -1
- package/data/packages/platform-authentication/api/Variable.MICROSOFT_AUTH_CONFIG_ENTRIES.md +1 -1
- package/data/packages/platform-authentication/api/Variable.PLATFORM_AUTHENTICATION_CONFIG_ENTRIES.md +1 -1
- package/data/packages/platform-authentication/api/Variable.SEED_ANONYMOUS_USERNAME.md +1 -1
- package/data/packages/platform-authentication/api/Variable.TOTP_MFA_PROVIDERS.md +30 -0
- package/data/packages/platform-authentication/api/index.md +7 -4
- package/data/packages/platform-blob-storage/api/Class.BlobModule.md +2 -2
- package/data/packages/platform-blob-storage/api/Interface.IAwsS3BlobProviderRegistration.md +3 -3
- package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderRegistration.md +3 -3
- package/data/packages/platform-blob-storage/api/Interface.IBlobModuleOptions.md +5 -5
- package/data/packages/platform-blob-storage/api/Interface.ICustomBlobProviderRegistration.md +3 -3
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderRegistration.md +3 -3
- package/data/packages/platform-blob-storage/api/TypeAlias.IBlobProviderRegistration.md +1 -1
- package/data/packages/{platform-core → platform-caching}/api/Class.MemoryLayeredCache.md +41 -33
- package/data/packages/platform-caching/api/Class.NoopCacheMetricsRecorder.md +158 -0
- package/data/packages/platform-caching/api/Class.RedisLayeredCache.md +296 -0
- package/data/packages/platform-caching/api/Interface.ICacheMetricsRecorder.md +122 -0
- package/data/packages/platform-caching/api/Interface.ICacheStats.md +71 -0
- package/data/packages/platform-caching/api/Interface.ILayeredCache.md +199 -0
- package/data/packages/platform-caching/api/Interface.ILayeredCacheOptions.md +76 -0
- package/data/packages/platform-caching/api/Interface.IRedisLayeredCacheOptions.md +122 -0
- package/data/packages/platform-caching/api/index.md +25 -0
- package/data/packages/platform-caching/index.md +116 -0
- package/data/packages/platform-core/api/Class.AppHealthIndicator.md +3 -3
- package/data/packages/platform-core/api/Class.ErrorTemplateService.md +5 -5
- package/data/packages/platform-core/api/Class.HostService.md +8 -8
- package/data/packages/platform-core/api/Class.ResourceManager.md +19 -19
- package/data/packages/platform-core/api/Interface.IErrorPageParams.md +10 -10
- package/data/packages/platform-core/api/Interface.IHostContentParams.md +10 -10
- package/data/packages/platform-core/api/Interface.IResourceManagerConfig.md +4 -4
- package/data/packages/platform-core/api/Variable.APP_NAME.md +15 -0
- package/data/packages/platform-core/api/Variable.GIT_COMMIT.md +15 -0
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_MAX_OUTPUT_TOKENS.md +1 -1
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_MODEL.md +1 -1
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_TEMPERATURE.md +1 -1
- package/data/packages/platform-core/api/Variable.INTELLIGENCE_TOP_P.md +1 -1
- package/data/packages/platform-core/api/Variable.NODE_ENV.md +1 -1
- package/data/packages/platform-core/api/Variable.PLATFORM_CORE_CONFIG_ENTRIES.md +1 -1
- package/data/packages/platform-core/api/index.md +106 -150
- package/data/packages/platform-core/index.md +5 -3
- package/data/packages/platform-cryptography/api/Class.BcryptService.md +73 -0
- package/data/packages/platform-cryptography/api/Class.CryptoService.md +52 -0
- package/data/packages/{platform-core → platform-cryptography}/api/Class.OtpService.md +8 -4
- package/data/packages/{platform-core → platform-cryptography}/api/Interface.IOtpService.md +8 -4
- package/data/packages/platform-cryptography/api/Interface.IOtpUriOptions.md +47 -0
- package/data/packages/{platform-core → platform-cryptography}/api/Variable.OTP_SERVICE_TOKEN.md +1 -1
- package/data/packages/{platform-core → platform-cryptography}/api/Variable.TOTP_EPOCH_TOLERANCE.md +1 -1
- package/data/packages/platform-cryptography/api/index.md +29 -0
- package/data/packages/platform-cryptography/index.md +132 -0
- package/data/packages/{platform-core → platform-intelligence}/api/Class.IntelligenceCapabilityRegistrarBase.md +7 -5
- package/data/packages/{platform-core → platform-intelligence}/api/Class.IntelligenceCapabilityRegistry.md +19 -15
- package/data/packages/{platform-core → platform-intelligence}/api/Class.IntelligenceModule.md +1 -1
- package/data/packages/{platform-core → platform-intelligence}/api/Class.IntelligenceTextGenerator.md +7 -7
- package/data/packages/platform-intelligence/api/Function.createProviderOptions.md +27 -0
- package/data/packages/platform-intelligence/api/Function.loadAnthropicLanguageModel.md +27 -0
- package/data/packages/platform-intelligence/api/Function.loadGoogleLanguageModel.md +27 -0
- package/data/packages/platform-intelligence/api/Function.loadGrokLanguageModel.md +27 -0
- package/data/packages/platform-intelligence/api/Function.loadOpenAILanguageModel.md +27 -0
- package/data/packages/platform-intelligence/api/Function.loadProviderFactory.md +32 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceArtifact.md +35 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapability.md +72 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityMetadata.md +71 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityPayload.md +47 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityRegistry.md +79 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCapabilityResult.md +47 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceCompletionUsage.md +47 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceContext.md +73 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceContextBuilder.md +36 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationMessageSnapshot.md +71 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceConversationSnapshot.md +59 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceFollowUpQuestion.md +47 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntent.md +47 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceIntentEntity.md +35 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessageModel.md +71 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceMessagePayload.md +35 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePrompt.md +35 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligencePromptMessage.md +35 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceProviderConfiguration.md +95 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceResponseMessage.md +35 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextCompletion.md +61 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerationOptions.md +47 -0
- package/data/packages/platform-intelligence/api/Interface.IIntelligenceTextGenerator.md +54 -0
- package/data/packages/{platform-core → platform-intelligence}/api/TypeAlias.IntelligenceConversationMessageRole.md +1 -1
- package/data/packages/platform-intelligence/api/TypeAlias.IntelligenceLanguageModelLoader.md +25 -0
- package/data/packages/{platform-core → platform-intelligence}/api/TypeAlias.IntelligenceProviderName.md +1 -1
- package/data/packages/{platform-core → platform-intelligence}/api/Variable.IntelligenceConversationMessageRoles.md +6 -6
- package/data/packages/platform-intelligence/api/Variable.IntelligenceProviderNames.md +29 -0
- package/data/packages/platform-intelligence/api/index.md +70 -0
- package/data/packages/platform-intelligence/index.md +131 -0
- package/data/packages/platform-mailing/api/Class.MailService.md +4 -4
- package/data/packages/platform-mailing/api/Class.MailVerificationService.md +4 -4
- package/data/packages/platform-mailing/api/Class.MailgunDeliveryStrategy.md +3 -3
- package/data/packages/platform-mailing/api/Class.PostmarkDeliveryStrategy.md +3 -3
- package/data/packages/platform-mailing/api/Class.ResendDeliveryStrategy.md +3 -3
- package/data/packages/platform-mailing/api/Class.SendGridDeliveryStrategy.md +3 -3
- package/data/packages/platform-mailing/api/Class.SmtpDeliveryStrategy.md +3 -3
- package/data/packages/platform-openapi/api/Function.SwaggerFeature.md +1 -1
- package/data/packages/platform-payments/api/Class.LemonSqueezyClient.md +6 -6
- package/data/packages/platform-payments/api/Class.MollieClient.md +6 -6
- package/data/packages/platform-payments/api/Class.PaddleClient.md +6 -6
- package/data/packages/platform-payments/api/Class.StripeClient.md +6 -6
- package/data/packages/platform-telemetry/api/Class.TelemetryCacheMetricsRecorder.md +15 -15
- package/package.json +1 -1
- package/data/packages/platform-authentication/api/Class.GithubStrategy.md +0 -73
- package/data/packages/platform-core/api/Class.BcryptService.md +0 -69
- package/data/packages/platform-core/api/Class.CryptoService.md +0 -50
- package/data/packages/platform-core/api/Class.NoopCacheMetricsRecorder.md +0 -157
- package/data/packages/platform-core/api/Class.RedisLayeredCache.md +0 -275
- package/data/packages/platform-core/api/Interface.ICacheMetricsRecorder.md +0 -121
- package/data/packages/platform-core/api/Interface.ICacheStats.md +0 -71
- package/data/packages/platform-core/api/Interface.IIntelligenceArtifact.md +0 -31
- package/data/packages/platform-core/api/Interface.IIntelligenceCapability.md +0 -62
- package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityMetadata.md +0 -61
- package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityPayload.md +0 -41
- package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityRegistry.md +0 -69
- package/data/packages/platform-core/api/Interface.IIntelligenceCapabilityResult.md +0 -41
- package/data/packages/platform-core/api/Interface.IIntelligenceCompletionUsage.md +0 -41
- package/data/packages/platform-core/api/Interface.IIntelligenceContext.md +0 -63
- package/data/packages/platform-core/api/Interface.IIntelligenceContextBuilder.md +0 -32
- package/data/packages/platform-core/api/Interface.IIntelligenceConversationMessageSnapshot.md +0 -61
- package/data/packages/platform-core/api/Interface.IIntelligenceConversationSnapshot.md +0 -51
- package/data/packages/platform-core/api/Interface.IIntelligenceFollowUpQuestion.md +0 -41
- package/data/packages/platform-core/api/Interface.IIntelligenceIntent.md +0 -41
- package/data/packages/platform-core/api/Interface.IIntelligenceIntentEntity.md +0 -31
- package/data/packages/platform-core/api/Interface.IIntelligenceMessageModel.md +0 -61
- package/data/packages/platform-core/api/Interface.IIntelligenceMessagePayload.md +0 -31
- package/data/packages/platform-core/api/Interface.IIntelligencePrompt.md +0 -31
- package/data/packages/platform-core/api/Interface.IIntelligencePromptMessage.md +0 -31
- package/data/packages/platform-core/api/Interface.IIntelligenceProviderConfiguration.md +0 -81
- package/data/packages/platform-core/api/Interface.IIntelligenceResponseMessage.md +0 -31
- package/data/packages/platform-core/api/Interface.IIntelligenceTextCompletion.md +0 -53
- package/data/packages/platform-core/api/Interface.IIntelligenceTextGenerationOptions.md +0 -41
- package/data/packages/platform-core/api/Interface.IIntelligenceTextGenerator.md +0 -46
- package/data/packages/platform-core/api/Interface.ILayeredCache.md +0 -194
- package/data/packages/platform-core/api/Interface.ILayeredCacheOptions.md +0 -71
- package/data/packages/platform-core/api/Interface.IOtpUriOptions.md +0 -47
- package/data/packages/platform-core/api/Interface.IRedisLayeredCacheOptions.md +0 -108
- package/data/packages/platform-core/api/Variable.IntelligenceProviderNames.md +0 -29
|
@@ -1,30 +1,36 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: 'Class:
|
|
2
|
+
title: 'Class: MicrosoftConnector'
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
# Class:
|
|
7
|
+
# Class: MicrosoftConnector
|
|
8
8
|
|
|
9
|
-
Defined in: [libs/platform-authentication/src/
|
|
9
|
+
Defined in: [libs/platform-authentication/src/connectors/MicrosoftConnector.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/connectors/MicrosoftConnector.ts#L20)
|
|
10
10
|
|
|
11
|
-
The `
|
|
11
|
+
The `MicrosoftConnector` integrates Microsoft OAuth authentication.
|
|
12
12
|
|
|
13
13
|
## Extends
|
|
14
14
|
|
|
15
|
-
- `
|
|
15
|
+
- `_ConnectorBase`\<_typeof_ `Strategy`, `this`\>
|
|
16
|
+
|
|
17
|
+
## Indexable
|
|
18
|
+
|
|
19
|
+
```ts
|
|
20
|
+
[key: string]: any
|
|
21
|
+
```
|
|
16
22
|
|
|
17
23
|
## Constructors
|
|
18
24
|
|
|
19
25
|
### Constructor
|
|
20
26
|
|
|
21
27
|
```ts
|
|
22
|
-
new
|
|
28
|
+
new MicrosoftConnector(socialAuth, configService): MicrosoftConnector;
|
|
23
29
|
```
|
|
24
30
|
|
|
25
|
-
Defined in: [libs/platform-authentication/src/
|
|
31
|
+
Defined in: [libs/platform-authentication/src/connectors/MicrosoftConnector.ts:36](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/connectors/MicrosoftConnector.ts#L36)
|
|
26
32
|
|
|
27
|
-
Initializes a new instance of the `
|
|
33
|
+
Initializes a new instance of the `MicrosoftConnector` class.
|
|
28
34
|
|
|
29
35
|
#### Parameters
|
|
30
36
|
|
|
@@ -35,12 +41,12 @@ Initializes a new instance of the `MicrosoftStrategy` class.
|
|
|
35
41
|
|
|
36
42
|
#### Returns
|
|
37
43
|
|
|
38
|
-
`
|
|
44
|
+
`MicrosoftConnector`
|
|
39
45
|
|
|
40
46
|
#### Overrides
|
|
41
47
|
|
|
42
48
|
```ts
|
|
43
|
-
|
|
49
|
+
ConnectorBase(Strategy, 'microsoft').constructor;
|
|
44
50
|
```
|
|
45
51
|
|
|
46
52
|
## Methods
|
|
@@ -54,7 +60,7 @@ validate(
|
|
|
54
60
|
profile): Promise<IAuthSubject>;
|
|
55
61
|
```
|
|
56
62
|
|
|
57
|
-
Defined in: [libs/platform-authentication/src/
|
|
63
|
+
Defined in: [libs/platform-authentication/src/connectors/MicrosoftConnector.ts:68](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/connectors/MicrosoftConnector.ts#L68)
|
|
58
64
|
|
|
59
65
|
Validates the Microsoft authentication payload.
|
|
60
66
|
|
|
@@ -75,5 +81,5 @@ The authenticated user.
|
|
|
75
81
|
#### Overrides
|
|
76
82
|
|
|
77
83
|
```ts
|
|
78
|
-
|
|
84
|
+
ConnectorBase(Strategy, 'microsoft').validate;
|
|
79
85
|
```
|
|
@@ -0,0 +1,145 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Class: TotpMfaChannel'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Class: TotpMfaChannel
|
|
8
|
+
|
|
9
|
+
Defined in: [libs/platform-authentication/src/mfa/channels/TotpMfaChannel.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/mfa/channels/TotpMfaChannel.ts#L16)
|
|
10
|
+
|
|
11
|
+
## Implements
|
|
12
|
+
|
|
13
|
+
- `IMfaChannel`
|
|
14
|
+
|
|
15
|
+
## Constructors
|
|
16
|
+
|
|
17
|
+
### Constructor
|
|
18
|
+
|
|
19
|
+
```ts
|
|
20
|
+
new TotpMfaChannel(
|
|
21
|
+
mfaSubject,
|
|
22
|
+
configService,
|
|
23
|
+
encryptionService,
|
|
24
|
+
otpService): TotpMfaChannel;
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Defined in: [libs/platform-authentication/src/mfa/channels/TotpMfaChannel.ts:31](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/mfa/channels/TotpMfaChannel.ts#L31)
|
|
28
|
+
|
|
29
|
+
#### Parameters
|
|
30
|
+
|
|
31
|
+
| Parameter | Type |
|
|
32
|
+
| ------------------- | ---------------------------------------- |
|
|
33
|
+
| `mfaSubject` | [`MfaSubjectPort`](Class.MfaSubjectPort) |
|
|
34
|
+
| `configService` | `ConfigService` |
|
|
35
|
+
| `encryptionService` | `MfaEncryptionService` |
|
|
36
|
+
| `otpService` | `IOtpService` |
|
|
37
|
+
|
|
38
|
+
#### Returns
|
|
39
|
+
|
|
40
|
+
`TotpMfaChannel`
|
|
41
|
+
|
|
42
|
+
## Properties
|
|
43
|
+
|
|
44
|
+
### method
|
|
45
|
+
|
|
46
|
+
```ts
|
|
47
|
+
readonly method: "totp" = 'totp';
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Defined in: [libs/platform-authentication/src/mfa/channels/TotpMfaChannel.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/mfa/channels/TotpMfaChannel.ts#L19)
|
|
51
|
+
|
|
52
|
+
Unique identifier of the MFA method (e.g., `totp`, `sms`, `email`).
|
|
53
|
+
|
|
54
|
+
#### Implementation of
|
|
55
|
+
|
|
56
|
+
```ts
|
|
57
|
+
IMfaChannel.method;
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
## Methods
|
|
61
|
+
|
|
62
|
+
### initSetup()
|
|
63
|
+
|
|
64
|
+
```ts
|
|
65
|
+
initSetup(userId, _context?): Promise<IMfaSetup>;
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
Defined in: [libs/platform-authentication/src/mfa/channels/TotpMfaChannel.ts:48](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/mfa/channels/TotpMfaChannel.ts#L48)
|
|
69
|
+
|
|
70
|
+
Initializes the setup flow for the channel and persists any channel-specific bootstrap state.
|
|
71
|
+
|
|
72
|
+
#### Parameters
|
|
73
|
+
|
|
74
|
+
| Parameter | Type | Description |
|
|
75
|
+
| ----------- | ------------------ | -------------------------------------- |
|
|
76
|
+
| `userId` | `string` | Identifier of the user starting setup. |
|
|
77
|
+
| `_context?` | `IMfaSetupContext` | - |
|
|
78
|
+
|
|
79
|
+
#### Returns
|
|
80
|
+
|
|
81
|
+
`Promise`\<[`IMfaSetup`](Interface.IMfaSetup)\>
|
|
82
|
+
|
|
83
|
+
#### Implementation of
|
|
84
|
+
|
|
85
|
+
```ts
|
|
86
|
+
IMfaChannel.initSetup;
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
---
|
|
90
|
+
|
|
91
|
+
### verifyChallenge()
|
|
92
|
+
|
|
93
|
+
```ts
|
|
94
|
+
verifyChallenge(userId, code): Promise<boolean>;
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
Defined in: [libs/platform-authentication/src/mfa/channels/TotpMfaChannel.ts:107](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/mfa/channels/TotpMfaChannel.ts#L107)
|
|
98
|
+
|
|
99
|
+
Verifies a challenge code during login.
|
|
100
|
+
|
|
101
|
+
#### Parameters
|
|
102
|
+
|
|
103
|
+
| Parameter | Type | Description |
|
|
104
|
+
| --------- | -------- | ---------------------------------- |
|
|
105
|
+
| `userId` | `string` | Identifier of the challenged user. |
|
|
106
|
+
| `code` | `string` | User supplied challenge code. |
|
|
107
|
+
|
|
108
|
+
#### Returns
|
|
109
|
+
|
|
110
|
+
`Promise`\<`boolean`\>
|
|
111
|
+
|
|
112
|
+
#### Implementation of
|
|
113
|
+
|
|
114
|
+
```ts
|
|
115
|
+
IMfaChannel.verifyChallenge;
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
---
|
|
119
|
+
|
|
120
|
+
### verifySetup()
|
|
121
|
+
|
|
122
|
+
```ts
|
|
123
|
+
verifySetup(userId, code): Promise<boolean>;
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
Defined in: [libs/platform-authentication/src/mfa/channels/TotpMfaChannel.ts:82](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/mfa/channels/TotpMfaChannel.ts#L82)
|
|
127
|
+
|
|
128
|
+
Verifies the first setup code and marks the channel as ready for challenges.
|
|
129
|
+
|
|
130
|
+
#### Parameters
|
|
131
|
+
|
|
132
|
+
| Parameter | Type | Description |
|
|
133
|
+
| --------- | -------- | --------------------------------------- |
|
|
134
|
+
| `userId` | `string` | Identifier of the user finishing setup. |
|
|
135
|
+
| `code` | `string` | User supplied setup code. |
|
|
136
|
+
|
|
137
|
+
#### Returns
|
|
138
|
+
|
|
139
|
+
`Promise`\<`boolean`\>
|
|
140
|
+
|
|
141
|
+
#### Implementation of
|
|
142
|
+
|
|
143
|
+
```ts
|
|
144
|
+
IMfaChannel.verifySetup;
|
|
145
|
+
```
|
|
@@ -6,7 +6,7 @@ editUrl: false
|
|
|
6
6
|
|
|
7
7
|
# Class: VerificationService
|
|
8
8
|
|
|
9
|
-
Defined in: [libs/platform-authentication/src/services/VerificationService.ts:
|
|
9
|
+
Defined in: [libs/platform-authentication/src/services/VerificationService.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/VerificationService.ts#L18)
|
|
10
10
|
|
|
11
11
|
Manages email / PIN verification tokens via the [VerificationSubjectPort](Class.VerificationSubjectPort).
|
|
12
12
|
|
|
@@ -22,7 +22,7 @@ new VerificationService(
|
|
|
22
22
|
configService): VerificationService;
|
|
23
23
|
```
|
|
24
24
|
|
|
25
|
-
Defined in: [libs/platform-authentication/src/services/VerificationService.ts:
|
|
25
|
+
Defined in: [libs/platform-authentication/src/services/VerificationService.ts:39](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/VerificationService.ts#L39)
|
|
26
26
|
|
|
27
27
|
Constructs a new instance of the `VerificationService` class.
|
|
28
28
|
|
|
@@ -47,7 +47,7 @@ Constructs a new instance of the `VerificationService` class.
|
|
|
47
47
|
buildVerificationLink(token): string;
|
|
48
48
|
```
|
|
49
49
|
|
|
50
|
-
Defined in: [libs/platform-authentication/src/services/VerificationService.ts:
|
|
50
|
+
Defined in: [libs/platform-authentication/src/services/VerificationService.ts:149](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/VerificationService.ts#L149)
|
|
51
51
|
|
|
52
52
|
Constructs the verification link.
|
|
53
53
|
|
|
@@ -71,7 +71,7 @@ The URL to verify the email.
|
|
|
71
71
|
exhibitToken(data): Promise<string>;
|
|
72
72
|
```
|
|
73
73
|
|
|
74
|
-
Defined in: [libs/platform-authentication/src/services/VerificationService.ts:
|
|
74
|
+
Defined in: [libs/platform-authentication/src/services/VerificationService.ts:62](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/VerificationService.ts#L62)
|
|
75
75
|
|
|
76
76
|
Exhibits a new verification token.
|
|
77
77
|
|
|
@@ -95,7 +95,7 @@ The verification token.
|
|
|
95
95
|
redeemToken(token): Promise<Record<string, string>>;
|
|
96
96
|
```
|
|
97
97
|
|
|
98
|
-
Defined in: [libs/platform-authentication/src/services/VerificationService.ts:
|
|
98
|
+
Defined in: [libs/platform-authentication/src/services/VerificationService.ts:75](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/VerificationService.ts#L75)
|
|
99
99
|
|
|
100
100
|
Redeems the user's token.
|
|
101
101
|
|
|
@@ -119,7 +119,7 @@ The token data.
|
|
|
119
119
|
verifyPin(pin, login): Promise<boolean>;
|
|
120
120
|
```
|
|
121
121
|
|
|
122
|
-
Defined in: [libs/platform-authentication/src/services/VerificationService.ts:
|
|
122
|
+
Defined in: [libs/platform-authentication/src/services/VerificationService.ts:106](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/VerificationService.ts#L106)
|
|
123
123
|
|
|
124
124
|
#### Parameters
|
|
125
125
|
|
|
@@ -140,7 +140,7 @@ Defined in: [libs/platform-authentication/src/services/VerificationService.ts:10
|
|
|
140
140
|
verifyToken(token): Promise<boolean>;
|
|
141
141
|
```
|
|
142
142
|
|
|
143
|
-
Defined in: [libs/platform-authentication/src/services/VerificationService.ts:
|
|
143
|
+
Defined in: [libs/platform-authentication/src/services/VerificationService.ts:85](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/VerificationService.ts#L85)
|
|
144
144
|
|
|
145
145
|
Verifies the user's token.
|
|
146
146
|
|
|
@@ -22,7 +22,21 @@ Defined in: [libs/platform-authentication/src/AuthModule.ts:99](https://github.c
|
|
|
22
22
|
|
|
23
23
|
Optional additional configuration entries to register (e.g. provider-specific OAuth keys).
|
|
24
24
|
Import them from the provider-specific sub-paths
|
|
25
|
-
(e.g. `APPLE_AUTH_CONFIG_ENTRIES` from `@breadstone/archipel-platform-authentication/apple`).
|
|
25
|
+
(e.g. `APPLE_AUTH_CONFIG_ENTRIES` from `@breadstone/archipel-platform-authentication/connectors/apple`).
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
### additionalProviders?
|
|
30
|
+
|
|
31
|
+
```ts
|
|
32
|
+
optional additionalProviders?: Provider[];
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Defined in: [libs/platform-authentication/src/AuthModule.ts:121](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L121)
|
|
36
|
+
|
|
37
|
+
Optional additional providers required by optional features (e.g. TOTP MFA).
|
|
38
|
+
Import them from the provider-specific sub-paths
|
|
39
|
+
(e.g. `TOTP_MFA_PROVIDERS` from `@breadstone/archipel-platform-authentication/mfa/totp`).
|
|
26
40
|
|
|
27
41
|
---
|
|
28
42
|
|
|
@@ -34,7 +48,23 @@ authSubject: Type<AuthSubjectPort>;
|
|
|
34
48
|
|
|
35
49
|
Defined in: [libs/platform-authentication/src/AuthModule.ts:63](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L63)
|
|
36
50
|
|
|
37
|
-
Implementation of the auth subject port (user lookup for JWT/Local/Anonymous
|
|
51
|
+
Implementation of the auth subject port (user lookup for JWT/Local/Anonymous connectors).
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
### mfaChannels?
|
|
56
|
+
|
|
57
|
+
```ts
|
|
58
|
+
optional mfaChannels?: Type<any>[];
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Defined in: [libs/platform-authentication/src/AuthModule.ts:114](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L114)
|
|
62
|
+
|
|
63
|
+
Optional array of additional MFA channel types to register (e.g. `TotpMfaChannel`).
|
|
64
|
+
Import them from the provider-specific sub-paths
|
|
65
|
+
(e.g. `@breadstone/archipel-platform-authentication/mfa/totp`).
|
|
66
|
+
|
|
67
|
+
Built-in channels (SMS, Email, Push) are always registered.
|
|
38
68
|
|
|
39
69
|
---
|
|
40
70
|
|
|
@@ -70,22 +100,22 @@ optional socialAuth?: Type<SocialAuthPort>;
|
|
|
70
100
|
|
|
71
101
|
Defined in: [libs/platform-authentication/src/AuthModule.ts:84](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L84)
|
|
72
102
|
|
|
73
|
-
Optional implementation of the social auth port (OAuth
|
|
74
|
-
When provided together with `
|
|
103
|
+
Optional implementation of the social auth port (OAuth connectors).
|
|
104
|
+
When provided together with `socialConnectors`, the social auth flow is enabled.
|
|
75
105
|
|
|
76
106
|
---
|
|
77
107
|
|
|
78
|
-
###
|
|
108
|
+
### socialConnectors?
|
|
79
109
|
|
|
80
110
|
```ts
|
|
81
|
-
optional
|
|
111
|
+
optional socialConnectors?: Type<any>[];
|
|
82
112
|
```
|
|
83
113
|
|
|
84
114
|
Defined in: [libs/platform-authentication/src/AuthModule.ts:92](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/AuthModule.ts#L92)
|
|
85
115
|
|
|
86
|
-
Optional array of social
|
|
116
|
+
Optional array of social connector types to register (e.g. `AppleConnector`, `GithubConnector`).
|
|
87
117
|
Import them from the provider-specific sub-paths
|
|
88
|
-
(e.g. `@breadstone/archipel-platform-authentication/apple`).
|
|
118
|
+
(e.g. `@breadstone/archipel-platform-authentication/connectors/apple`).
|
|
89
119
|
Requires `socialAuth` to be set.
|
|
90
120
|
|
|
91
121
|
---
|
|
@@ -6,7 +6,7 @@ editUrl: false
|
|
|
6
6
|
|
|
7
7
|
# Interface: IMfaChallengeState
|
|
8
8
|
|
|
9
|
-
Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:
|
|
9
|
+
Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L10)
|
|
10
10
|
|
|
11
11
|
## Properties
|
|
12
12
|
|
|
@@ -16,7 +16,7 @@ Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:9](ht
|
|
|
16
16
|
allowedMethods: string[];
|
|
17
17
|
```
|
|
18
18
|
|
|
19
|
-
Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:
|
|
19
|
+
Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L13)
|
|
20
20
|
|
|
21
21
|
---
|
|
22
22
|
|
|
@@ -26,7 +26,7 @@ Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:12](h
|
|
|
26
26
|
attempts: number;
|
|
27
27
|
```
|
|
28
28
|
|
|
29
|
-
Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:
|
|
29
|
+
Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:21](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L21)
|
|
30
30
|
|
|
31
31
|
---
|
|
32
32
|
|
|
@@ -36,7 +36,7 @@ Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:20](h
|
|
|
36
36
|
optional clientName?: string;
|
|
37
37
|
```
|
|
38
38
|
|
|
39
|
-
Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:
|
|
39
|
+
Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L18)
|
|
40
40
|
|
|
41
41
|
---
|
|
42
42
|
|
|
@@ -46,7 +46,7 @@ Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:17](h
|
|
|
46
46
|
createdAt: Date;
|
|
47
47
|
```
|
|
48
48
|
|
|
49
|
-
Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:
|
|
49
|
+
Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:19](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L19)
|
|
50
50
|
|
|
51
51
|
---
|
|
52
52
|
|
|
@@ -56,7 +56,7 @@ Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:18](h
|
|
|
56
56
|
expiresAt: Date;
|
|
57
57
|
```
|
|
58
58
|
|
|
59
|
-
Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:
|
|
59
|
+
Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L20)
|
|
60
60
|
|
|
61
61
|
---
|
|
62
62
|
|
|
@@ -66,7 +66,7 @@ Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:19](h
|
|
|
66
66
|
id: string;
|
|
67
67
|
```
|
|
68
68
|
|
|
69
|
-
Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:
|
|
69
|
+
Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:11](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L11)
|
|
70
70
|
|
|
71
71
|
---
|
|
72
72
|
|
|
@@ -76,7 +76,7 @@ Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:10](h
|
|
|
76
76
|
optional ipAddress?: string;
|
|
77
77
|
```
|
|
78
78
|
|
|
79
|
-
Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:
|
|
79
|
+
Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L15)
|
|
80
80
|
|
|
81
81
|
---
|
|
82
82
|
|
|
@@ -86,7 +86,7 @@ Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:14](h
|
|
|
86
86
|
optional location?: string;
|
|
87
87
|
```
|
|
88
88
|
|
|
89
|
-
Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:
|
|
89
|
+
Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L17)
|
|
90
90
|
|
|
91
91
|
---
|
|
92
92
|
|
|
@@ -96,7 +96,7 @@ Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:16](h
|
|
|
96
96
|
optional preferredMethod?: string;
|
|
97
97
|
```
|
|
98
98
|
|
|
99
|
-
Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:
|
|
99
|
+
Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:14](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L14)
|
|
100
100
|
|
|
101
101
|
---
|
|
102
102
|
|
|
@@ -106,7 +106,7 @@ Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:13](h
|
|
|
106
106
|
optional userAgent?: string;
|
|
107
107
|
```
|
|
108
108
|
|
|
109
|
-
Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:
|
|
109
|
+
Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L16)
|
|
110
110
|
|
|
111
111
|
---
|
|
112
112
|
|
|
@@ -116,4 +116,4 @@ Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:15](h
|
|
|
116
116
|
userId: string;
|
|
117
117
|
```
|
|
118
118
|
|
|
119
|
-
Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:
|
|
119
|
+
Defined in: [libs/platform-authentication/src/services/ChallengeService.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/services/ChallengeService.ts#L12)
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const APPLE_AUTH_CONFIG_ENTRIES: ReadonlyArray<Omit<IConfigRegistryEntry, 'module'>>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/apple/env.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/apple/env.ts#L16)
|
|
13
|
+
Defined in: [libs/platform-authentication/src/connectors/apple/env.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/connectors/apple/env.ts#L16)
|
|
14
14
|
|
|
15
15
|
Configuration entries required by Apple Sign-In authentication.
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const AUTH_APPLE_CALLBACK_URL: IConfigKey<string>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/env.ts:
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:118](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L118)
|
|
14
14
|
|
|
15
15
|
Apple Sign-In callback URL.
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const AUTH_APPLE_CLIENT_ID: IConfigKey<string>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/env.ts:
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:109](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L109)
|
|
14
14
|
|
|
15
15
|
Apple Sign-In client (service) ID.
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const AUTH_APPLE_KEY_ID: IConfigKey<string>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/env.ts:
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:115](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L115)
|
|
14
14
|
|
|
15
15
|
Apple Sign-In key ID.
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const AUTH_APPLE_PRIVATE_KEY: IConfigKey<string>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/env.ts:
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:106](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L106)
|
|
14
14
|
|
|
15
15
|
Apple Sign-In private key (PEM string).
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const AUTH_APPLE_SCOPE: IConfigKey<string>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/env.ts:
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:121](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L121)
|
|
14
14
|
|
|
15
15
|
Comma-separated list of Apple Sign-In scopes (e.g. `'name,email'`).
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const AUTH_APPLE_TEAM_ID: IConfigKey<string>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/env.ts:
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:112](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L112)
|
|
14
14
|
|
|
15
15
|
Apple developer team ID.
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const AUTH_GITHUB_CALLBACK_URL: IConfigKey<string>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/env.ts:
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:134](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L134)
|
|
14
14
|
|
|
15
15
|
GitHub OAuth callback URL.
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const AUTH_GITHUB_CLIENT_ID: IConfigKey<string>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/env.ts:
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:128](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L128)
|
|
14
14
|
|
|
15
15
|
GitHub OAuth client ID.
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const AUTH_GITHUB_CLIENT_SECRET: IConfigKey<string>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/env.ts:
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:131](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L131)
|
|
14
14
|
|
|
15
15
|
GitHub OAuth client secret.
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const AUTH_GITHUB_SCOPE: IConfigKey<string>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/env.ts:
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:137](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L137)
|
|
14
14
|
|
|
15
15
|
Comma-separated list of GitHub OAuth scopes (e.g. `'user:email,read:user'`).
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const AUTH_GOOGLE_CALLBACK_URL: IConfigKey<string>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/env.ts:
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:77](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L77)
|
|
14
14
|
|
|
15
15
|
Google OAuth2 callback URL.
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const AUTH_GOOGLE_CLIENT_ID: IConfigKey<string>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/env.ts:
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:71](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L71)
|
|
14
14
|
|
|
15
15
|
Google OAuth2 client ID.
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const AUTH_GOOGLE_CLIENT_SECRET: IConfigKey<string>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/env.ts:
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:74](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L74)
|
|
14
14
|
|
|
15
15
|
Google OAuth2 client secret.
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const AUTH_GOOGLE_SCOPE: IConfigKey<string>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/env.ts:
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:80](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L80)
|
|
14
14
|
|
|
15
15
|
Comma-separated list of Google OAuth scopes (e.g. `'email,profile'`).
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const AUTH_MFA_EMAIL_CODE_TTL: IConfigKey<string>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/env.ts:
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:51](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L51)
|
|
14
14
|
|
|
15
15
|
Time-to-live for email OTP codes (e.g. `'10m'`).
|
|
@@ -10,6 +10,6 @@ editUrl: false
|
|
|
10
10
|
const AUTH_MFA_EMAIL_MIN_RESEND: IConfigKey<string>;
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Defined in: [libs/platform-authentication/src/env.ts:
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:54](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L54)
|
|
14
14
|
|
|
15
15
|
Minimum interval between email OTP resend requests (e.g. `'30s'`).
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Variable: AUTH\_MFA\_ISSUER'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Variable: AUTH_MFA_ISSUER
|
|
8
|
+
|
|
9
|
+
```ts
|
|
10
|
+
const AUTH_MFA_ISSUER: IConfigKey<string>;
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Defined in: [libs/platform-authentication/src/env.ts:34](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-authentication/src/env.ts#L34)
|
|
14
|
+
|
|
15
|
+
Issuer name shown in authenticator apps for TOTP MFA.
|