@oystehr/sdk/dist/esm/resources/types/UserInviteResponse.d.ts

Oystehr SDK

import { AccessPolicy } from './AccessPolicy';
import { RoleStub } from './RoleStub';
/**
 * Successfully invited a user
 */
export interface UserInviteResponse {
    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;
    /**
     * 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[];
    /**
     * The invitation url to the project
     */
    invitationUrl: string;
}