Create a new OES Partner. This endpoint allows enterprise users to add themselves as a partner in OES for clients to connect to.
Before calling this endpoint, a configuration for the partner must exist.
If a config is not present for the partner, the request will fail with a 422 error.
To initiate the creation of a partner config, please reach out to the Go Network Engineering team at: [email protected].
Error scenarios:
-
400: Invalid Request Error
-
Occurs when the request parameters are invalid or incomplete.
-
Examples: Empty string supplied for enterpriseId, invalid connection key schema.
-
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 partner doesn't have access to create a partner.
-
Examples: Enterprise does not have OES license.
-
422: Unprocessable Entity Error
-
Returned when a required partner configuration is missing.
-
Examples: Partner configuration is missing.
-
500: Internal Server Error
-
Occurs when there's an unexpected error processing the request
-
Examples: Database connection failure, transient network error.