Enabling OAuth 2.0 authorization - PingFederate

Enabling OAuth 2.0 authorization - PingFederate - 10.1

PingFederate Server

bundle

pingfederate-101

ft:publication_title

PingFederate Server

Product_Version_ce

PingFederate 10.1

category

Product

pf-101

pingfederate

ContentType_ce

Page created: 8 Jun 2020 |

Page updated: 15 Jul 2020

| 1 min read

10.1 PingFederate Product Audience User task Content Type Deployment Method Developer Development Application Developer OAuth Standards, specifications, and protocols

PingFederate clients can gain access to the administrative API endpoint by providing an OAuth 2.0 access token. The <pf_install>/pingfederate/bin/oauth2.properties file contains settings that allow you to configure information required to interact with the authorization server as a client.

Set the pf.admin.api.authentication value in <pf_install>/pingfederate/bin/run.properties to OAuth2.
In the <pf_install>/pingfederate/bin/oauth2.properties file, change property values as needed. For instructions and additional information, see the comments in the file.

Important:
Remember to assign at least one of the PingFederate administrative roles, as indicated in the properties file. For information about permissions attached to the PingFederate roles, see the PingFederate User Access Control table in Configure access to the administrative API.
Restart PingFederate.

Note:
In a clustered PingFederate environment, you only need to modify run.properties and oauth2.properties on the console node.