Client Apps
Get Client Apps with access to a Project
GET /projects/:projectId/clients
Response
{
"meta": {
"status": 200
},
"payload": [
{
"client_id": "c4691229-0cc0-443d-829c-619ec4a66a81",
"name": "Android App",
"secret": "FelhYFqyKWT8Pn6OD6RfVdxxlz1eBTsPdLyl1lyYq0A=",
"project_id": "8fae6705-e50d-4211-a445-e245d1a3f30a"
},
{
"client_id": "0b5a26a2-9ac7-41e7-bb9f-970a9299ae53",
"name": "iOS App",
"secret": "A7WLTp3Y3cbD__YfjC2UHRtEGeYEYsttE_jAqhAre24=",
"project_id": "8fae6705-e50d-4211-a445-e245d1a3f30a"
},
{
"client_id": "4ae06c35-e947-4905-8ea9-138bde3335e8",
"name": "Auto Export System",
"secret": "rraX4RXGw50Y9phNS5uu0GkIcC1Ijm1v6ve-h7Rq828=",
"project_id": "8fae6705-e50d-4211-a445-e245d1a3f30a"
}
]
}
Register a new Client App for a Project
POST /projects/:projectId/clients
Parameters (JSON)
| Name | Type | Description |
|---|---|---|
| name | string | The client application's name. |
Example
{
"name": "Android App",
}
Response
{
"meta": {
"status": 201
},
"payload": {
"client_id": "c4691229-0cc0-443d-829c-619ec4a66a81",
"name": "Android App",
"secret": "FelhYFqyKWT8Pn6OD6RfVdxxlz1eBTsPdLyl1lyYq0A=",
"project_id": "8fae6705-e50d-4211-a445-e245d1a3f30a"
}
}
Updating a Client App's name
PATCH /projects/:projectId/clients/:clientId/name
Parameters (JSON)
| Name | Type | Description |
|---|---|---|
| name | string | The new client application's name. |
Example
{
"name": "My New Client App Name",
}
Response
{
"meta": {
"status": 200
},
"payload": {
"client_id": "c4691229-0cc0-443d-829c-619ec4a66a81",
"name": "My New Client App Name",
"secret": "FelhYFqyKWT8Pn6OD6RfVdxxlz1eBTsPdLyl1lyYq0A=",
"project_id": "8fae6705-e50d-4211-a445-e245d1a3f30a"
}
}
Resetting a Client App's secret
PATCH /projects/:projectId/clients/:clientId/resetSecret
Parameters (JSON)
| Name | Type | Description |
|---|---|---|
| clientId | string | The client application's id. |
| projectId | string | The projectId for the project that owns the client application. |
Example
{
"clientId": "c4691229-0cc0-443d-829c-619ec4a66a81",
"projectId": "8fae6705-e50d-4211-a445-e245d1a3f30a"
}
Response
{
"meta": {
"status": 200
},
"payload": {
"client_id": "c4691229-0cc0-443d-829c-619ec4a66a81",
"name": "Android App",
"secret": "CddivZ0BqwJjpx5CPt1qijkEFskjHB7u3V7RnW02Eyo=",
"project_id": "8fae6705-e50d-4211-a445-e245d1a3f30a"
}
}
Deleting a Client App
DELETE /projects/:projectId/clients/:clientId
Response
Note: delete actions do not return body content. They are acknowledged by a HTTP Status Code of 204
// HTTP Status 204 No Content