Ctrl+K

Get Signing Payload for Client Connections

get/api/network/v1/enterprises/{enterpriseId}/clients/connections/signing

This API call allows clients to get the client connections payload for signing.

Error scenarios:

  • 400: Invalid Request Error

  • Occurs when the request parameters are invalid or malformed

  • Examples: Empty string provided for entepriseId, missing required fields in request body.

  • 401: Authentication Error

  • Occurs when the request is not authorized

  • Examples: Caller is not a member of the enterprise.

  • 403: Permission Denied Error

  • Occurs when the authenticated client doesn't have necessary permissions.

  • Examples: Enterprise does not have OES license.

  • 404: Not Found Error

  • Occurs when the specified resources cannot be found.

  • Examples: Enterprise ID doesn't exist, specified partner ID doesn't exist.

  • 500: Internal Server Error

  • Occurs when there's an unexpected server error processing the request.

  • Examples: Database connection issues. Transient network errors.

Path Parameters

  • enterpriseIdstringRequired
    Min length: >= 1 characters

Request Body

partnerId string required
name string required
Min length: >= 1 characters
connectionKeyOne ofrequired
schema string required
Allowed value: token
connectionToken string required
Min length: >= 1 characters
nonce string required
Min length: >= 1 characters

200 Response

payload string required

400 Response

401 Response

error string required

403 Response

error string required

404 Response

error string required

422 Response

error string required

500 Response

error string required