Use the GET /authenticationApi/applications/{{appId}} endpoint to retrieve an authentication API application resource with the specified ID. A 404 status code is returned for nonexistent IDs.

Path parameters

Parameter Value Description
appId string(required) ID of the Authentication API Application to retrieve.

Status codes

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

AuthnApiApplication - Authentication API Application.

Property Type Description
additionalAllowedOrigins array[string] The domain in the redirect URL is always whitelisted. This field contains a list of additional allowed origin URL’s for cross-origin resource sharing.
description string The Authentication API Application description.
id * string The persistent, unique ID for the Authentication API application. It can be any combination of [a-zA-Z0-9._-]. This property is system-assigned if not specified.
name * string The Authentication API Application Name. Name must be unique.
url * string The Authentication API Application redirect URL.