/api/network/v1/enterprises/{enterpriseId}/clients/connections/{connectionId}
Returns an OES connection by its connection ID. For use only by OES clients.
Error scenarios:
400: Invalid Request Error
Occurs when the request parameters are invalid or malformed
Examples: Invalid UUID format for connectionId, invalid enterpriseId format
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 connection cannot be found.
Examples: Connection ID doesn't exist, connection doesn't belong to this client.
500: Internal Server Error
Occurs when there's an unexpected server error processing the request.
Examples: Database connection issues, transient network errors.
connectionId
stringRequiredenterpriseId
stringRequired>= 1 characters
connection
object required id
string required name
string required >= 1 characters
clientId
string required partnerId
string required networkAccountId
string required createdAt
string <date-time>
required updatedAt
string <date-time>
required active
boolean required proof
string required >= 1 characters
nonce
string required >= 1 characters
partnersConnectionId
>= 1 characters
partnersClientId
>= 1 characters
initialized
boolean required error
string required error
string required error
string required error
string required