POST OAuth/CreateApplication

Creates a new OAuth application.

Authorization

Roles: Admin. 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
Order	Name	Description
1	ApplicationId string	(Required) The ID of the application. This ID must be unique. It appears as the Client ID on the API Integrations list on the Trust Protection Platform web console, and as the ID in the API response.
2	Scope string	(Required) The minimum scope the application requires.
3	MaximumScope string	(Required) The maximum scope the application knows to use.
4	Name string	(Required) The name of the application.
5	Vendor string	(Required) The name of the vendor that created the application.
6	Description string	(Required) A description for the application.
7	Url string	(Required) A URl to learn more about the application.
8	AccessValidity integer	The seconds a token for this application should be valid. Not passing a value uses the system default.
9	GrantValidity integer	The seconds a grant for this application should be valid. Not passing a value uses the system default.
10	Renewable boolean	`true` or `false` to set default behavior grant renewals. Not passing a value uses the system default.

Returns

Response description
Name	Description
HTTP 200	See OAuth result codes. An Application object is returned showing the values passed in the parameters listed in the Request section above.
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/CreateApplication HTTP/1.1
Host: tpp-server-url
Content-Type: application/json
Accept: application/json
Authorization: Bearer 4MyGeneratedBearerTknz==
				
{
  "ApplicationId": "NewApplicationID",
  "Scope": "certificate",
  "MaxScope": "admin",
  "Name": "Name of the new application",
  "Vendor": "My Company, LLC",
  "Description": "This is the application description.",
  "Url": "help.sample-url.com"
}

Response

{
  "Application": {
    "Description": "This is the application description",
    "ID": "NewApplicationID",
    "MaximumScope": "admin",
    "Name": "Name of the new application",
    "Scope": "certificate",
    "Url": "help.sample-url.com",
    "Vendor": "My Company, LLC"
  },
  "Result": 0,
  "Success": true
}