@oystehr/sdk/src/resources/types/UserInviteParams.ts

Oystehr SDK

// AUTOGENERATED -- DO NOT EDIT

import { Patient, Practitioner } from 'fhir/r4b';
import { AccessPolicy } from './AccessPolicy';

export interface UserInviteParams {
  /**
   * A name for the User to help you differentiate them from other Users in the project. Defaults to the User's email or phone number if not provided.
   */
  username?: string;
  /**
   * The User's email address.
   */
  email: string | null;
  /**
   * The User's phone number.
   */
  phoneNumber?: string | null;
  accessPolicy?: AccessPolicy;
  /**
   * ssoData contains information about the user from a third-party SSO identity provider. For example, if you send a `upn` or other information in a SAML payload, it is stored here. It is only populated if the User authenticated via SSO with a third-party identity provider.
   */
  ssoData?: {
    [k: string]: any;
  };
  /**
   * The application ID to which you want to invite a user
   */
  applicationId: string;
  /**
   * A valid Patient or Practitioner FHIR Resource which will be created and become the User's 'profile'.
   */
  resource: Patient | Practitioner;
  /**
   * A list of Role IDs to assign to the invited user. If the accessPolicy property is not provided this property is required and may not be empty.
   */
  roles?: string[];
}