com.pega.pegarules.pub.services.oauth2

Interface OAuth2ClientRegistrationService

public interface OAuth2ClientRegistrationService

Service for registering external clients which use Pega OAuth2.0 service

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	VERSION

Method Summary

Modifier and Type	Method and Description
ClipboardPage	computeClientSecretHash(ClipboardPage clientInfoPage) computes Client Secrets hash.
ClipboardPage	regenerateClientSecret(PublicAPI aTools, ClipboardPage clientInfoPage) Regenerates Client Secrets .
java.lang.String	registerClient(PRThread thread, java.lang.String clientinfo) Generates and registers a client from the given input clientinfo which is in json format The input clientinfo should contain values for the below properties : client_name - Name of the client client_description -Client description urn:ietf:params:oauth:grant-type:saml2-bearer - Saml bearer grant type client_credentials grant_types - Supported grant types identity_mapping_name - Mapping name for saml bearer grant type This method generates CLIENT_ID and CLIENT_SECRET and populates the response string with the generated details and returns back
ClipboardPage	registerClient(PublicAPI aTools, ClipboardPage clientInfoPage) Generates and registers a client from the given input ClipboardPage of "Data-Admin-Security-OAuth-Producer-Client" The input ClipboardPage should contain values for the below properties : pyClientName - Name of the client This method generates CLIENT_ID and CLIENT_SECRET and populates the clipboard page with the generated details and returns back the clipboard page that represents a registered third party client.
java.lang.String	registerMobileClient(PRThread thread, java.lang.String clientinfo) Generates and registers a client from the given input clientinfo which is in json format The input clientinfo should contain values for the below properties : client_name - Name of the client client_description -Client description urn:ietf:params:oauth:grant-type:saml2-bearer - Saml bearer grant type client_credentials grant_types - Supported grant types identity_mapping_name - Mapping name for saml bearer grant type This method generates CLIENT_ID and CLIENT_SECRET and populates the response string with the generated details and returns back

Field Detail

VERSION

static final java.lang.String VERSION

Method Detail

registerClient

ClipboardPage registerClient(PublicAPI aTools,
                             ClipboardPage clientInfoPage)

Generates and registers a client from the given input ClipboardPage of "Data-Admin-Security-OAuth-Producer-Client" The input ClipboardPage should contain values for the below properties : pyClientName - Name of the client This method generates CLIENT_ID and CLIENT_SECRET and populates the clipboard page with the generated details and returns back the clipboard page that represents a registered third party client.

Parameters:

aTools - an object of public api

clientInfoPage - a ClipboardPage of "Data-Admin-Security-OAuth-Producer-Client" class type

Returns:

A ClipboardPage of "Data-Admin-Security-OAuth-Producer-Client" class type populated with client registration details

regenerateClientSecret

ClipboardPage regenerateClientSecret(PublicAPI aTools,
                                     ClipboardPage clientInfoPage)

Regenerates Client Secrets . This method generates client secrets and adds it to the given clipboardPage .

Parameters:

aTools - an object of public api

clientInfoPage - a ClipboardPage of "Data-Admin-Security-OAuth-Producer-Client" class type

Returns:

A ClipboardPage of "Data-Admin-Security-OAuth-Producer-Client" class type populated with client registration details

computeClientSecretHash

ClipboardPage computeClientSecretHash(ClipboardPage clientInfoPage)

computes Client Secrets hash. This method generates client secrets hash and adds it to the given clipboardPage .

Parameters:

clientInfoPage - a ClipboardPage of "Data-Admin-Security-OAuth-Producer-Client" class type

Returns:

A ClipboardPage of "Data-Admin-Security-OAuth-Producer-Client" class type populated with client registration details

registerClient

java.lang.String registerClient(PRThread thread,
                                java.lang.String clientinfo)

Generates and registers a client from the given input clientinfo which is in json format The input clientinfo should contain values for the below properties : client_name - Name of the client client_description -Client description urn:ietf:params:oauth:grant-type:saml2-bearer - Saml bearer grant type client_credentials grant_types - Supported grant types identity_mapping_name - Mapping name for saml bearer grant type This method generates CLIENT_ID and CLIENT_SECRET and populates the response string with the generated details and returns back

Parameters:

thread - current context thread

clientinfo - Json string with client name, grant types

Returns:

a response string with clientID, client secret etc

registerMobileClient

java.lang.String registerMobileClient(PRThread thread,
                                      java.lang.String clientinfo)

Generates and registers a client from the given input clientinfo which is in json format The input clientinfo should contain values for the below properties : client_name - Name of the client client_description -Client description urn:ietf:params:oauth:grant-type:saml2-bearer - Saml bearer grant type client_credentials grant_types - Supported grant types identity_mapping_name - Mapping name for saml bearer grant type This method generates CLIENT_ID and CLIENT_SECRET and populates the response string with the generated details and returns back

Parameters:

thread - current context thread

clientinfo - Json string with client name, grant types

Returns:

a response string with clientID, client secret etc