POST OAuth/EnumerateApplications

Enumerates all known OAuth applications.

For the Admin, Auditor, and Grant Admin roles, this call enumerates all applications. For theApplication Maintainer and Application Owner roles, this call enumerates only the applications for which they have a role.

Authorization

Roles: Admin, Grant Admin, Auditor, Application Owner, or Application Maintainer. See OAuth roles for more information.
Token scope: Admin

Headers

Content type: Content-Type:application/json.
Token: The bearer access token that you received. For example, Authorization:Bearer 4MyGeneratedBearerTknz==. For more information, see Passing a bearer token in your API calls.

Parameters

Body parameters
Name	Description
Start integer	(Required) The page of results to display. The Count parameter is required, and it will determine the number of results to show per page.
Count integer	(Required) The number of results to show per page. Request a specific page using the Start parameter.
OrderBy integer	The field for the rules to be ordered by. The following values can be passed: `0`: No order specified (default) `1`: Order results by name `2`: Order results by vendor `3`: Order results by access validity
Descending boolean	Set to `true` to return results in descending order, `false` (default) to return in ascending order.

Returns

Response description
Name	Description
HTTP 200	See OAuth result codes. An Applications array is returned with application details for each ApplicationId passed in the request. For descriptions of each value, see the Parameters section of POST OAuth/CreateApplication.
HTTP 400	For invalid requests, this call returns HTTP 400 Bad Request and the following data in the message body: Error invalid_request: The request is missing a required parameter or is otherwise malformed. Error_description: If available, additional information about how to retry the request.
HTTP 401	For authentication errors, this call returns HTTP 401 Unauthorized and the following data in the message body: Error invalid_token: The access token is missing, or the provided token is expired, revoked, malformed, or invalid for other reasons. insufficient_rights: The underlying user account does not have sufficient permissions for this request. error_description: If available, additional information about how to retry the request.
HTTP 403	If the response is HTTP 403 Forbidden, the requester's token does not include the admin scope. Call POST Authorize/OAuth with the correct scope and restriction. Update the header with the new token and retry. Error insufficient_scope: The request requires a greater scope than provided by the access token. error_description: If available, additional information about how to retry the request.

Example

Request

POST /vedsdk/oauth/enumerateapplications HTTP/1.1
Host: tpp-server-url
Content-Type: application/json
Accept: application/json
Authorization: Bearer 4MyGeneratedBearerTknz==
				
{
  "Start": 0,
  "Count": 3,
  "OrderBy": 1,
  "Descending": false
}

Response

{
  "Applications": [
    {
      "Description": "This is the application description for Application 1.",
      "ID": "Application-1",
      "MaximumScope": "Admin",
      "Name": "Application One",
      "Scope": "certificate",
      "Url": "sample-url.com",
      "Vendor": "My Company, LLC"
    },
    {
      "Description": "This is the application description for Application 3.",
      "ID": "Application-3",
      "MaximumScope": "Admin",
      "Name": "Application Three",
      "Scope": "statistics:manage",
      "Url": "sample-url.net",
      "Vendor": "Example, LLC"
    },
    {
      "Description": "This is the application description for Application 2.",
      "ID": "Application-2",
      "MaximumScope": "Admin",
      "Name": "Application Two",
      "Scope": "ssh",
      "Url": "sample-url.org",
      "Vendor": "Sample, LLC"
    }
  ],
  "Result": 0,
  "Success": true
}