KindeSDK.Api.Organizations (kinde_sdk v1.0.0)

API calls for all endpoints tagged Organizations.

Link to this section Summary

Functions

Assign Users to an Organization Add existing users to an organization.

Create Organization Create an organization.

List Organizations Get a list of organizations.

Get Organization Gets an organization given the organization's code.

List Organization Users Get users in an organizaiton.

Remove Users from an Organization Remove existing users from an organization.

Link to this section Functions

Link to this function

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 server
  • opts (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
Link to this function

create_organization(connection, opts \\ [])

@spec create_organization(
  Tesla.Env.client(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Create Organization Create an organization.

parameters

Parameters

  • connection (KindeSDK.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :body (CreateOrganizationRequest): Organization details.

returns

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_orgainzations(connection, opts \\ [])

@spec get_orgainzations(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, [KindeSDK.Model.Organization.t()]}
  | {:ok, nil}
  | {:error, Tesla.Env.t()}

List Organizations Get a list of organizations.

parameters

Parameters

  • connection (KindeSDK.Connection): Connection to server
  • opts (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.

returns

Returns

  • {:ok, [%Organization{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_organization(connection, opts \\ [])

@spec get_organization(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, nil} | {:ok, KindeSDK.Model.Organization.t()} | {:error, Tesla.Env.t()}

Get Organization Gets an organization given the organization's code.

parameters

Parameters

  • connection (KindeSDK.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :code (String.t): The organization's code.

returns

Returns

  • {:ok, KindeSDK.Model.Organization.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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 server
  • opts (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
Link to this function

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 server
  • opts (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