Skip to content

Commit 90b903d

Browse files
committed
Regenerate
1 parent f0087ef commit 90b903d

File tree

5 files changed

+36
-4
lines changed

5 files changed

+36
-4
lines changed

docs/AuthenticationTokenConfiguration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**accessTokenDuration** | **String** | How long should Authress generated access tokens (JWTs) last for in minutes. This controls how often tokens expiry (*exp*). The default is 24 hours. The minimum is one minute and the max is twenty-four hours. | [optional] [default: 'PT24H']
8-
**sessionDuration** | **String** | How long should user authentication sessions last for in minutes. This controls how often users are forced to log in again. User sessions are optimized to provide the best user experience for your application. The default is 90 days. The minimum is one minute and the max is 90 days. | [optional] [default: 'P30D']
7+
**accessTokenDuration** | **Duration** | How long should Authress generated access tokens (JWTs) last for in minutes. This controls how often tokens expiry (*exp*). The default is 24 hours. The minimum is one minute and the max is twenty-four hours. | [optional] [default: PT24H]
8+
**sessionDuration** | **Duration** | How long should user authentication sessions last for in minutes. This controls how often users are forced to log in again. User sessions are optimized to provide the best user experience for your application. The default is 90 days. The minimum is one minute and the max is 90 days. | [optional] [default: P30D]
99

1010

docs/ClientRateLimit.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**duration** | **String** | The sliding window time slice duration for which this quota applies. This value must conform to the ISO8601 format, see the enum for allow values. |
7+
**duration** | **Duration** | The sliding window time slice duration for which this quota applies. This value must conform to the ISO8601 format, see the enum for allow values. |
88
**quota** | **Number** | The maximum number of requests allowed during the duration. |
99

1010

docs/ConnectionConditions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,6 @@
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
77
**requireBusinessAccount** | **Boolean** | Require the user logging in with this connect to be using a business account. When possible Authress will block user login and request that they select a different account. Enabling this may prevent some users from being able to sign up with this identity connection. | [optional] [default: false]
8-
**authenticationLeewayDuration** | **String** | The maximum amount of time to wait between the the instant a user begins the authentication flow, to the moment login has completed. Lower values increase security by limiting attack time, longer times allow for slower connections and async login flows to complete. Authentication requests that do not complete within this duration are rejected with the Expired error. The default is 5 minutes. The minimum is one minute and the max is 1 hour. | [optional] [default: 'PT5M']
8+
**authenticationLeewayDuration** | **Duration** | The maximum amount of time to wait between the the instant a user begins the authentication flow, to the moment login has completed. Lower values increase security by limiting attack time, longer times allow for slower connections and async login flows to complete. Authentication requests that do not complete within this duration are rejected with the Expired error. The default is 5 minutes. The minimum is one minute and the max is 1 hour. | [optional] [default: PT5M]
99

1010

docs/Invite.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
1010
**defaultLoginTenantId** | **String** | Specify the tenant associated with the invite. This tenant Id is used to automatically select the tenant during login with Authress when using the Authress Login UI SDK. This parameter is ignored when accepting invites directly. To explicitly add a user to a tenant use the <code>linkTenantUser</code> API endpoint. | [optional]
1111
**statements** | [**[InviteStatement]**](InviteStatement.md) | A list of statements which match roles to resources. The invited user will all statements apply to them when the invite is accepted. |
1212
**conflictResolutionStrategy** | **String** | An access record will be created when the invite is accepted. If the access record already exists, and the statements in this invite can be merged safely, then the existing record will be updated. A safe merge is one in which the current user will only gain additional access to the statements defined in the invite and other users will not gain additional access in any scenario. When this cannot be done safely, Authress will fallback to this parameter.&lt;br&gt; &lt;ul&gt; &lt;li&gt;&lt;code&gt;GENERATE_NEW_RECORD&lt;/code&gt; - (Default) Create a new access record which matches the statements in this invite. The record ID will be randomly generated and is unpredictable.&lt;/li&gt; &lt;li&gt;&lt;code&gt;UNSAFE_FORCE_MERGE&lt;/code&gt; - Add the user and statements to the existing record. This will cause the user to gain all the permissions already defined in that record and will cause all the users currently in that record to gain all the additional permissions defined in the invite.&lt;/li&gt; &lt;li&gt;&lt;code&gt;REPLACE_RECORD_DATA&lt;/code&gt; - Replace the existing access record users, roles, and resources with those specified in this invite.&lt;/li&gt; &lt;li&gt;&lt;code&gt;SKIP_CHANGES&lt;/code&gt; - Do not replace, do not create, do not throw. Optimal for ensuring that all records have a known management strategy and successful invite acceptance is more important than the granted permissions.&lt;/li&gt; &lt;/ul&gt; | [optional] [default: &#39;GENERATE_NEW_RECORD&#39;]
13+
**expiryDuration** | **Duration** | How long should the invite be available for? Creating invites that are available for longer than 7 days may be a security risk as invites can be used to regain access even after a user has lost access. This is the fundamental aspect of invites, because invites exist to grant access to a user that does not currently have access. The minimum is five minutes `PT5M` and the max is 30 days `P30D`. This value must conform to the ISO8601 format. Note: Explicitly setting this parameter to a value other than the default requires the permission: Invites:Create Authress:Invites | [optional]
1314
**links** | [**AccountLinks**](AccountLinks.md) | | [optional]
1415

1516

src/invites/dtos.d.ts

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,23 @@
55
// eslint-disable-next-line node/no-missing-import
66
import { Resource } from '../records/dtos';
77

8+
export namespace Invite {
9+
/**
10+
* @export
11+
* @enum {string}
12+
*/
13+
export enum ConflictResolutionStrategyEnum {
14+
/** (Default) Create a new access record which matches the statements in this invite. The record ID will be randomly generated and is unpredictable. */
15+
GENERATE_NEW_RECORD = 'GENERATE_NEW_RECORD',
16+
/** Add the user and statements to the existing record. This will cause the user to gain all the permissions already defined in that record and will cause all the users currently in that record to gain all the additional permissions defined in the invite. */
17+
UNSAFE_FORCE_MERGE = 'UNSAFE_FORCE_MERGE',
18+
/** Replace the existing access record users, roles, and resources with those specified in this invite. */
19+
REPLACE_RECORD_DATA = 'REPLACE_RECORD_DATA',
20+
/** Do not replace, do not create, do not throw. Optimal for ensuring that all records have a known management strategy and successful invite acceptance is more important than the granted permissions. */
21+
SKIP_CHANGES = 'SKIP_CHANGES'
22+
}
23+
}
24+
825
/**
926
* The user invite used to invite users to your application or to Authress as an admin.
1027
* @export
@@ -43,6 +60,20 @@ export interface Invite {
4360
* @memberof Invite
4461
*/
4562
statements?: Array<InviteStatement>;
63+
64+
/**
65+
* An access record will be created when the invite is accepted. If the access record already exists, and the statements in this invite can be merged safely, then the existing record will be updated. A safe merge is one in which the current user will only gain additional access to the statements defined in the invite and other users will not gain additional access in any scenario. When this cannot be done safely, Authress will fallback to this parameter. [default: GENERATE_NEW_RECORD]
66+
* @type {Invite.ConflictResolutionStrategyEnum}
67+
* @memberof Invite
68+
*/
69+
conflictResolutionStrategy?: Invite.ConflictResolutionStrategyEnum;
70+
71+
/**
72+
* How long should the invite be available for? Creating invites that are available for longer than 7 days may be a security risk as invites can be used to regain access even after a user has lost access. This is the fundamental aspect of invites, because invites exist to grant access to a user that does not currently have access. The minimum is five minutes `PT5M` and the max is 30 days `P30D`. This value must conform to the ISO8601 format. Note: Explicitly setting this parameter to a value other than the default requires the permission: Invites:Create Authress:Invites.
73+
* @type {string}
74+
* @memberof Invite
75+
*/
76+
expiryDuration?: string;
4677
}
4778

4879
/**

0 commit comments

Comments
 (0)