D2lvalenceElixir.Utils.Service.get_users
You're seeing just the function
get_users
, go back to D2lvalenceElixir.Utils.Service module for more information.
Specs
get_users( %D2lvalenceElixir.Auth.D2LUserContext{ anonymous: term(), app_id: term(), app_key: term(), encrypt_requests: term(), host: term(), scheme: term(), server_skew: term(), user_id: term(), user_key: term() }, serializers: map() | %{}, body: list() | [], ver: String.t(), org_defined_id: String.t(), user_name: String.t(), bookmark: String.t() ) :: {:error, String.t()} | {:ok, %D2lvalenceElixir.Data.UserData{ activation: term(), external_email: term(), first_name: term(), is_active: term(), last_name: term(), middle_name: term(), org_defined_id: term(), org_id: term(), unique_identifier: term(), user_id: term(), user_name: term() }} | {:ok, [ %D2lvalenceElixir.Data.UserData{ activation: term(), external_email: term(), first_name: term(), is_active: term(), last_name: term(), middle_name: term(), org_defined_id: term(), org_id: term(), unique_identifier: term(), user_id: term(), user_name: term() } ]} | {:ok, %D2lvalenceElixir.Data.PagedResultSet{ bookmark: term(), has_more_items: term(), items: term(), paging_info: term() }}
Get the users information.
Returns
{:error, cause}
when an error is caused.
{:ok, list(%D2lvalenceElixir.Data.UserData{})}
when the org_defined_id is defined.
{:ok, %D2lvalenceElixir.Data.UserData{}}
when the user_name is defined and the org_defined_id is not defined.
{:ok, %D2lvalenceElixir.Data.PagedResultSer{}}
when only the bookmark is defined.
Options
serializers: Map of availaber serializers. application/json recommended. body: Options to pass to the body of the request. org_defined_id: Id of the organization. user_name: User name to obtain the information bookmark: Bookmark for the request