Skip to content

Commit 00eabc4

Browse files
authored
Merge pull request #55 from Authress/add-invite-id-documentation
add inviteId to documentation.
2 parents 311c382 + e868eae commit 00eabc4

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

index.d.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,10 @@ export interface AuthenticateResponse {
1414
export interface AuthenticationParameters {
1515
/** Specify which provider connection that user would like to use to log in - see https://authress.io/app/#/manage?focus=connections */
1616
connectionId?: string;
17-
/** Instead of connectionId, specify the tenant lookup identifier to log the user with the mapped tenant - see https://authress.io/app/#/manage?focus=tenants */
17+
/** Instead of connectionId, specify the tenant lookup identifier to log the user with the mapped tenant. Takes precedent over the connectionId - see https://authress.io/app/#/manage?focus=tenants */
1818
tenantLookupIdentifier?: string;
19+
/** Invite to use to login, only one of the connectionId, tenantLookupIdentifier, or the inviteId is required. Takes precedent over the tenantLookupIdentifier, if the invite includes the defaultLoginTenantId parameter. */
20+
inviteId?: string;
1921
/** Store the credentials response in the specified location. Options are either 'cookie' or 'query'. (Default: **cookie**) */
2022
responseLocation?: string;
2123
/** The type of credentials returned in the response. The list of options is any of 'code token id_token' separated by a space. Select token to receive an access_token, id_token to return the user identity in an JWT, and code for the authorization_code grant_type flow. (Default: **token id_token**) */

0 commit comments

Comments
 (0)