Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEvan Read <eread@gitlab.com>2019-01-11 18:38:15 +0300
committerAchilleas Pipinellis <axil@gitlab.com>2019-01-11 18:38:15 +0300
commit0661826bad6832fb7657307f075df6b19c5afc9a (patch)
tree4a7ea709238544a224131446b114c7a9e65fbe31 /doc/api/applications.md
parent485974973e45aead6eeff0c86395da8ae2af8d06 (diff)
Add more information and refactor format of topic
Diffstat (limited to 'doc/api/applications.md')
-rw-r--r--doc/api/applications.md47
1 files changed, 30 insertions, 17 deletions
diff --git a/doc/api/applications.md b/doc/api/applications.md
index 7f95c136168..82955f0c1db 100644
--- a/doc/api/applications.md
+++ b/doc/api/applications.md
@@ -1,28 +1,36 @@
# Applications API
-> [Introduced][ce-8160] in GitLab 10.5
+> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/8160) in GitLab 10.5.
-[ce-8160]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/8160
+Applications API operates on OAuth applications for:
-Only admin user can use the Applications API.
+- [Using GitLab as an authentication provider](../integration/oauth_provider.md).
+- [Allowing access to GitLab resources on a user's behalf](oauth2.md).
-## Create a application
+NOTE: **Note:**
+Only admin users can use the Applications API.
-Create a application by posting a JSON payload.
+## Create an application
+
+Create an application by posting a JSON payload.
Returns `200` if the request succeeds.
-```
+```text
POST /applications
```
-| Attribute | Type | Required | Description |
-| --------- | ---- | -------- | ----------- |
-| `name` | string | yes | The name of the application |
-| `redirect_uri` | string | yes | The redirect URI of the application |
-| `scopes` | string | yes | The scopes of the application |
+Parameters:
+
+| Attribute | Type | Required | Description |
+|:---------------|:-------|:---------|:---------------------------------|
+| `name` | string | yes | Name of the application. |
+| `redirect_uri` | string | yes | Redirect URI of the application. |
+| `scopes` | string | yes | Scopes of the application. |
+
+Example request:
-```bash
+```sh
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --data "name=MyApplication&redirect_uri=http://redirect.uri&scopes=" https://gitlab.example.com/api/v4/applications
```
@@ -42,11 +50,13 @@ Example response:
List all registered applications.
-```
+```text
GET /applications
```
-```bash
+Example request:
+
+```sh
curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/applications
```
@@ -63,7 +73,8 @@ Example response:
]
```
-> Note: the `secret` value will not be exposed by this API.
+NOTE: **Note:**
+The `secret` value will not be exposed by this API.
## Delete an application
@@ -71,7 +82,7 @@ Delete a specific application.
Returns `204` if the request succeeds.
-```
+```text
DELETE /applications/:id
```
@@ -79,6 +90,8 @@ Parameters:
- `id` (required) - The id of the application (not the application_id)
-```bash
+Example request:
+
+```sh
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/applications/:id
```