Polarex.Oauth2 (Polarex v0.1.0)
View SourceProvides API endpoints related to oauth2
Summary
Functions
Authorize
List Clients
Create Client
Introspect Token
Request Token
Revoke Token
Get User Info
Functions
@spec oauth2_authorize(keyword()) :: {:ok, Polarex.AuthorizeResponseOrganization.t() | Polarex.AuthorizeResponseUser.t()} | :error
Authorize
@spec oauth2_clients_list(keyword()) :: {:ok, Polarex.ListResourceOAuth2Client.t()} | {:error, Polarex.HTTPValidationError.t()}
List Clients
List OAuth2 clients.
Options
page
: Page number, defaults to 1.limit
: Size of a page, defaults to 10. Maximum is 100.
@spec oauth2_clients_oauth2_create_client( Polarex.OAuth2ClientConfiguration.t(), keyword() ) :: {:ok, map()} | {:error, Polarex.HTTPValidationError.t()}
Create Client
Create an OAuth2 client.
@spec oauth2_clients_oauth2_delete_client( String.t(), keyword() ) :: {:ok, map()} | {:error, Polarex.HTTPValidationError.t()}
Delete Client
Delete an OAuth2 client.
@spec oauth2_clients_oauth2_get_client( String.t(), keyword() ) :: {:ok, map()} | {:error, Polarex.HTTPValidationError.t()}
Get Client
Get an OAuth2 client by Client ID.
@spec oauth2_clients_oauth2_update_client( String.t(), Polarex.OAuth2ClientConfigurationUpdate.t(), keyword() ) :: {:ok, map()} | {:error, Polarex.HTTPValidationError.t()}
Update Client
Update an OAuth2 client.
@spec oauth2_introspect_token( Polarex.IntrospectTokenRequest.t(), keyword() ) :: {:ok, Polarex.IntrospectTokenResponse.t()} | :error
Introspect Token
Get information about an access token.
@spec oauth2_request_token( Polarex.AuthorizationCodeTokenRequest.t() | Polarex.RefreshTokenRequest.t(), keyword() ) :: {:ok, Polarex.TokenResponse.t()} | :error
Request Token
Request an access token using a valid grant.
@spec oauth2_revoke_token( Polarex.RevokeTokenRequest.t(), keyword() ) :: {:ok, map()} | :error
Revoke Token
Revoke an access token or a refresh token.
@spec oauth2_userinfo(keyword()) :: {:ok, Polarex.UserInfoOrganization.t() | Polarex.UserInfoUser.t()} | :error
Get User Info
Get information about the authenticated user.