Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    Description String Body App Description
    Flow String Body App Grant Type
    IsTradingEnabled Boolean Body Enable trading capability for OAuth2App, default is false. Optional field.
    Name String Body App Name
    RedirectUri String Body Optional input param to specify redirect uri during app creation
    RedirectUriLabel String Body Optional input param to specify redirect uri label during app creation
  • Response Parameters

    View Response Codes
    Name Type Description
    AppKey String Unique app key - exposed to end users
    Brandings BrandingDto [] Service providers
    CreatedBy UserDto Created by user reference default
    Description String Description
    Endpoints EndpointDto Endpoint list for OAuth app
    Flow String SSO Authentication flow
    IsActive Boolean App is active
    IsTradingEnabled Boolean Derived field from 'OnlineAuthzLevels' and 'OfflineAuthzLevels'
    ManualOrderIndicationDefault String Manual order indication default
    ManualOrderIndicator String Manual order indication default
    Name String The name of the app
    Status AppStatus App status
  • Request Example

    Request URL
    POST /developer/apps
    Request Body
    {
      "Description": "New App Description",
      "Flow": "Code",
      "IsTradingEnabled": true,
      "Name": "New App Name",
      "RedirectUri": "http://my.domain/myApp",
      "RedirectUriLabel": ""
    }
    
  • Response Example

    Response body
    {
      "AppKey": "stringValue",
      "Brandings": [
        {
          "Description": "stringValue",
          "Id": 99,
          "Name": "stringValue"
        }
      ],
      "CreatedBy": {
        "Name": "stringValue",
        "UserKey": "stringValue"
      },
      "Description": "stringValue",
      "Endpoints": {
        "AuthorizationEndpoint": "stringValue",
        "TokenEndpoint": "stringValue"
      },
      "Flow": "stringValue",
      "IsActive": true,
      "IsTradingEnabled": false,
      "ManualOrderIndicationDefault": "stringValue",
      "ManualOrderIndicator": "stringValue",
      "Name": "stringValue",
      "Status": "Rejected"
    }