From e868eae73e8e06b6ca35c3da41d677b46e302e8e Mon Sep 17 00:00:00 2001 From: Warren Parad Date: Sun, 3 Nov 2024 10:34:50 +0100 Subject: [PATCH] add inviteId to documentation. --- index.d.ts | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/index.d.ts b/index.d.ts index 1d36897..d1a86fa 100644 --- a/index.d.ts +++ b/index.d.ts @@ -14,8 +14,10 @@ export interface AuthenticateResponse { export interface AuthenticationParameters { /** Specify which provider connection that user would like to use to log in - see https://authress.io/app/#/manage?focus=connections */ connectionId?: string; - /** Instead of connectionId, specify the tenant lookup identifier to log the user with the mapped tenant - see https://authress.io/app/#/manage?focus=tenants */ + /** 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 */ tenantLookupIdentifier?: string; + /** 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. */ + inviteId?: string; /** Store the credentials response in the specified location. Options are either 'cookie' or 'query'. (Default: **cookie**) */ responseLocation?: string; /** 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**) */