Specifies the API endpoint that the provider uses to test the connection to ADP.

Syntax

Connect-ADP -TestConnectionEndpoint string

Possible Values

Data Type

cstr

Default Value

"workers"

Remarks

This property defines which ADP REST API resource the cmdlet queries to confirm that authentication was successful and that the connection is active.

During connection testing, the cmdlet performs a simple GET request to the specified endpoint to verify that valid credentials and API access are in place.

The default endpoint is workers, which is accessible in most ADP environments. If your account does not have permission to access this endpoint, set the property to an alternate resource such as worker-demographics.

This property is useful for troubleshooting authentication issues or validating connectivity when working in limited-access or custom ADP API environments.