Back-channel communication API

With a custom API identity provider, you might want to execute some logic or store some data that is used during user registration via a server that is outside the scope of a mobile application. You can use this endpoint to execute a custom script within the extension engine to store data to be used in later steps.

See the example scripts for help creating the scripts.

Execute the script for a specific identity provider

Endpoint: POST /oauth/api/v3/custom-registration/{idp}/backchannel

JSON body parameters

This endpoint requires valid API client credentials provided via basic authentication. It requires that the API client has the User Registration scope.

Example request

This example uses ExampleId for the identity provider ID:

POST /oauth/api/v3/custom-registration/ExampleId/backchannel HTTP/1.1
Host: onegini.example.com
Content-Type: application/json

{
   "data": "{\"custom_key\":\"custom_data\"}" //optional
}

Example success response

HTTP/1.1 200 Ok
Content-Type: application/json;charset=UTF-8
Cache-Control: no-store
Pragma: no-cache

{
   "status": 2000,
   "data": "{\"custom_response_key\":\"custom_response_data\"}"
}

Access error codes

One of the following responses is returned, containing a JSON object with an error code.