Use the GET /idp/adapters/{{idpAdapterId}}/actions/{{idpActionId}} endpoint to retrieve an IdP adapter instance action by ID. A 404 status code is returned for nonexistent IDs.

Path parameters

Parameter Value Description
idpAdapterId string(required) ID of the IdP adapter instance to which these actions belongs to.
idpActionId string(required) ID of the action to get.

Status codes

Code Reason
200 Success.
403 PingFederate does not have its IdP role enabled. Operation not available.
404 Resource not found.

Action - A read-only plugin action that either represents a file download or an arbitrary invocation performed by the plugin.

Property Type Description
description string The description of this action.
download boolean Whether this action will trigger a download or invoke an internal action that will return a string result.
id string The ID of this action.
invocationRef ResourceLink Whether this action will trigger a download or invoke an internal action that will return a string result.
name string The name of this action.

ResourceLink - A reference to a resource.

Property Type Description
id * string The ID of the resource.
location string A read-only URL that references the resource. If the resource is not currently URL-accessible, this property will be null.