Skip to content

Commit

Permalink
add inviteId to documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
wparad committed Nov 3, 2024
1 parent 311c382 commit e868eae
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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**) */
Expand Down

0 comments on commit e868eae

Please sign in to comment.