KindeSDK.Api.Users (kinde_sdk v1.2.0)
API calls for all endpoints tagged Users
.
Link to this section Summary
Functions
Assign Users to an Organization Add existing users to an organization.
Create User Creates a user record and optionally zero or more identities for the user. An example identity could be the email address of the user.
Delete User Delete a user record
List Organization Users Get users in an organizaiton.
Get User Retrieve a user record
List Users
The returned list can be sorted by full name or email address in ascending or descending order. The number of records to return at a time can also be controlled using the page_size
query string parameter.
Remove Users from an Organization Remove existing users from an organization.
Update User Update a user record
Link to this section Functions
add_organization_users(connection, opts \\ [])
@spec add_organization_users( Tesla.Env.client(), keyword() ) :: {:ok, nil} | {:ok, KindeSDK.Model.AddOrganizationUsers200Response.t()} | {:error, Tesla.Env.t()}
Assign Users to an Organization Add existing users to an organization.
parameters
Parameters
connection
(KindeSDK.Connection): Connection to serveropts
(keyword): Optional parameters:code
(String.t): The organization's code.:body
(AddOrganizationUsersRequest):
returns
Returns
{:ok, KindeSDK.Model.AddOrganizationUsers200Response.t}
on success{:error, Tesla.Env.t}
on failure
create_user(connection, opts \\ [])
@spec create_user( Tesla.Env.client(), keyword() ) :: {:ok, nil} | {:ok, KindeSDK.Model.CreateUser200Response.t()} | {:error, Tesla.Env.t()}
Create User Creates a user record and optionally zero or more identities for the user. An example identity could be the email address of the user.
parameters
Parameters
connection
(KindeSDK.Connection): Connection to serveropts
(keyword): Optional parameters:body
(CreateUserRequest): The details of the user to create.
returns
Returns
{:ok, KindeSDK.Model.CreateUser200Response.t}
on success{:error, Tesla.Env.t}
on failure
deleteuser(connection, opts \\ [])
@spec deleteuser( Tesla.Env.client(), keyword() ) :: {:ok, nil} | {:error, Tesla.Env.t()}
Delete User Delete a user record
parameters
Parameters
connection
(KindeSDK.Connection): Connection to serveropts
(keyword): Optional parameters:id
(String.t): The user's id.
returns
Returns
{:ok, nil}
on success{:error, Tesla.Env.t}
on failure
get_organization_users(connection, opts \\ [])
@spec get_organization_users( Tesla.Env.client(), keyword() ) :: {:ok, nil} | {:ok, KindeSDK.Model.OrganizationUser.t()} | {:error, Tesla.Env.t()}
List Organization Users Get users in an organizaiton.
parameters
Parameters
connection
(KindeSDK.Connection): Connection to serveropts
(keyword): Optional parameters:sort
(String.t): Field and order to sort the result by.:page_size
(integer()): Number of results per page. Defaults to 10 if parameter not sent.:next_token
(String.t): A string to get the next page of results if there are more results.:code
(String.t): The organization's code.
returns
Returns
{:ok, KindeSDK.Model.OrganizationUser.t}
on success{:error, Tesla.Env.t}
on failure
get_user(connection, opts \\ [])
@spec get_user( Tesla.Env.client(), keyword() ) :: {:ok, nil} | {:ok, KindeSDK.Model.User.t()} | {:error, Tesla.Env.t()}
Get User Retrieve a user record
parameters
Parameters
connection
(KindeSDK.Connection): Connection to serveropts
(keyword): Optional parameters:id
(String.t): The user's id.
returns
Returns
{:ok, KindeSDK.Model.User.t}
on success{:error, Tesla.Env.t}
on failure
get_users(connection, opts \\ [])
@spec get_users( Tesla.Env.client(), keyword() ) :: {:ok, nil} | {:ok, [KindeSDK.Model.User.t()]} | {:error, Tesla.Env.t()}
List Users
The returned list can be sorted by full name or email address in ascending or descending order. The number of records to return at a time can also be controlled using the page_size
query string parameter.
parameters
Parameters
connection
(KindeSDK.Connection): Connection to serveropts
(keyword): Optional parameters:sort
(String.t): Field and order to sort the result by.:page_size
(integer()): Number of results per page. Defaults to 10 if parameter not sent.:user_id
(integer()): ID of the user to filter by.:next_token
(String.t): A string to get the next page of results if there are more results.
returns
Returns
{:ok, [%User{}, ...]}
on success{:error, Tesla.Env.t}
on failure
remove_organization_users(connection, opts \\ [])
@spec remove_organization_users( Tesla.Env.client(), keyword() ) :: {:ok, nil} | {:ok, KindeSDK.Model.RemoveOrganizationUsers200Response.t()} | {:error, Tesla.Env.t()}
Remove Users from an Organization Remove existing users from an organization.
parameters
Parameters
connection
(KindeSDK.Connection): Connection to serveropts
(keyword): Optional parameters:code
(String.t): The organization's code.:body
(RemoveOrganizationUsersRequest):
returns
Returns
{:ok, KindeSDK.Model.RemoveOrganizationUsers200Response.t}
on success{:error, Tesla.Env.t}
on failure
update_user(connection, update_user_request, opts \\ [])
@spec update_user(Tesla.Env.client(), KindeSDK.Model.UpdateUserRequest.t(), keyword()) :: {:ok, nil} | {:ok, KindeSDK.Model.User.t()} | {:error, Tesla.Env.t()}
Update User Update a user record
parameters
Parameters
connection
(KindeSDK.Connection): Connection to serverupdate_user_request
(UpdateUserRequest): The user to update.opts
(keyword): Optional parameters:id
(String.t): The user's id.
returns
Returns
{:ok, KindeSDK.Model.User.t}
on success{:error, Tesla.Env.t}
on failure