Applications

This REST API is used to create applications, retrieve application information, share applications with require users or teams, and delete the existing applications using a REST API.

List of resources

  • GET /applications

    Retrieves the list of applications in Developer Portal for the current user.

  • POST /applications

    Creates an application with the given data.

  • GET /applications/{id}

    Retrieves the application associated with the given Id.

  • PUT /applications/{id}

    Updates the application associated with the given Id.

  • DELETE /applications/{id}

    Deletes the application associated with the given Id.

    Note: To delete an inactive or obsolete applications, make a REST call to the following endpoint with the required application Id:
    DELETE 	/applications/{id}?force=true
  • PUT /applications/{id}/share

    Allows to share the specified application with a user or team.

  • DELETE /applications/{id}/share

    Allows to revoke the access of the specified application.

  • GET /applications/_all

    Retrieves the list of applications in Developer Portal irrespective of the users associated with them.

  • GET /applications/{id}/requests

    Retrieves the users requests received for the specified application.

  • GET /applications/{id}/tokens

    Retrieves the list of specified tokens generated for the specified application.

  • DELETE /applications/{id}/tokens/{tokenId}

    Deletes the specified tokens generated for the specified application.

  • GET /applications/{id}/scopes

    Retrieves the list of scopes mapped with the specified application.

Sample cURL Command

curl --location --request GET 'developer_portal_rest_base/applications' \
--header 'Authorization: Basic basic_auth'

The applications.yaml file is located at InstallDir\DeveloperPortal\developers\openapis.