Activate a API Consumer

Activates a API consumer based on the parameter.

Request
PUT
http://<webexsocial-server>/api/quad/rest/management/apiconsumers/{consumer-id}

Authentication Required, use Basic HTTP Authentication with Quad admin user credentials

Supported since version 2.5

Example Request and Response
Request Response 
PUT /api/quad/rest/management/apiconsumers/3810916 HTTP/1.1
Host: localhost
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:10.0.3) Gecko/20120314 Firefox/10.0.3
Accept: application/json
Accept-Encoding: gzip, deflate
Content-Type: application/json; charset=UTF-8
Authorization: Basic dGVzdEBjaXNjby5jb206Y2lzY28=
Content-Length: 21
Cookie: JSESSIONID=AEC88381AF608A76E33A7FA489377DB3.localhost.cisco.comjvm; 
JSESSIONID=6BBBF7BCD70A0581B55F7A99AEA131C3.localhost.cisco.comjvm; GUEST_LANGUAGE_ID=en_US; COOKIE_SUPPORT=true

{
"state": "active"
}

            
HTTP/1.1 204 No Content
Date: Wed, 11 Apr 2012 19:11:03 GMT
Server: Apache
Content-Length: 0
Content-Type: application/json;charset=UTF-8

Deactivate a API Consumer

Deactivate a API consumer based on the parameter. If an api consumer is deactivated, all tokens for that consumer will also be deactivated.

Request
PUT
http://<webexsocial-server>/api/quad/rest/management/apiconsumers/{consumer-id}

Authentication Required, use Basic HTTP Authentication with Quad admin user credentials

Supported since version 2.5

Example Request and Response
Request Response 
PUT /api/quad/rest/management/apiconsumers/3810916 HTTP/1.1
Host: localhost
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:10.0.3) Gecko/20120314 Firefox/10.0.3
Accept: application/json
Accept-Encoding: gzip, deflate
Content-Type: application/json; charset=UTF-8
Authorization: Basic dGVzdEBjaXNjby5jb206Y2lzY28=
Content-Length: 23
Cookie: JSESSIONID=AEC88381AF608A76E33A7FA489377DB3.localhost.cisco.comjvm; 
JSESSIONID=6BBBF7BCD70A0581B55F7A99AEA131C3.localhost.cisco.comjvm; GUEST_LANGUAGE_ID=en_US; COOKIE_SUPPORT=true

{
"state": "deactive"
}


            
HTTP/1.1 204 No Content
Date: Wed, 11 Apr 2012 19:09:47 GMT
Server: Apache
Content-Length: 0
Content-Type: application/json;charset=UTF-8

Get all API consumers

Returns all of the API consumers.

Request
GET
http://<webexsocial-server>/api/quad/rest/management/apiconsumers/@all

Authentication Required, use Basic HTTP Authentication with Quad admin user credentials

Supported since version 2.5

Example Request and Response
Request Response 
GET /api/quad/rest/management/apiconsumers/@all HTTP/1.1
Host: localhost
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:10.0.3) Gecko/20120314 Firefox/10.0.3
Accept: application/json
Accept-Encoding: gzip, deflate
Authorization: Basic dGVzdEBjaXNjby5jb206Y2lzY28=
Cookie: JSESSIONID=AEC88381AF608A76E33A7FA489377DB3.localhost.cisco.comjvm; 
JSESSIONID=6BBBF7BCD70A0581B55F7A99AEA131C3.localhost.cisco.comjvm; GUEST_LANGUAGE_ID=en_US; COOKIE_SUPPORT=true


            
HTTP/1.1 200 OK
Date: Wed, 11 Apr 2012 18:36:35 GMT
Server: Apache
Content-Encoding: gzip
Content-Length: 1068
Content-Type: application/json;charset=UTF-8

{
	"statusCode":200,
	"startIndex":0,
	"itemsPerPage":9,
	"totalResults":9,
	"filtered":false,
	"sorted":false,
	"entry":
		[
			{
				"data":
					{
						"accessPermission":"",
						"author":"10257",
						"callbackUrl":"",
						"consumerKey":"e2db636b06375eb99219ac8b962a4e95970511ef",
						"consumerSecret":"c50e4e93f32f81588bcb20d13a9a14aa1192ea4b",
						"createDate":1334086132112,
						"description":"My Second Sample App",
						"id":3810916,
						"modifiedDate":1334086132112,
						"name":"My Second Sample App",
						"resource":"http://quad.cisco.com/schema/1.0/apiconsumer",
						"state":"active",
						"type":null
					}
			},
			{
				"data":
					{
						"accessPermission":"",
						"author":"10257",
						"callbackUrl":"",
						"consumerKey":"5a4a28a53fed48750bef69fc8536bbbcc66c8570",
						"consumerSecret":"18af58fb332183b42311e3b1bdd7c5a7c18863b0",
						"createDate":1334081215449,
						"description":"",
						"id":3810911,
						"modifiedDate":1334081215449,
						"name":"Crazy App",
						"resource":"http://quad.cisco.com/schema/1.0/apiconsumer",
						"state":"active","type":null
					}
			},
			{
				"data":
					{
						"accessPermission":"",
						"author":"10257",
						"callbackUrl":"",
						"consumerKey":"c35ed9e1e837fd6a1d264acbce79e57c9a004b1e",
						"consumerSecret":"b9d5fa2d793a9f2a6d38706465d34669e72ab6ab",
						"createDate":1334075723283,
						"description":"My app3",
						"id":3810907,
						"modifiedDate":1334075723283,
						"name":"My app3",
						"resource":"http://quad.cisco.com/schema/1.0/apiconsumer",
						"state":"active","type":null
					}
			},
			{
				"data":
					{
						"accessPermission":"",
						"author":"10257",
						"callbackUrl":"",
						"consumerKey":"12535437fecf5dc682d7f498dda39c704af40694",
						"consumerSecret":"cf970166f4edf6590f306894bcdd3311f097c623",
						"createDate":1334070691600,
						"description":"Sample App2",
						"id":3810902,
						"modifiedDate":1334070691600,
						"name":"Sample App2",
						"resource":"http://quad.cisco.com/schema/1.0/apiconsumer",
						"state":"active",
						"type":null
					}
			},
			{
				"data":
					{
						"accessPermission":""
						,"author":"10257",
						"callbackUrl":"",
						"consumerKey":"d5c1b202fb8cdf87de0c8e3b19bcc194edf34107",
						"consumerSecret":"125fadcc9e856e5b89a5bb66802d5373348f21da",
						"createDate":1334004751417,
						"description":"My Sample App",
						"id":3810897,
						"modifiedDate":1334004751417,
						"name":"Brads App",
						"resource":"http://quad.cisco.com/schema/1.0/apiconsumer",
						"state":"active",
						"type":null
					}
			},
			{
				"data":
					{
						"accessPermission":"",
						"author":"10257",
						"callbackUrl":"",
						"consumerKey":"b6bf32449ea52b03c57f6c78b9960f20daeef25c",
						"consumerSecret":"26bfabcbd50f0bd3d4b85005f41da4c6420a150e",
						"createDate":1334004749955,
						"description":"My Sample App",
						"id":3810896,
						"modifiedDate":1334004749955,
						"name":"Brads App",
						"resource":"http://quad.cisco.com/schema/1.0/apiconsumer",
						"state":"active","type":null
					}
			},
			{
				"data":
					{
						"accessPermission":"",
						"author":"10257",
						"callbackUrl":"http://localhost/quadopen/gadgets/oauthcallback",
						"consumerKey":"73662f41033d0d4f3f003817749c784ab347dc5f",
						"consumerSecret":"4d2fbfdd504b5d89f766e970f164b151e878359a",
						"createDate":1332280816112,
						"description":"Sample Gadget",
						"id":2410010,
						"modifiedDate":1332280816112,
						"name":"sample Gadget",
						"resource":"http://quad.cisco.com/schema/1.0/apiconsumer",
						"state":"active",
						"type":null
					}
			},
			{
				"data":
					{
						"accessPermission":"",
						"author":"10257",
						"callbackUrl":"http://127.0.0.1/quadopen/gadgets/oauthcallback",
						"consumerKey":"0e2d1f62a1020810b86dccbdd11ddfd6bdd4998c",
						"consumerSecret":"2d7d031fd4bc21b9377ce5d1f2229fe21afe64d9",
						"createDate":1332280444104,
						"description":"Sample Gadget",
						"id":2410002,
						"modifiedDate":1332280444104,
						"name":"sample Gadget",
						"resource":"http://quad.cisco.com/schema/1.0/apiconsumer",
						"state":"active","type":null
					}
			},
			{
				"data":
					{
						"accessPermission":"",
						"author":"",
						"callbackUrl":"",
						"consumerKey":"878a3edc03443a3f3ce099ee6a2951347bc1c51e",
						"consumerSecret":"769ec132f3e046e973e7226abe9b2951dc813b5c",
						"createDate":1329300187000,
						"description":"Consumer for Cisco Quad for iPhone",
						"id":1,
						"modifiedDate":1329300187000,
						"name":"Cisco Quad for iPhone",
						"resource":"http://quad.cisco.com/schema/1.0/apiconsumer",
						"state":"active",
						"type":"mobile"
					}
			}
		],
	"serverMessages":null
}

Get a API Consumer

Returns the details for the specified API consumer. You can use the fields query string parameter to limit the response to certain fields. Otherwise, the entire user object will be returned

Request
GET
http://<webexsocial-server>/api/quad/rest/management/apiconsumers/{consumer-id}

Authentication Required, use Basic HTTP Authentication with Quad admin user credentials

Supported since version 2.5

Example Request and Response
Request Response 
GET /api/quad/rest/management/apiconsumers/3810916 HTTP/1.1
Host: localhost
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:10.0.3) Gecko/20120314 Firefox/10.0.3
Accept: application/json
Accept-Encoding: gzip, deflate
Authorization: Basic dGVzdEBjaXNjby5jb206Y2lzY28=
Cookie: JSESSIONID=AEC88381AF608A76E33A7FA489377DB3.localhost.cisco.comjvm; 
JSESSIONID=6BBBF7BCD70A0581B55F7A99AEA131C3.localhost.cisco.comjvm; GUEST_LANGUAGE_ID=en_US; COOKIE_SUPPORT=true


HTTP/1.1 200 OK
Date: Wed, 11 Apr 2012 18:41:57 GMT
Server: Apache
Content-Encoding: gzip
Content-Length: 367
Content-Type: application/json;charset=UTF-8

{
	"statusCode":200,
	"startIndex":0,
	"itemsPerPage":1,
	"totalResults":0,
	"filtered":false,
	"sorted":false,
	"entry":
		[
			{
				"data":
					{
						"accessPermission":"",
						"author":"10257",
						"callbackUrl":"",
						"consumerKey":"e2db636b06375eb99219ac8b962a4e95970511ef",
						"consumerSecret":"c50e4e93f32f81588bcb20d13a9a14aa1192ea4b",
						"createDate":1334086132112,
						"description":"My Second Sample App",
						"id":3810916,
						"modifiedDate":1334086132112,
						"name":"My Second Sample App",
						"resource":"http://quad.cisco.com/schema/1.0/apiconsumer",
						"state":"active",
						"type":null
					}
			}
		],
	"serverMessages":null
}