@authress/sdk/src/invites/dtos.ts

Client SDK for Authress authorization as a service. Provides managed authorization api to secure service resources including user data.

/* eslint-disable no-shadow */
/* eslint-disable no-redeclare */
/* eslint-disable @typescript-eslint/no-namespace */

// eslint-disable-next-line node/no-missing-import
import { Resource } from '../records/dtos';

/**
 * The user invite used to invite users to your application or to Authress as an admin.
 * @export
 * @interface Invite
 */
export interface Invite {
  /**
   * The unique identifier for the invite. Use this ID to accept the invite. This parameter is ignored during invite creation.
   * @type {string}
   * @memberof Invite
   */
  inviteId?: string;
  
  /**
   * Specify a User ID the user should receive when login completes. This ID is used to automatically assign a user ID to the user rather than a dynamically generated Authress User ID when using the Authress Login UI SDK. This parameter is ignored when accepting invites directly. Note: If the user logging in has already signed up, then this parameter is ignored. (Max length: 32, allowed characters: [a-zA-Z0-9_-])
   * @type {string}
   * @memberof Invite
   */
  linkedUserId?: 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.
   * @type {string}
   * @memberof Invite
   */
  defaultLoginTenantId?: string;
  /**
   * Provided by Authress as a unique URI that can be used to start the Authress Login flow for the user. Provide this property in the `request_uri` property, when not using the Authress Login UI SDK. This parameter is ignored during invite creation.
   * @type {string}
   * @memberof Invite
   */
  authenticationRequestUri?: string;
  /**
   * A list of statements which match roles to resources. The invited user will all statements apply to them when the invite is accepted.
   * @type {Array<InviteStatement>}
   * @memberof Invite
   */
  statements?: Array<InviteStatement>;
}

/**
 *
 * @export
 * @interface InviteStatement
 */
export interface InviteStatement {
  /**
   *
   * @type {Array<string>}
   * @memberof InviteStatement
   */
  roles: Array<string>;
  /**
   *
   * @type {Array<Resource>}
   * @memberof InviteStatement
   */
  resources: Array<Resource>;
}