GSMA Open Gateway

GSMA Open Gateway Application API

Operations for Application Resource

GitHub OpenAPI

Operations 4

POST /application Creates a Application #
GET /application List or find Application objects #
GET /application/{id} Retrieves a Application by ID #
PATCH /application/{id} Updates partially a Application #

Documentation

📖
Documentation
https://github.com/camaraproject/NumberVerification
📖
APIReference
https://camaraproject.github.io/swagger-ui/
📖
Documentation
https://www.gsma.com/solutions-and-impact/gsma-open-gateway/gsma-open-gateway-api-descriptions/
📖
Documentation
https://github.com/camaraproject/SimSwap
📖
Documentation
https://github.com/camaraproject/DeviceSwap
📖
Documentation
https://github.com/camaraproject/CallForwardingSignal
📖
Documentation
https://github.com/camaraproject/KnowYourCustomerMatch
📖
Documentation
https://github.com/camaraproject/KnowYourCustomerAgeVerification
📖
Documentation
https://github.com/camaraproject/Tenure
📖
Documentation
https://github.com/camaraproject/OTPValidation
📖
Documentation
https://github.com/camaraproject/QualityOnDemand
📖
Documentation
https://github.com/camaraproject/DeviceReachabilityStatus
📖
Documentation
https://github.com/camaraproject/DeviceIdentifier
📖
Documentation
https://github.com/camaraproject/DeviceStatus
📖
Documentation
https://github.com/camaraproject/PopulationDensityData
📖
Documentation
https://github.com/camaraproject/DeviceLocation
📖
Documentation
https://github.com/camaraproject/SimpleEdgeDiscovery
📖
Documentation
https://github.com/camaraproject/CarrierBillingCheckOut
📖
Documentation
https://github.com/camaraproject/HomeDevicesQoD
📖
Documentation
https://github.com/tmforum-apis/TMF931_OpenGatewayOnboardingAndOrderingComponentSuite
📖
APIReference
https://github.com/tmforum-apis/TMF931_OpenGatewayOnboardingAndOrderingComponentSuite

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/open-gateway/refs/heads/main/openapi/open-gateway-application-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/open-gateway-application-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

open-gateway-application-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Open Gateway Operate API Onboarding and Ordering Application API
  description: "**TMF931 - API Ordering, Developer & Application Onboarding and Management**   \n\nThis Operate API specification covers the onboarding operations between Channel Partners and Operators as described by GSMA. It offers a consolidation of multiple TM Forum based APIs into a single specification (a component suite). This API specification proposes : \n- Application Owner (Developer) Management (acceptance, onboarding, lifecycle management)  \n- Application Management (acceptance, onboarding, lifecycle management)  \n- Service API Management (ordering, retrieving)\n\nThis API is a composite DCS (Domain Context Specialization) of the following TMF Open APIs for Open Gateway context\n- TMF622 Product Ordering Management v5.0\n- TMF637 Product Inventory Management v5.0\n- TMF669 Party Role Management v5.0\n- TMF639 Resource Inventory v5.0\n\nCopyright © TM Forum 2025. All Rights Reserved\n"
  version: 5.2.1
  x-generation-tooling-version: v8.5.15
  x-generation-data-model-version: unknown
  x-generation-date: '2025-12-11T09:49:01.463Z'
  x-api-id: TMF931
  license:
    name: Apache License 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: '{apiRoot}/openGatewayOperateAPIOnboardingAndOrdering/v5/'
  variables:
    apiRoot:
      default: https://serverRoot/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5
      enum:
      - https://serverRoot/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5
tags:
- name: application
  description: Operations for Application Resource
paths:
  /application:
    post:
      tags:
      - application
      summary: Creates a Application
      description: This operation creates a Application entity.
      operationId: createApplication
      parameters:
      - $ref: '#/components/parameters/Fields'
      requestBody:
        $ref: '#/components/requestBodies/Application_FVO'
      responses:
        '201':
          $ref: '#/components/responses/201Application'
        '202':
          description: Accepted
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '409':
          $ref: '#/components/responses/409'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '503':
          $ref: '#/components/responses/503'
    get:
      tags:
      - application
      summary: List or find Application objects
      description: List or find Application objects
      operationId: listApplication
      parameters:
      - $ref: '#/components/parameters/Fields'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Before'
      - $ref: '#/components/parameters/After'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/Filter'
      responses:
        '200':
          $ref: '#/components/responses/200ApplicationArray'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '503':
          $ref: '#/components/responses/503'
  /application/{id}:
    get:
      tags:
      - application
      summary: Retrieves a Application by ID
      description: This operation retrieves a Application entity. Attribute selection enabled for all first level attributes.
      operationId: retrieveApplication
      parameters:
      - $ref: '#/components/parameters/Id'
      - $ref: '#/components/parameters/Fields'
      responses:
        '200':
          $ref: '#/components/responses/200Application_Get'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '503':
          $ref: '#/components/responses/503'
    patch:
      tags:
      - application
      summary: Updates partially a Application
      description: This operation updates partially a Application entity.
      operationId: patchApplication
      parameters:
      - $ref: '#/components/parameters/Id'
      - $ref: '#/components/parameters/Fields'
      requestBody:
        $ref: '#/components/requestBodies/Application_MVO'
      responses:
        '200':
          $ref: '#/components/responses/200Application_Patch'
        '202':
          description: Accepted
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '403':
          $ref: '#/components/responses/403'
        '404':
          $ref: '#/components/responses/404'
        '405':
          $ref: '#/components/responses/405'
        '409':
          $ref: '#/components/responses/409'
        '500':
          $ref: '#/components/responses/500'
        '501':
          $ref: '#/components/responses/501'
        '503':
          $ref: '#/components/responses/503'
components:
  examples:
    Create_an_Application_request:
      value:
        '@type': Application
        '@baseType': LogicalResource
        name: Evolve Quest
        commercialName: Evolve Quest
        logoUrl: https://channelpartner.com/opengateway/application/evolvequest/logo.jpg
        privacyPolicyURL: https://channelpartner.com/opengateway/application/evolvequest/privacyPolicy.html
        description: Evolve Quest mobile application
        redirectUrl:
        - https://channelpartner.com/opengateway/application/evolvequest/redirect
        jwksUri: https://channelpartner.com/opengateway/application/evolvequest/jwk
        category: games
        applicationOwner:
          '@type': PartyRoleRef
          id: e05b75dc-f843-40d9-8d16-112275a28385
          '@referredType': PartyRole
        privacyRightsRequestContact:
        - '@type': WebFormContactMedium
          '@baseType': ContactMedium
          id: '1'
          preferred: false
          url: https://contact.evolvequest.com
        - '@type': EmailContactMedium
          '@baseType': ContactMedium
          id: '2'
          preferred: true
          emailAddress: contact@evolvequest.com
        externalIdentifier:
        - '@type': ExternalIdentifier
          id: application_123
          owner: ChannelPartner
          externalIdentifierType: Application
      description: POST Application Request Example
    Update_an_Application_with_merge-patch_json_content_type_request:
      value:
        '@type': Application
        operationalState: disable
      description: An example of a request for updating an Application object.
    Update_an_Application_with_json-patch_json_content_type_response:
      value:
        '@type': Application
        '@baseType': LogicalResource
        id: f1cba17d-789a-4037-b3e3-2c96e887576c
        href: https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c
        name: Evolve Quest
        creationDate: '2024-12-02T14:00:00.00Z'
        commercialName: Evolve Quest
        logoUrl: https://channelpartner.com/opengateway/application/evolvequest/logo.jpg
        privacyPolicyURL: https://channelpartner.com/opengateway/application/evolvequest/privacyPolicy.html
        description: Evolve Quest mobile application
        redirectUrl:
        - https://channelpartner.com/opengateway/application/evolvequest/redirect
        jwksUri: https://channelpartner.com/opengateway/application/evolvequest/jwk
        category: games
        operationalState: disable
        approvalStatus: approved
        digitalIdentity:
          '@type': ApiDigitalIdentity
          clientId: evolve_quest_channelPartner15
          validFor:
            startDateTime: '2024-12-02T14:01:00.00Z'
        applicationOwner:
          '@type': PartyRoleRef
          id: e05b75dc-f843-40d9-8d16-112275a28385
          '@referredType': PartyRole
        privacyRightsRequestContact:
        - '@type': WebFormContactMedium
          '@baseType': ContactMedium
          id: '1'
          preferred: false
          url: https://contact.evolvequest.com
        - '@type': EmailContactMedium
          '@baseType': ContactMedium
          id: '2'
          preferred: true
          emailAddress: contact@evolvequest.com
        externalIdentifier:
        - '@type': ExternalIdentifier
          id: application_123
          owner: ChannelPartner
          externalIdentifierType: Application
        channelPartner:
          '@type': PartyRoleRef
          id: '15'
          '@referredType': PartyRole
      description: An example of a response for updating an Application object.
    Retrieve_a_list_of_Application_response:
      value:
      - '@type': Application
        '@baseType': LogicalResource
        id: f1cba17d-789a-4037-b3e3-2c96e887576c
        href: https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c
        name: Evolve Quest
        creationDate: '2024-12-02T14:00:00.00Z'
        commercialName: Evolve Quest
        logoUrl: https://channelpartner.com/opengateway/application/evolvequest/logo.jpg
        privacyPolicyURL: https://channelpartner.com/opengateway/application/evolvequest/privacyPolicy.html
        description: Evolve Quest mobile application
        redirectUrl:
        - https://channelpartner.com/opengateway/application/evolvequest/redirect
        jwksUri: https://channelpartner.com/opengateway/application/evolvequest/jwk
        category: games
        operationalState: enable
        approvalStatus: approved
        digitalIdentity:
          '@type': ApiDigitalIdentity
          clientId: evolve_quest_channelPartner15
          validFor:
            startDateTime: '2024-12-02T14:01:00.00Z'
        applicationOwner:
          '@type': PartyRoleRef
          id: e05b75dc-f843-40d9-8d16-112275a28385
          '@referredType': PartyRole
        privacyRightsRequestContact:
        - '@type': WebFormContactMedium
          '@baseType': ContactMedium
          id: '1'
          preferred: false
          url: https://contact.evolvequest.com
        - '@type': EmailContactMedium
          '@baseType': ContactMedium
          id: '2'
          preferred: true
          emailAddress: contact@evolvequest.com
        channelPartner:
          '@type': PartyRoleRef
          id: '15'
          '@referredType': PartyRole
      - '@type': Application
        '@baseType': LogicalResource
        id: '102'
        href: https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/102
        name: Evolve West
        creationDate: '2024-12-02T14:10:00.00Z'
        commercialName: Evolve West
        logoUrl: https://channelpartner.com/opengateway/application/evolvequest/logo.jpg
        privacyPolicyURL: https://channelpartner.com/opengateway/application/evolvequest/privacyPolicy.html
        description: Evolve West mobile application
        redirectUrl:
        - https://channelpartner.com/opengateway/application/evolvequest/redirect
        jwksUri: https://channelpartner.com/opengateway/application/evolvequest/jwk
        category: games
        operationalState: enable
        approvalStatus: approved
        digitalIdentity:
          '@type': ApiDigitalIdentity
          clientId: evolve_west_channelPartner15
          validFor:
            startDateTime: '2024-12-02T14:11:00.00Z'
        apiConsumerRole:
        - grantedPermissionSet:
          - '@type': ApiPermissionSet
            creationDate: '2025-04-02T15:00:00.00Z'
            permission:
              '@type': ApiConsumerPermission
              managedAssetGroup:
                '@type': ApiListAssetGroup
                '@baseType': AssetGroup
                apiProduct:
                - '@type': ProductRef
                  id: '123'
                  '@referredType': ApiProduct
            validFor:
              startDateTime: '2025-04-02T15:00:00.00Z'
        applicationOwner:
          '@type': PartyRoleRef
          id: e05b75dc-f843-40d9-8d16-112275a28385
          '@referredType': PartyRole
        privacyRightsRequestContact:
        - '@type': WebFormContactMedium
          '@baseType': ContactMedium
          id: '1'
          preferred: false
          url: https://contact.evolvewest.com
        - '@type': EmailContactMedium
          '@baseType': ContactMedium
          id: '2'
          preferred: true
          emailAddress: contact@evolvewest.com
        channelPartner:
          '@type': PartyRoleRef
          id: '15'
          '@referredType': PartyRole
      description: A collection of Application representation
    Update_an_Application_with_json_content_type_request:
      value:
        '@type': Application
        operationalState: disable
      description: Updating an Application object.
    Update_an_Application_with_json-patch_json_content_type_request:
      value:
      - op: replace
        path: /operationalState
        value: disable
      description: An example of a request for updating an Application object.
    Update_an_Application_with_json_content_type_response:
      value:
        '@type': Application
        '@baseType': LogicalResource
        id: f1cba17d-789a-4037-b3e3-2c96e887576c
        href: https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c
        name: Evolve Quest
        creationDate: '2024-12-02T14:00:00.00Z'
        commercialName: Evolve Quest
        logoUrl: https://channelpartner.com/opengateway/application/evolvequest/logo.jpg
        privacyPolicyURL: https://channelpartner.com/opengateway/application/evolvequest/privacyPolicy.html
        description: Evolve Quest mobile application
        redirectUrl:
        - https://channelpartner.com/opengateway/application/evolvequest/redirect
        jwksUri: https://channelpartner.com/opengateway/application/evolvequest/jwk
        category: games
        operationalState: disable
        approvalStatus: approved
        digitalIdentity:
          '@type': ApiDigitalIdentity
          clientId: evolve_quest_channelPartner15
          validFor:
            startDateTime: '2024-12-02T14:01:00.00Z'
        applicationOwner:
          '@type': PartyRoleRef
          id: e05b75dc-f843-40d9-8d16-112275a28385
          '@referredType': PartyRole
        privacyRightsRequestContact:
        - '@type': WebFormContactMedium
          '@baseType': ContactMedium
          id: '1'
          preferred: false
          url: https://contact.evolvequest.com
        - '@type': EmailContactMedium
          '@baseType': ContactMedium
          id: '2'
          preferred: true
          emailAddress: contact@evolvequest.com
        externalIdentifier:
        - '@type': ExternalIdentifier
          id: application_123
          owner: ChannelPartner
          externalIdentifierType: Application
        channelPartner:
          '@type': PartyRoleRef
          id: '15'
          '@referredType': PartyRole
      description: A response after PATCH-ing an Application object.
    Retrieve_an_Application_with_permissions_from_its_identifier_response:
      value:
        '@type': Application
        '@baseType': LogicalResource
        id: '102'
        href: https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/102
        name: Evolve West
        creationDate: '2024-12-02T14:10:00.00Z'
        commercialName: Evolve West
        logoUrl: https://channelpartner.com/opengateway/application/evolvequest/logo.jpg
        privacyPolicyURL: https://channelpartner.com/opengateway/application/evolvequest/privacyPolicy.html
        description: Evolve West mobile application
        redirectUrl:
        - https://channelpartner.com/opengateway/application/evolvequest/redirect
        jwksUri: https://channelpartner.com/opengateway/application/evolvequest/jwk
        category: games
        operationalState: enable
        approvalStatus: approved
        digitalIdentity:
          '@type': ApiDigitalIdentity
          clientId: evolve_west_channelPartner15
          validFor:
            startDateTime: '2024-12-02T14:11:00.00Z'
        apiConsumerRole:
        - grantedPermissionSet:
          - '@type': ApiPermissionSet
            creationDate: '2025-04-02T15:00:00.00Z'
            permission:
              '@type': ApiConsumerPermission
              managedAssetGroup:
                '@type': ApiListAssetGroup
                '@baseType': AssetGroup
                apiProduct:
                - '@type': ProductRef
                  id: '123'
                  '@referredType': ApiProduct
            validFor:
              startDateTime: '2025-04-02T15:00:00.00Z'
        applicationOwner:
          '@type': PartyRoleRef
          id: e05b75dc-f843-40d9-8d16-112275a28385
          '@referredType': PartyRole
        privacyRightsRequestContact:
        - '@type': WebFormContactMedium
          '@baseType': ContactMedium
          id: '1'
          preferred: false
          url: https://contact.evolvewest.com
        - '@type': EmailContactMedium
          '@baseType': ContactMedium
          id: '2'
          preferred: true
          emailAddress: contact@evolvewest.com
        channelPartner:
          '@type': PartyRoleRef
          id: '15'
          '@referredType': PartyRole
      description: Application representation
    Retrieve_an_Application_without_digital_identity_from_its_identifier_response:
      value:
        '@type': Application
        '@baseType': LogicalResource
        id: '103'
        href: https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/103
        name: Evolve East
        creationDate: '2024-12-02T14:20:00.00Z'
        commercialName: Evolve East
        logoUrl: https://evolveeast.com/logo.jpg
        privacyPolicyURL: https://evolveeast.com/privacyPolicy.html
        description: Evolve East mobile application
        category: games
        operationalState: enable
        approvalStatus: approved
        applicationOwner:
          '@type': PartyRoleRef
          id: e05b75dc-f843-40d9-8d16-112275a28385
          '@referredType': PartyRole
        externalIdentifier:
        - '@type': ExternalIdentifier
          id: application_123
          owner: ChannelPartner
          externalIdentifierType: Application
        privacyRightsRequestContact:
        - '@type': WebFormContactMedium
          '@baseType': ContactMedium
          id: '1'
          preferred: false
          url: https://contact.evolveeast.com
        - '@type': EmailContactMedium
          '@baseType': ContactMedium
          id: '2'
          preferred: true
          emailAddress: contact@evolveeast.com
        channelPartner:
          '@type': PartyRoleRef
          id: '15'
          '@referredType': PartyRole
      description: Application representation
    Retrieve_a_list_of_Application_with_field_selection_and_filter_response:
      value:
      - '@type': Application
        '@baseType': LogicalResource
        id: f1cba17d-789a-4037-b3e3-2c96e887576c
        href: https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c
        approvalStatus: approved
        applicationOwner:
          '@type': PartyRoleRef
          id: e05b75dc-f843-40d9-8d16-112275a28385
      - '@type': Application
        '@baseType': LogicalResource
        id: '102'
        href: https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/102
        approvalStatus: approved
        applicationOwner:
          '@type': PartyRoleRef
          id: e05b75dc-f843-40d9-8d16-112275a28385
          '@referredType': PartyRole
      description: A collection of Application with field selection and filter
    Create_an_Application_response:
      value:
        '@type': Application
        '@baseType': LogicalResource
        id: f1cba17d-789a-4037-b3e3-2c96e887576c
        href: https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c
        name: Evolve Quest
        creationDate: '2024-12-02T14:00:00.00Z'
        commercialName: Evolve Quest
        logoUrl: https://channelpartner.com/opengateway/application/evolvequest/logo.jpg
        privacyPolicyURL: https://channelpartner.com/opengateway/application/evolvequest/privacyPolicy.html
        description: Evolve Quest mobile application
        redirectUrl:
        - https://channelpartner.com/opengateway/application/evolvequest/redirect
        jwksUri: https://channelpartner.com/opengateway/application/evolvequest/jwk
        category: games
        operationalState: enable
        approvalStatus: approved
        digitalIdentity:
          '@type': ApiDigitalIdentity
          clientId: evolve_quest_channelPartner15
        applicationOwner:
          '@type': PartyRoleRef
          id: e05b75dc-f843-40d9-8d16-112275a28385
          '@referredType': PartyRole
        privacyRightsRequestContact:
        - '@type': WebFormContactMedium
          '@baseType': ContactMedium
          id: '1'
          preferred: false
          url: https://contact.evolvequest.com
        - '@type': EmailContactMedium
          '@baseType': ContactMedium
          id: '2'
          preferred: true
          emailAddress: contact@evolvequest.com
        externalIdentifier:
        - '@type': ExternalIdentifier
          id: application_123
          owner: ChannelPartner
          externalIdentifierType: Application
        channelPartner:
          '@type': PartyRoleRef
          id: '15'
          '@referredType': PartyRole
      description: POST Application Response Example
    Update_an_Application_with_json-patch-query_json_content_type_response:
      value:
        '@type': Application
        '@baseType': LogicalResource
        id: f1cba17d-789a-4037-b3e3-2c96e887576c
        href: https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c
        name: Evolve Quest
        creationDate: '2024-12-02T14:00:00.00Z'
        commercialName: Evolve Quest
        logoUrl: https://channelpartner.com/opengateway/application/evolvequest/logo.jpg
        privacyPolicyURL: https://channelpartner.com/opengateway/application/evolvequest/privacyPolicy.html
        description: Evolve Quest mobile application
        redirectUrl:
        - https://channelpartner.com/opengateway/application/evolvequest/redirect
        jwksUri: https://channelpartner.com/opengateway/application/evolvequest/jwk
        category: games
        operationalState: disable
        approvalStatus: approved
        digitalIdentity:
          '@type': ApiDigitalIdentity
          clientId: evolve_quest_channelPartner15
          validFor:
            startDateTime: '2024-12-02T14:01:00.00Z'
        applicationOwner:
          '@type': PartyRoleRef
          id: e05b75dc-f843-40d9-8d16-112275a28385
          '@referredType': PartyRole
        privacyRightsRequestContact:
        - '@type': WebFormContactMedium
          '@baseType': ContactMedium
          id: '1'
          preferred: false
          url: https://contact.evolvequest.com
        - '@type': EmailContactMedium
          '@baseType': ContactMedium
          id: '2'
          preferred: true
          emailAddress: contact@evolvequest.com
        externalIdentifier:
        - '@type': ExternalIdentifier
          id: application_124
          owner: ChannelPartner
          externalIdentifierType: Application
        channelPartner:
          '@type': PartyRoleRef
          id: '15'
          '@referredType': PartyRole
      description: An example of a response for updating an Application object.
    Retrieve_an_Application_from_its_identifier_response:
      value:
        '@type': Application
        '@baseType': LogicalResource
        id: f1cba17d-789a-4037-b3e3-2c96e887576c
        href: https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c
        name: Evolve Quest
        creationDate: '2024-12-02T14:00:00.00Z'
        commercialName: Evolve Quest
        logoUrl: https://channelpartner.com/opengateway/application/evolvequest/logo.jpg
        privacyPolicyURL: https://channelpartner.com/opengateway/application/evolvequest/privacyPolicy.html
        description: Evolve Quest mobile application
        redirectUrl:
        - https://channelpartner.com/opengateway/application/evolvequest/redirect
        jwksUri: https://channelpartner.com/opengateway/application/evolvequest/jwk
        category: games
        operationalState: enable
        approvalStatus: approved
        digitalIdentity:
          '@type': ApiDigitalIdentity
          clientId: evolve_quest_channelPartner15
          validFor:
            startDateTime: '2024-12-02T14:01:00.00Z'
        applicationOwner:
          '@type': PartyRoleRef
          id: e05b75dc-f843-40d9-8d16-112275a28385
          '@referredType': PartyRole
        privacyRightsRequestContact:
        - '@type': WebFormContactMedium
          '@baseType': ContactMedium
          id: '1'
          preferred: false
          url: https://contact.evolvequest.com
        - '@type': EmailContactMedium
          '@baseType': ContactMedium
          id: '2'
          preferred: true
          emailAddress: contact@evolvequest.com
        channelPartner:
          '@type': PartyRoleRef
          id: '15'
          '@referredType': PartyRole
      description: Application representation
    Update_an_Application_with_merge-patch_json_content_type_response:
      value:
        '@type': Application
        '@baseType': LogicalResource
        id: f1cba17d-789a-4037-b3e3-2c96e887576c
        href: https://mycsp.com/tmf-api/openGatewayOperateAPIOnboardingAndOrdering/v5/application/f1cba17d-789a-4037-b3e3-2c96e887576c
        name: Evolve Quest
        creationDate: '2024-12-02T14:00:00.00Z'
        commercialName: Evolve Quest
        logoUrl: https://channelpartner.com/opengateway/application/evolvequest/logo.jpg
        privacyPolicyURL: https://channelpartner.com/opengateway/application/evolvequest/privacyPolicy.html
        description: Evolve Quest mobile application
        redirectUrl:
        - https://channelpartner.com/opengateway/application/evolvequest/redirect
        jwksUri: https://channelpartner.com/opengateway/application/evolvequest/jwk
        category: games
        operationalState: disable
        approvalStatus: approved
        digitalIdentity:
          '@type': ApiDigitalIdentity
          clientId: evolve_quest_channelPartner15
          validFor:
            startDateTime: '2024-12-02T14:01:00.00Z'
        applicationOwner:
          '@type': PartyRoleRef
          id: e05b75dc-f843-40d9-8d16-112275a28385
          '@referredType': PartyRole
        privacyRightsRequestContact:
        - '@type': WebFormContactMedium
          '@baseType': ContactMedium
          id: '1'
          preferred: false
          url: https://contact.evolvequest.com
        - '@type': EmailContactMedium
          '@baseType': ContactMedium
          id: '2'
          preferred: true
          emailAddress: contact@evolvequest.com
        externalIdentifier:
        - '@type': ExternalIdentifier
          id: application_123
          owner: ChannelPartner
          externalIdentifierType: Application
        channelPartner:
          '@type': PartyRoleRef
          id: '15'
          '@referredType': PartyRole
      description: An example of a response for updating an Application object.
    Update_an_Application_with_json-patch-query_json_content_type_request:
      value:
      - op: replace
        path: /externalIdentifier?id=application_123
        value:
          '@type': ExternalIdentifier
          id: application_124
          owner: ChannelPartner
          externalIdentifierType: Application
      description: An example of a request for updating an Application object.
  schemas:
    EntityRef:
      allOf:
      - $ref: '#/components/schemas/Extensible'
      - $ref: '#/components/schemas/Addressable'
      - type: object
        description: Entity reference schema to be use for all entityRef class.
        properties:
          id:
            type: string
            description: The identifier of the referred entity.
          href:
            type: string
            description: The URI of the referred entity.
          name:
            type: string
            description: Name of the referred entity.
          '@referredType':
            type: string
            description: The actual type of the target instance when needed for disambiguation.
        required:
        - id
    Application_MVO:
      allOf:
      - $ref: '#/components/schemas/LogicalResource_MVO'
      - type: object
        description: Application is a logical resource that can consume API products. It's a specialization of a LogicalResource in the Open Gateway context.
        properties:
          commercialName:
            type: string
            description: Exact name of the Application as marketed (and known by the end-user).
          logoUrl:
            type: string
            description: Url to retrieve the Application official logo.
          privacyPolicyURL:
            type: string
            description: Url to Application privacy policy, if applicable.
          redirectUrl:
            type: array
            items:
              type: string
            description: After a user successfully authorizes an application, the authorization server will redirect the user back to the application.
          jwksUri:
            type: string
            description: 'Uri pointing to a JSON Web Key (JWK) : data structure that represents a cryptographic key'
          category:
            $ref: '#/components/schemas/ApplicationCategoryType'
          approvalStatusReason:
            type: string
            description: The reason why the approval state changed. DEPRECATED in the PATCH (bug to be fixed on next major version).
          privacyRightsRequestContact:
            type: array
            items:
              $ref: '#/components/schemas/ContactMedium'
            description: Contact information for the exercise of data protection rights to which the End Users can address. Must be only EmailContactMedium or WebFormContactMedium for this context.
          digitalIdentity:
            $ref: '#/components/schemas/ApiDigitalIdentity_MVO'
    JsonPatchOperations:
      description: JSONPatch Operations document as defined by RFC 6902
      type: array
      items:
        $ref: '#/components/schemas/JsonPatch'
    Extensible:
      type: object
      description: Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema  MUST be extended with the @type
      properties:
        '@type':
          type: string
          description: When sub-classing, this defines the sub-class Extensible name
        '@baseType':
          type: string
          description: When sub-classing, this defines the super-class
        '@schemaLocation':
          type: string
          description: A URI to a JSON-Schema file that defines additional attributes and relationships
      required:
      - '@type'
    LogicalResourceRole:
      type: object
      description: A logical Resource Role is a role given to a logical resource in a given context.
      properties:
        grantedPermissionSet:
          description: The PermissionSet is a set of Permissions granted to a user (party, party role, resource or resource role). The set may be granted explicitly by an authorized user or may be acquired implicitly due to the role that the user is playing.
          type: array
          items:
            $ref: '#/components/schemas/ApiPermissionSet'

# --- truncated at 32 KB (70 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/open-gateway/refs/heads/main/openapi/open-gateway-application-api-openapi.yml