Class Auth

constructor

• new Auth(api): Auth

• Parameters

  • api: Api

  Returns Auth

api

create

• create(userData): Promise<ApiResponse<unknown, unknown>>

• Parameters

  • userData: UserCreateData

  Returns Promise<ApiResponse<unknown, unknown>>

getMyProfile

• getMyProfile(useCache?): Promise<ProfileData>

• Parameters

  • useCache: boolean = true

  Returns Promise<ProfileData>

getUser

• getUser(username): Promise<UserApiData>

• Parameters

  • username: string

  Returns Promise<UserApiData>

getUsers

• getUsers<TUid, TAttr>(userData): Promise<UsersInfoResponse<TUid, TAttr>>

• Type Parameters

  • TUid extends string

  • TAttr extends EditableUserAttributes

  Parameters

  • userData: UserInfoPayload<TUid, TAttr>

  Returns Promise<UsersInfoResponse<TUid, TAttr>>

login

• login(username, password): Promise<ProfileData>

• Parameters

  • username: string

  • password: string

  Returns Promise<ProfileData>

updateUser

• updateUser(data): Promise<ApiResponse<void, void>>

• Parameters

  • data: ChangePasswordFormData | Partial<Partial<{
        cn: string;
        landingPage: string;
        mail: string;
        mobile: string;
        note: string;
        preferredLanguage: string;
        sn: string;
        timezone: string;
    }>>

  Returns Promise<ApiResponse<void, void>>