GET
/
v1
/
protected
Protected endpoint requiring authentication
curl --request GET \
  --url https://public.api.collectpure.com/v1/protected \
  --header 'x-api-key: <api-key>'
{
  "message": "<string>",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

A test endpoint that requires authentication to access. This endpoint can be used to verify that your authentication credentials are working correctly and to retrieve your organization ID.

​
Authentication

This endpoint supports two authentication methods:

​
API Key Authentication

Include a valid API key in the x-api-key header of the request:

"x-api-key": "00000000-0000-0000-0000-000000000000"

​
OAuth Authentication

Include the following headers in your request:

"x-auth-token": "oauth-token"
"x-public-key": "your-public-key"
"x-secret-key": "your-secret-key"

​
Response Example

{
  "message": "Successfully authenticated",
  "organizationId": "550e8400-e29b-41d4-a716-446655440000"
}

​
Error Response

If authentication fails, you will receive a 401 Unauthorized response:

{
  "error": "Invalid or missing authentication credentials"
}

​
Using Your Organization ID

The organizationId returned by this endpoint is your unique identifier in the Pure system. This ID may be required for certain operations or when contacting support about your account.

Authorizations

​
x-api-key
string
header
required

API key for authentication

Response

200
application/json

Default Response

The response is of type object.