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

Oystehr SDK

// AUTOGENERATED -- DO NOT EDIT

import { AccessPolicy } from './AccessPolicy';
import { RoleStub } from './RoleStub';

export interface User {
  id: string;
  /**
   * 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.
   */
  name: string;
  /**
   * The User's email address.
   */
  email: string | null;
  /**
   * The User's phone number.
   */
  phoneNumber: string | null;
  /**
   * The name of the connection used to authenticate the User. One of: email, sms, or the name of a custom SSO connection.
   */
  authenticationMethod: string;
  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;
  };
  /**
   * Reference to the FHIR resource that represents the User in the FHIR store. May be any of the following resource types: Practitioner, Patient, RelatedPerson.
   */
  profile: string;
  /**
   * The roles assigned to the User.
   */
  roles?: RoleStub[];
}