POST OAuth/GetApplications
Searches for OAuth applications.
Requirements
- 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
Name |
Description |
---|---|
ApplicationIds array of strings |
(Required) The list of one or more application IDs. |
Returns
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:
|
HTTP 401 |
For authentication errors, this call returns HTTP 401 Unauthorized and the following data in the message body:
|
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.
|
Example
Request
POST /vedsdk/oauth/GetApplications HTTP/1.1 Host: tpp-server-url Content-Type: application/json Accept: application/json Authorization: Bearer 4MyGeneratedBearerTknz== { "ApplicationIds": [ "VenafiMMCEventViewer", "VenafiMMCReports", "VenafiCodeSignClient" ] }
Response
{ "Applications": [ { "Description": "MMC Venafi Event Viewer Plugin", "ID": "VenafiMMCEventViewer", "MaximumScope": "admin:grantrights,viewlogs;configuration;security", "Name": "Venafi Event Viewer", "Scope": "admin:grantrights,viewlogs;configuration;security", "Url": "https://www.venafi.com/", "Vendor": "Venafi, Inc." }, { "Description": "MMC Venafi Report Viewer Plugin", "ID": "VenafiMMCReports", "MaximumScope": "configuration:delete,manage;restricted:manage;security", "Name": "Venafi Report Viewer", "Scope": "configuration:delete,manage;restricted:manage;security", "Url": "https://www.venafi.com/", "Vendor": "Venafi, Inc." }, { "Description": "All Venafi Code Signing Clients (CSP, KSP, PKCS#11 library, etc)", "ID": "VenafiCodeSignClient", "MaximumScope": "codesignclient", "Name": "Venafi Code Signing Clients", "Scope": "codesignclient", "Url": "https://www.venafi.com/platform/code-signing", "Vendor": "Venafi, Inc." } ], "Result": 0, "Success": true }