Function UsersApiFp

Returns {
    usersDestroy(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>,
    >;
    usersList(
        xOrganization?: string,
        filter?: string,
        firstName?: string,
        isActive?: boolean,
        lastName?: string,
        org?: string,
        orgId?: number,
        page?: number,
        pageSize?: number,
        search?: string,
        sort?: string,
        username?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PaginatedMetaUserList>,
    >;
    usersPartialUpdate(
        id: number,
        patchedUserRequest?: PatchedUserRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetaUser>,
    >;
    usersRetrieve(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetaUser>,
    >;
    usersRetrieveSelf(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetaUser>,
    >;
}

• usersDestroy:function

  • usersDestroy(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Parameters

    • id: number

      A unique integer value identifying this user.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

    Throws

• usersList:function

  • usersList(
        xOrganization?: string,
        filter?: string,
        firstName?: string,
        isActive?: boolean,
        lastName?: string,
        org?: string,
        orgId?: number,
        page?: number,
        pageSize?: number,
        search?: string,
        sort?: string,
        username?: string,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PaginatedMetaUserList>,
    >

    Parameters

    • OptionalxOrganization: string

      Organization unique slug
    • Optionalfilter: string

      JSON Logic filter. This filter can be used to perform complex filtering by grouping rules. For example, using such a filter you can get all resources created by you: - {&quot;and&quot;:[{&quot;==&quot;:[{&quot;var&quot;:&quot;owner&quot;},&quot;<user>&quot;]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [&#39;username&#39;, &#39;first_name&#39;, &#39;last_name&#39;, &#39;id&#39;, &#39;is_active&#39;].
    • OptionalfirstName: string

      A simple equality filter for the first_name field
    • OptionalisActive: boolean

      A simple equality filter for the is_active field
    • OptionallastName: string

      A simple equality filter for the last_name field
    • Optionalorg: string

      Organization unique slug
    • OptionalorgId: number

      Organization identifier
    • Optionalpage: number

      A page number within the paginated result set.
    • OptionalpageSize: number

      Number of results to return per page.
    • Optionalsearch: string

      A search term. Available search_fields: (&#39;username&#39;, &#39;first_name&#39;, &#39;last_name&#39;)
    • Optionalsort: string

      Which field to use when ordering the results. Available ordering_fields: [&#39;username&#39;, &#39;first_name&#39;, &#39;last_name&#39;, &#39;id&#39;, &#39;is_active&#39;]
    • Optionalusername: string

      A simple equality filter for the username field
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<
        (
            axios?: AxiosInstance,
            basePath?: string,
        ) => AxiosPromise<PaginatedMetaUserList>,
    >

    Throws

• usersPartialUpdate:function

  • usersPartialUpdate(
        id: number,
        patchedUserRequest?: PatchedUserRequest,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetaUser>,
    >

    Parameters

    • id: number

      A unique integer value identifying this user.
    • OptionalpatchedUserRequest: PatchedUserRequest
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetaUser>>

    Throws

• usersRetrieve:function

  • usersRetrieve(
        id: number,
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetaUser>,
    >

    Parameters

    • id: number

      A unique integer value identifying this user.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetaUser>>

    Throws

• usersRetrieveSelf:function

  • usersRetrieveSelf(
        options?: RawAxiosRequestConfig,
    ): Promise<
        (axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetaUser>,
    >

    Method returns an instance of a user who is currently authenticated

    Parameters

    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MetaUser>>

    Throws