Skip to content
Port OS

Refresh tokens for an auth link

← HTTP API reference
View source specification ↗
POST /auth-links/refresh

Refreshes the credentials associated with an auth link. For OAuth-based links this exchanges the refresh token for a new access token via the plugin's token endpoint. For API-key-based links the key is returned as-is. The auth link is updated with the refreshed credentials.

Requires a signed user/session or the existing authenticated client flow. The anonymous DCR delegated device profile cannot invoke this operation.

Required scope

Any authenticated access token

Request body

Fields

authLinkIdstringRequired

The ID of the auth link to refresh tokens for

Returns

200

Token refreshed successfully

No response body.

Errors

400

Invalid request payload

Check the request fields and any validation details, then correct the payload.

500

Internal server error

Retry with backoff only when the operation is safe to repeat. Include the error code when reporting persistent failures.