PingFederate Server

Managing OAuth clients

An OAuth client application interacts with an OAuth authorization server to obtain the required access tokens to call OAuth-protected services at the resource server.

About this task

The Clients window displays 20 clients at a time. You can sort the display order by name, ID, creation date, or last modified timestamps. You can use the pagination controls to navigate through the rest of the clients or search clients by name or ID. A client is included in the search results if its name or ID is a partial, case-insensitive match to the search term. NOTE: Due to limits on query performance, when you sort by the creation or modification date, clients that are stored in a Java Database Connectivity (JDBC) datastore and have no value defined for the sort field will not be displayed.

Steps

  1. To manage OAuth clients, go to Applications → OAuth → Clients.

    Action Steps

    To add a client

    Click Add Client and complete the configuration in the Client window.

    To edit a recently modified client

    Select the client and update the configuration in the Client window.

    To enable or disable one or more clients

    Click their toggle switches and then click Save.

    To remove a client or cancel the removal request

    Use the Delete and Undelete buttons for the applicable client and then click Save.

Result

PingFederate stores client records in XML files by default. On-disk storage allows you to manage clients using the administrative console and the administrative API. Client records are part of the configuration archive.

Alternatively, you can configure PingFederate to store client records externally, which allows you to manage client records through the OAuth Client Management Service or enable dynamic client registration for your partner-developers. In this case, client records are not part of the configuration archive. Instead, PingFederate stores them on a database server, a directory server, or another storage medium through the use of the PingFederate SDK. For more information, see OAuth client datastores.