PingFederate Application Policy API

PingID allows organizations to create web authentication policies, and apply them to one or more applications, or one or more user groups, or both. See Manage app and group lists in the PingID admin guide.

The PingID API provides operations for you to programmatically create, retrieve, update and delete entries in the PingFederate applications list. These operations provide the flexibility for batch or mass application updates, as an alternative to manual updates of individual applications via the admin UI. After the API operations are successfully completed and committed, the updated PingFederate application list is visible by refreshing the admin UI.

AddApplication

The AddApplication operation creates a new application entry in the PingFederate applications list.

This is the AddApplication URL:

https://idpxnyl3m.pingidentity.com/pingid/rest/4/addapplication/do

Request Body Parameters

Example reqBody object in the API payload:

reqBody: {
    "application": {
        "id": "<application ID>",
        "name": "<application name>"
    }
}

The parameters included in the reqBody object are:

The application parameters:

Response Body Parameters

Example response body:

{
  "responseBody": {
    "clientData": null,
    "errorId": 200,
    "errorMsg": null,
    "application": {
        "id": "<application ID>",
        "name": "<application name>"
    },
    "uniqueMsgId": "webs_DqQkivHN1hEzZfJjbcaOQdGcel7fBtZUVj7l1yNbuNI"
  }
}

The parameters included in the responseBody object are:

The application parameters:

GetApplications

The GetApplications operation retrieves application details from the PingFederate applications list.

This is the GetApplications URL:

https://idpxnyl3m.pingidentity.com/pingid/rest/4/getapplications/do

Request Body Parameters

Example reqBody object in the API payload:

"reqBody":{}

The optional parameter in the reqBody object:

Response Body Parameters

Example response body:

{
  "responseBody": {
    "clientData": null,
    "errorId": 200,
    "errorMsg": null,
    "applications": [
      {
        "id": "<application ID>",
        "name": "<application name>"
      }
    ],
    "uniqueMsgId": "webs_M5MrhPDA8TPjW7n-eaprHD3Bn3lbTmArviGdKhJ8r3U"
  }
}

The parameters included in the responseBody object are:

The application parameters:

UpdateApplications

The UpdateApplications operation updates specified existing application entries in the PingFederate applications list.

This is the UpdateApplications URL:

https://idpxnyl3m.pingidentity.com/pingid/rest/4/updateapplications/do

Request Body Parameters

Example reqBody object in the API payload:

reqBody: {
    "appsData": {
        "<application current ID>": {
	        "id": "<application new ID>",
	        "name": "<application new name>"
        }
    }
}

The parameters included in the reqBody object are:

Response Body Parameters

Example response body:

{
  "responseBody": {
    "clientData": null,
    "errorId": 200,
    "errorMsg": null,
    "uniqueMsgId": "webs_mVZV1fssdOe8Tf1-ubh01oQTnZfDO8FOIK-RVUWs0ng"
  }
}

The parameters included in the responseBody object are:

DeleteApplications

The DeleteApplications operation removes specified existing application entries in the PingFederate applications list.

This is the DeleteApplications URL:

https://idpxnyl3m.pingidentity.com/pingid/rest/4/deleteapplications/do

Request Body Parameters

Example reqBody object in the API payload:

reqBody : {
    "applicationsIds": ["<application ID>"]
}

The parameters included in the reqBody object are:

Response Body Parameters

Example response body:

{
  "responseBody": {
    "clientData": null,
    "errorId": 200,
    "errorMsg": null,
    "uniqueMsgId": "webs_9QxTikxO-MLHcFOTF9cX7kUQ4AzYwvM0q_Mt65QXwSI"
  }
}

The parameters included in the responseBody object are: