documentation/content/en/api/rest/apps.md

39 lines
1.0 KiB
Markdown
Raw Normal View History

2018-09-26 00:19:54 +02:00
---
title: Apps
2018-09-26 00:19:54 +02:00
menu:
docs:
parent: rest-api
2018-09-26 00:19:54 +02:00
weight: 10
---
2018-10-05 01:24:26 +02:00
## POST /api/v1/apps
2018-10-05 01:37:50 +02:00
Create a new application to obtain OAuth2 credentials.
2018-10-05 01:24:26 +02:00
Returns [App]({{< relref "entities.md#app" >}}) with `client_id` and `client_secret`
### Resource information
{{< api_method_info auth="No" user="No" version="0.0.0" >}}
### Parameters
2018-10-06 00:42:15 +02:00
|Name|Description|Required|
|----|-----------|:------:|
| `client_name` | Name of your application | Required |
| `redirect_uris` | Where the user should be redirected after authorization | Required |
| `scopes` | Space separated list of [scopes]({{< relref "permissions.md" >}}) | Required |
| `website` | URL to the homepage of your app | Optional |
> To display the authorization code to the end-user instead of redirecting to a web page, use `urn:ietf:wg:oauth:2.0:oob` in `redirect_uris`
2018-10-06 01:09:03 +02:00
## GET /api/v1/apps/verify_credentials
Confirm that the app's OAuth2 credentials work.
Returns [App]({{< relref "entities.md#app" >}})
### Resource information
{{< api_method_info auth="Yes" user="No" version="2.0.0" >}}