OAuth MBeans

We can manage an OAuth configuration using MBean programming.

OAuth20ClientMBean.xml

addClient - Register a new OAuth client.

Parameter name	Parameter type	Description
newClient	com.ibm.ws.security.oauth20.plugins.BaseClient	New OAuth client object

removeClient - Unregister an existing OAuth client.

Parameter name	Parameter type	Description
providerName	java.lang.String	OAuth Provider Name
clientId	java.lang.String	OAuth Client ID

OAuth20MBean.xml

reloadAllProviders - Reload all OAuth providers from the definition files on the file system.

reloadProvider - Reload an individual OAuth provider from the definition file on the file system.

Parameter name	Parameter type	Description
providerName	java.lang.String	OAuth provider name

updateProvider - Update parameters for an OAuth provider.

Parameter name	Parameter type	Description
providerName	java.lang.String	OAuth provider name
Parameters	java.util.List	OAuth provider configuration parameters

createProvider - Create a new OAuth provider and persists it to the file system.

Parameter name	Parameter type	Description
providerName	java.lang.String	OAuth provider name
xmlParams	java.util.List	XML Configuration Contents

deleteProvider - Delete an OAuth provider and its definition file.

Parameter name	Parameter type	Description
providerName	java.lang.String	OAuth provider name

updateProviderParameter - Update one parameter for an OAuth provider.

Parameter name	Parameter type	Description
providerName	java.lang.String	OAuth provider name
parameter	OAuth20Parameter	OAuth provider configuration parameter

deleteProviderParameter - Delete one parameter from an OAuth provider.

Parameter name	Parameter type	Description
providerName	java.lang.String	OAuth provider name
parameter	OAuth20Parameter	OAuth provider configuration parameter

removeOAuthTokenByClientID - Remove or revokes an OAuth token issued to the client ID and authorized by the user.

Parameter name	Parameter type	Description
providerName	java.lang.String	OAuth provider name
clientID	java.lang.String	OAuth Client ID
userName	java.lang.String	OAuth resource owner

removeAllOAuthTokenByClientID - Remove all OAuth tokens issued to the client ID.

Parameter name	Parameter type	Description
providerName	java.lang.String	OAuth provider name
clientID	java.lang.String	OAuth Client ID

removeAllOAuthTokenByUser - Remove all OAuth tokens issued by the user.

Parameter name	Parameter type	Description
providerName	java.lang.String	OAuth provider name
userName	java.lang.String	OAuth resource owner