ExOauth2Provider v0.4.4 ExOauth2Provider.OauthApplications View Source
The boundary for the OauthApplications system.
Link to this section Summary
Functions
Returns an %Ecto.Changeset{}
for tracking application changes
Creates an application
Deletes an application
Gets a single application by uid
Gets a single application by uid and secret
Gets a single application by uid
Gets a single application for a resource owner
Returns all applications for a owner
Gets all authorized applications for a resource owner
Revokes all access tokens for an application and resource owner
Updates an application
Link to this section Functions
change_application(application)
View Source
change_application(ExOauth2Provider.OauthApplications.OauthApplication.t()) ::
Ecto.Changeset.t()
change_application(ExOauth2Provider.OauthApplications.OauthApplication.t()) :: Ecto.Changeset.t()
Returns an %Ecto.Changeset{}
for tracking application changes.
Examples
iex> change_application(application)
%Ecto.Changeset{source: %OauthApplication{}}
create_application(owner, attrs \\ %{}) View Source
Creates an application.
Examples
iex> create_application(user, %{name: "App", redirect_uri: "http://example.com"})
{:ok, %OauthApplication{}}
iex> create_application(user, %{name: ""})
{:error, %Ecto.Changeset{}}
delete_application(application)
View Source
delete_application(ExOauth2Provider.OauthApplications.OauthApplication.t()) ::
{:ok, ExOauth2Provider.OauthApplications.OauthApplication.t()}
| {:error, Ecto.Changeset.t()}
delete_application(ExOauth2Provider.OauthApplications.OauthApplication.t()) :: {:ok, ExOauth2Provider.OauthApplications.OauthApplication.t()} | {:error, Ecto.Changeset.t()}
Deletes an application.
Examples
iex> delete_application(application)
{:ok, %OauthApplication{}}
iex> delete_application(application)
{:error, %Ecto.Changeset{}}
get_application(uid)
View Source
get_application(binary()) ::
ExOauth2Provider.OauthApplications.OauthApplication.t() | nil
get_application(binary()) :: ExOauth2Provider.OauthApplications.OauthApplication.t() | nil
Gets a single application by uid.
Examples
iex> get_application("c341a5c7b331ef076eb4954668d54f590e0009e06b81b100191aa22c93044f3d")
%OauthApplication{}
iex> get_application("75d72f326a69444a9287ea264617058dbbfe754d7071b8eef8294cbf4e7e0fdc")
nil
get_application(uid, secret) View Source
Gets a single application by uid and secret.
Examples
iex> get_application("c341a5c7b331ef076eb4954668d54f590e0009e06b81b100191aa22c93044f3d", "SECRET")
%OauthApplication{}
iex> get_application("75d72f326a69444a9287ea264617058dbbfe754d7071b8eef8294cbf4e7e0fdc", "SECRET")
nil
get_application!(uid) View Source
Gets a single application by uid.
Raises Ecto.NoResultsError
if the OauthApplication does not exist.
Examples
iex> get_application!("c341a5c7b331ef076eb4954668d54f590e0009e06b81b100191aa22c93044f3d")
%OauthApplication{}
iex> get_application!("75d72f326a69444a9287ea264617058dbbfe754d7071b8eef8294cbf4e7e0fdc")
** (Ecto.NoResultsError)
get_application_for!(resource_owner, uid)
View Source
get_application_for!(Ecto.Schema.t(), binary()) ::
ExOauth2Provider.OauthApplications.OauthApplication.t() | no_return()
get_application_for!(Ecto.Schema.t(), binary()) :: ExOauth2Provider.OauthApplications.OauthApplication.t() | no_return()
Gets a single application for a resource owner.
Raises Ecto.NoResultsError
if the OauthApplication does not exist for resource owner.
Examples
iex> get_application_for!(owner, "c341a5c7b331ef076eb4954668d54f590e0009e06b81b100191aa22c93044f3d")
%OauthApplication{}
iex> get_application_for!(owner, "75d72f326a69444a9287ea264617058dbbfe754d7071b8eef8294cbf4e7e0fdc")
** (Ecto.NoResultsError)
get_applications_for(resource_owner)
View Source
get_applications_for(Ecto.Schema.t()) :: [
ExOauth2Provider.OauthApplications.OauthApplication.t()
]
get_applications_for(Ecto.Schema.t()) :: [ ExOauth2Provider.OauthApplications.OauthApplication.t() ]
Returns all applications for a owner.
Examples
iex> get_applications_for(resource_owner)
[%OauthApplication{}, ...]
get_authorized_applications_for(resource_owner)
View Source
get_authorized_applications_for(Ecto.Schema.t()) :: [
ExOauth2Provider.OauthApplications.OauthApplication.t()
]
get_authorized_applications_for(Ecto.Schema.t()) :: [ ExOauth2Provider.OauthApplications.OauthApplication.t() ]
Gets all authorized applications for a resource owner.
Examples
iex> get_authorized_applications_for(owner)
[%OauthApplication{},...]
parse_default_scope_string(server_scopes) View Source
put_scopes(changeset)
View Source
put_scopes(Ecto.Changeset.t()) :: Ecto.Changeset.t()
put_scopes(Ecto.Changeset.t()) :: Ecto.Changeset.t()
put_scopes(changeset, default_server_scopes) View Source
revoke_all_access_tokens_for(application, resource_owner)
View Source
revoke_all_access_tokens_for(
ExOauth2Provider.OauthApplications.OauthApplication.t(),
Ecto.Schema.t()
) :: [ExOauth2Provider.OauthAccessTokens.OauthAccessToken.t()]
revoke_all_access_tokens_for( ExOauth2Provider.OauthApplications.OauthApplication.t(), Ecto.Schema.t() ) :: [ExOauth2Provider.OauthAccessTokens.OauthAccessToken.t()]
Revokes all access tokens for an application and resource owner.
Examples
iex> revoke_all_access_tokens_for(application, resource_owner)
{:ok, [%OauthAccessToken{}]}
update_application(application, attrs)
View Source
update_application(
ExOauth2Provider.OauthApplications.OauthApplication.t(),
map()
) ::
{:ok, ExOauth2Provider.OauthApplications.OauthApplication.t()}
| {:error, Ecto.Changeset.t()}
update_application( ExOauth2Provider.OauthApplications.OauthApplication.t(), map() ) :: {:ok, ExOauth2Provider.OauthApplications.OauthApplication.t()} | {:error, Ecto.Changeset.t()}
Updates an application.
Examples
iex> update_application(application, %{name: "Updated App"})
{:ok, %OauthApplication{}}
iex> update_application(application, %{name: ""})
{:error, %Ecto.Changeset{}}
validate_scopes(changeset)
View Source
validate_scopes(Ecto.Changeset.t()) :: Ecto.Changeset.t()
validate_scopes(Ecto.Changeset.t()) :: Ecto.Changeset.t()