XOMNI: Experience Omni-Channel

Last Updated: March 24, 2016

The APIs can be used to update an existing oauth app. Using this API, you can update app name, description and type.

Request

{  
   "Name":"Sample OAuth App",
   "Description":"Sample OAuth App Description",
   "ApplicationTypeId":1
}
HTTP Method Resource URI
PUT https://{tenantName}.api.xomni.com/management/oauth/apps/{applicationId}

URI Parameters

Parameter Name Description Type Conditions
applicationId The unique ID of the OAuth app. Integer
Required.

Request Body Description

Parameter Name Description Type Conditions
Name The name of the oauth app. String
Required: Yes
Description The description of the oauth app. String
Max Length: 500
ApplicationTypeId The application type id enumeration of the oauth app. Number
Required: Yes

Possible values for application types

Value Description
1 Consumer
2 Consumer
3 Consumer
4 Consumer

Request Headers

Header Field Name Description
Authorization
Access or identity token taken from oauth APIs.
Sample: Bearer dc8f1dcdbe454da8a25621839a93569337522968019e4bd7becd6e01285444da

Response

{  
   "ApplicationId":"05cdd8b9-06f3-4ff8-8a20-2f6ca3442c7a",
   "ApplicationSecret":"05cdd8b9-06f3-4ff8-8a20-2f6ca3442c7a05cdd8b9-06f3-4ff8-8a20-2f6ca3442c7a",
   "Name":"Sample OAuth App",
   "Description":"Sample OAuth App Description",
   "IsPredefined":false,
   "ApplicationTypeId":1,
   "ApplicationTypeDescription":"Consumer"
}

Response Body Description

Parameter Name Description Type
ApplicationId The unique application identity of the oauth app. String
ApplicationSecret The unique application secret key of the oauth app. String
Name The name of the oauth app. String
Description The description of the oauth app. String
IsPredefined Boolean field indicating if oauth app is predefined or not. Unknown
ApplicationTypeId The application type id enumeration of the oauth app. Number
ApplicationTypeDescription The application type description of the oauth app. String

Response Headers

Header Field Name Description
Content-Type
Content type of the response entity. The value of this header is always application/json.

Status Codes

A successful operation returns status code 200 (OK) for PUT operations. Possible response status codes are as listed below:

Status Code Description
400 (Bad Request) The given oauth app type id is not valid.
403 (Forbidden) The given oauth app is predefined.
404 (Not Found) The given oauth app id not found.
409 (Conflict) The given oauth app name already exists.