List Clients
GET /api/1/oauth2/client
Parameters
status : ALL, ACTIVE, INACTIVE
sort : Property name
Security
API_KEY_READ
Returns
{
"success": "true",
"message": "",
"results": 1,
"rows": [
{
"id": "0a00012c-4089-127b-8140-89ce397c0001",
"createdDate": 1376701528444,
"createdBy": {
"id": "0a0f106a-3f7d-1448-813f-7d3e7a130001",
"firstName": "Amy",
"lastName": "Administrator"
},
"modifiedDate": 1377622285034,
"modifiedBy": {
"id": "0a0f106a-3f7d-1448-813f-7d3e7a130001",
"firstName": "Amy",
"lastName": "Administrator"
},
"objectStatus": "INACTIVE",
"clientId": "MC101",
"firstName": "MC1",
"lastName": "101",
"primaryEmailAddress": "mc101@email.com",
"authorities": [
"ROLE_DATA_EVERYONE",
"ROLE_REFERENCE_READ"
],
"accessTokenValiditySeconds": 100001
}
]
}
Lookup Client by UUID
GET /api/1/oauth2/client/<client-uuid>
Security
API_KEY_READ
Returns
{
"id": "0a00012c-4089-127b-8140-89ce397c0001",
"createdDate": 1376701528444,
"createdBy": {
"id": "0a0f106a-3f7d-1448-813f-7d3e7a130001",
"firstName": "Amy",
"lastName": "Administrator"
},
"modifiedDate": 1377622285034,
"modifiedBy": {
"id": "0a0f106a-3f7d-1448-813f-7d3e7a130001",
"firstName": "Amy",
"lastName": "Administrator"
},
"objectStatus": "INACTIVE",
"clientId": "MC101",
"firstName": "MC1",
"lastName": "101",
"primaryEmailAddress": "mc101@email.com",
"authorities": [
"ROLE_DATA_EVERYONE",
"ROLE_REFERENCE_READ"
],
"accessTokenValiditySeconds": 100001
}
Create Client
POST /api/1/oauth2/client
Security
API_KEY_WRITE
Returns
{
"id": "",
"createdDate": null,
"modifiedDate": null,
"clientId": "client-foo",
"firstName": "Client",
"lastName": "Foo",
"primaryEmailAddress": "clientfoo@institution.edu",
"secret": "foo",
"secretChange": true,
"accessTokenValiditySeconds": 3600,
"authorities": [
"ROLE_DATA_EVERYONE",
"ROLE_REFERENCE_READ"
],
"createdBy": {
"id": "",
"firstName": "",
"lastName": ""
},
"modifiedBy": {
"id": "",
"firstName": "",
"lastName": ""
},
"objectStatus": "ACTIVE",
"active": true,
"displayFullName": " "
}
Update Client by UUID
PUT /api/1/oauth2/client/<client-uuid>
Security
API_KEY_WRITE
Returns
{
"id": "0a0f106a-40c0-1fed-8140-c0b390ea0000",
"createdDate": "2013-08-27T09:55:28",
"modifiedDate": "2013-08-27T09:55:28",
"clientId": "client-foo-1",
"firstName": "Client 1",
"lastName": "Foo 1",
"primaryEmailAddress": "clientfoo1@institution.edu",
"secret": "foo1",
"secretChange": true,
"accessTokenValiditySeconds": 3601,
"authorities": [
"ROLE_DATA_EVERYONE",
"ROLE_REFERENCE_READ",
"ROLE_REFERENCE_WRITE"
],
"createdBy": {
"id": "0a0f106a-3f7d-1448-813f-7d3e7a130001",
"firstName": "Amy",
"lastName": "Administrator"
},
"modifiedBy": {
"id": "0a0f106a-3f7d-1448-813f-7d3e7a130001",
"firstName": "Amy",
"lastName": "Administrator"
},
"objectStatus": "ACTIVE",
"active": true,
"displayFullName": "Client Foo"
}