Class Auth

constructor

• new Auth(api: Api): Auth

• Parameters

  • api: Api

  Returns Auth

api

create

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

• Parameters

  • userData: UserCreateData

  Returns Promise<ApiResponse<unknown, unknown>>

getMyProfile

• getMyProfile(useCache?: boolean): Promise<ProfileData>

• Parameters

  • useCache: boolean = true

  Returns Promise<ProfileData>

getUser

• getUser(username: string): Promise<UserApiData>

• Parameters

  • username: string

  Returns Promise<UserApiData>

getUsers

• getUsers<TUid extends string, TAttr extends EditableUserAttributes>(
      userData: UserInfoPayload<TUid, TAttr>,
  ): 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: string, password: string): Promise<ProfileData>

• Parameters

  • username: string
  • password: string

  Returns Promise<ProfileData>

updateUser

• updateUser(
      data:
          | ChangePasswordFormData
          | Partial<
              Partial<
                  {
                      cn: string;
                      landingPage: string;
                      mail: string;
                      mobile: string;
                      note: string;
                      preferredLanguage: string;
                      sn: string;
                      timezone: string;
                  },
              >,
          >,
  ): 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>>