Function UsersApiAxiosParamCreator

Returns {
    usersDestroy: ((id, options?) => Promise<RequestArgs>);
    usersList: ((xOrganization?, filter?, firstName?, isActive?, lastName?, org?, orgId?, page?, pageSize?, search?, sort?, username?, options?) => Promise<RequestArgs>);
    usersPartialUpdate: ((id, patchedUserRequest?, options?) => Promise<RequestArgs>);
    usersRetrieve: ((id, options?) => Promise<RequestArgs>);
    usersRetrieveSelf: ((options?) => Promise<RequestArgs>);
}

• usersDestroy: ((id, options?) => Promise<RequestArgs>)

  • • (id, options?): Promise<RequestArgs>

    • Parameters

      • id: number

        A unique integer value identifying this user.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Method deletes a specific user from the server

      Throws

• usersList: ((xOrganization?, filter?, firstName?, isActive?, lastName?, org?, orgId?, page?, pageSize?, search?, sort?, username?, options?) => Promise<RequestArgs>)

  • • (xOrganization?, filter?, firstName?, isActive?, lastName?, org?, orgId?, page?, pageSize?, search?, sort?, username?, options?): Promise<RequestArgs>

    • Parameters

      • Optional xOrganization: string

        Organization unique slug

      • Optional filter: 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;].

      • Optional firstName: string

        A simple equality filter for the first_name field

      • Optional isActive: boolean

        A simple equality filter for the is_active field

      • Optional lastName: string

        A simple equality filter for the last_name field

      • Optional org: string

        Organization unique slug

      • Optional orgId: number

        Organization identifier

      • Optional page: number

        A page number within the paginated result set.

      • Optional pageSize: number

        Number of results to return per page.

      • Optional search: string

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

      • Optional sort: 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;]

      • Optional username: string

        A simple equality filter for the username field

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Method returns a paginated list of users

      Throws

• usersPartialUpdate: ((id, patchedUserRequest?, options?) => Promise<RequestArgs>)

  • • (id, patchedUserRequest?, options?): Promise<RequestArgs>

    • Parameters

      • id: number

        A unique integer value identifying this user.

      • Optional patchedUserRequest: PatchedUserRequest

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Method updates chosen fields of a user

      Throws

• usersRetrieve: ((id, options?) => Promise<RequestArgs>)

  • • (id, options?): Promise<RequestArgs>

    • Parameters

      • id: number

        A unique integer value identifying this user.

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Method provides information of a specific user

      Throws

• usersRetrieveSelf: ((options?) => Promise<RequestArgs>)

  • • (options?): Promise<RequestArgs>

    • Method returns an instance of a user who is currently authorized

      Parameters

      • Optional options: AxiosRequestConfig<any> = {}

        Override http request option.

      Returns Promise<RequestArgs>

      Summary

      Method returns an instance of a user who is currently authorized

      Throws