Package org.wso2.carbon.identity.oauth2.dao

Interface OAuthUserConsentedScopesDAO

All Known Implementing Classes:

CacheBackedOAuthUserConsentedScopesDAOImpl, OAuthUserConsentedScopesDAOImpl

public interface OAuthUserConsentedScopesDAO

This interface defines the API for user consent management for OAuth scopes.

Method Summary

Modifier and Type	Method	Description
void	addUserConsentForApplication(String userId, int tenantId, UserApplicationScopeConsentDO userConsent)	Store users consent given for OAuth scopes for a given application.
void	deleteUserConsentOfApplication(String userId, String appId, int tenantId)	Remove user's consent given for an application.
void	deleteUserConsents(String userId, int tenantId)	Remove all user consents.
UserApplicationScopeConsentDO	getUserConsentForApplication(String userId, String appId, int tenantId)	Retrieve the user consent given for OAuth scopes for a given application.
List<UserApplicationScopeConsentDO>	getUserConsents(String userId, int tenantId)	Retrieve consents given for OAuth scopes by a user for user's all applications.
default void	updateExistingConsentForApplication(String userId, int tenantId, UserApplicationScopeConsentDO updatedUserConsents)	Deprecated. use updateExistingConsentForApplication(String, String, int, UserApplicationScopeConsentDO, UserApplicationScopeConsentDO) instead.
void	updateExistingConsentForApplication(String userId, String appId, int tenantId, UserApplicationScopeConsentDO consentsToBeAdded, UserApplicationScopeConsentDO consentsToBeUpdated)	Update users consent given for OAuth scopes for a given application.

Method Detail

getUserConsentForApplication

UserApplicationScopeConsentDO getUserConsentForApplication(String userId,
                                                           String appId,
                                                           int tenantId)
                                                    throws IdentityOAuth2ScopeConsentException

Retrieve the user consent given for OAuth scopes for a given application.

Parameters:

userId - User identifier.

appId - Application identifier.

tenantId - Tenant Id.

Returns:

UserApplicationScopeConsentDO

Throws:

IdentityOAuth2ScopeConsentException

getUserConsents

List<UserApplicationScopeConsentDO> getUserConsents(String userId,
                                                    int tenantId)
                                             throws IdentityOAuth2ScopeConsentException

Retrieve consents given for OAuth scopes by a user for user's all applications.

Parameters:

userId - User identifier.

tenantId - Tenant Id.

Returns:

List of UserApplicationScopeConsentDO

Throws:

IdentityOAuth2ScopeConsentException

addUserConsentForApplication

void addUserConsentForApplication(String userId,
                                  int tenantId,
                                  UserApplicationScopeConsentDO userConsent)
                           throws IdentityOAuth2ScopeConsentException

Store users consent given for OAuth scopes for a given application.

Parameters:

userId - User identifier.

tenantId - Tenant Id.

userConsent - User consent UserApplicationScopeConsentDO.

Throws:

IdentityOAuth2ScopeConsentException

updateExistingConsentForApplication

@Deprecated
default void updateExistingConsentForApplication(String userId,
                                                 int tenantId,
                                                 UserApplicationScopeConsentDO updatedUserConsents)
                                          throws IdentityOAuth2ScopeConsentException

Deprecated.

use updateExistingConsentForApplication(String, String, int, UserApplicationScopeConsentDO, UserApplicationScopeConsentDO) instead. Deprecated - Use

Update users consent given for OAuth scopes for a given application.

Parameters:

userId - User identifier.

tenantId - Tenant Id.

updatedUserConsents - Updated user consent UserApplicationScopeConsentDO.

Throws:

IdentityOAuth2ScopeConsentException

updateExistingConsentForApplication

void updateExistingConsentForApplication(String userId,
                                         String appId,
                                         int tenantId,
                                         UserApplicationScopeConsentDO consentsToBeAdded,
                                         UserApplicationScopeConsentDO consentsToBeUpdated)
                                  throws IdentityOAuth2ScopeConsentException

Update users consent given for OAuth scopes for a given application.

Parameters:

userId - User identifier.

appId - Application Id.

tenantId - Tenant Id.

consentsToBeAdded - Added user consent UserApplicationScopeConsentDO.

consentsToBeUpdated - Updated user consent UserApplicationScopeConsentDO.

Throws:

IdentityOAuth2ScopeConsentException

deleteUserConsentOfApplication

void deleteUserConsentOfApplication(String userId,
                                    String appId,
                                    int tenantId)
                             throws IdentityOAuth2ScopeConsentException

Remove user's consent given for an application.

Parameters:

userId - User identifier.

appId - Application identifier.

tenantId - Tenant Id.

Throws:

IdentityOAuth2ScopeConsentException

deleteUserConsents

void deleteUserConsents(String userId,
                        int tenantId)
                 throws IdentityOAuth2ScopeConsentException

Remove all user consents.

Parameters:

userId - User identifier.

tenantId - Tenant Id.

Throws:

IdentityOAuth2ScopeConsentException