Service Applications - REST Provider and Consumer

For the case where the client is actually calling the same resource (local REST integrations), the administrator can select the application type as Client and Resource.

Access the Service Application page (select PeopleTools, and then Security, and then OAuth2 Administration, and then Create OAuth2 Service Apps) and select the Client and Resource button.

This example illustrates the fields and controls on the Service Applications - Client and Resource page.

Service Application page for Client and Resource
Term Definition

Client ID

The API Key value generated when you registered your application with the OAuth server.

Client Secret

The Secret Key value generated from the OAuth server.

Authorization Grant

The Authorization Grant drop-down options are available only for the IDCS authorization server.

Applications can request an access token to access protected endpoints in different ways, depending on the type of grant type specified in the client application. A grant is a credential representing the resource owner's authorization to access a protected resource.

Currently PeopleSoft supports the following grant types:

  • Authorization Code (3-legged)

  • Assertion (2-legged)

  • Client Credentials (2-legged)

For Azure, Okta, and Ping, Authorization Code is the only available authorization grant.

See Authorization Grant Types for more information.

Refresh Token

When you select the check box, it saves a refresh token to use when access token expires and retrieves an updated access token.

Note: The OAuth server needs to be configured to generate a refresh token along with an access token.

Authorized Endpoint

It is an HTTP endpoint that clients can use to identify a user or obtain an authorization code (which is then later exchanged for an access token) to be able to post to their website.

Token Endpoint

It is an HTTP endpoint that clients can use to obtain an access token.

Issuer

The issuer of the token.

Redirect URl

The URL is auto-generated based on the REST Target Location entry under Service Configuration. This URL should be copied and entered for IDCS to make the appropriate callbacks.

Scope URL

The scope URL is specific to the different authorization servers:

For IDCS, the scope URL is auto-generated based on the information defined on the Service Configuration Target Locations page.

For Azure, it is defined as Azure Resource-Client-ID.

Primary Audience

The primary recipient where the token is processed. In this case it is the secure REST target location as defined on the Target Locations page. The administrator can append additional information to the URL to make it specific for a Service Operation.