debian-mirror-gitlab/doc/api/applications.md

103 lines
2.8 KiB
Markdown
Raw Normal View History

2018-03-17 18:26:18 +05:30
# Applications API
2020-03-09 13:42:32 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8160) in GitLab 10.5.
2018-03-17 18:26:18 +05:30
2019-03-02 22:35:43 +05:30
Applications API operates on OAuth applications for:
2018-03-17 18:26:18 +05:30
2019-03-02 22:35:43 +05:30
- [Using GitLab as an authentication provider](../integration/oauth_provider.md).
- [Allowing access to GitLab resources on a user's behalf](oauth2.md).
2018-12-13 13:39:08 +05:30
2019-03-02 22:35:43 +05:30
NOTE: **Note:**
Only admin users can use the Applications API.
2018-03-17 18:26:18 +05:30
2019-03-02 22:35:43 +05:30
## Create an application
Create an application by posting a JSON payload.
2018-03-17 18:26:18 +05:30
Returns `200` if the request succeeds.
2019-03-02 22:35:43 +05:30
```text
2018-03-17 18:26:18 +05:30
POST /applications
```
2019-03-02 22:35:43 +05:30
Parameters:
2020-03-09 13:42:32 +05:30
| 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. |
| `confidential` | boolean | no | The application will be used where the client secret can be kept confidential. Native mobile apps and Single Page Apps are considered non-confidential. Defaults to `true` if not supplied |
2019-03-02 22:35:43 +05:30
Example request:
2018-03-17 18:26:18 +05:30
2020-03-09 13:42:32 +05:30
```shell
2019-02-15 15:39:39 +05:30
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
2018-03-17 18:26:18 +05:30
```
Example response:
```json
{
2018-12-13 13:39:08 +05:30
"id":1,
2018-03-17 18:26:18 +05:30
"application_id": "5832fc6e14300a0d962240a8144466eef4ee93ef0d218477e55f11cf12fc3737",
2018-12-13 13:39:08 +05:30
"application_name": "MyApplication",
2018-03-17 18:26:18 +05:30
"secret": "ee1dd64b6adc89cf7e2c23099301ccc2c61b441064e9324d963c46902a85ec34",
2020-03-09 13:42:32 +05:30
"callback_url": "http://redirect.uri",
"confidential": true
2018-03-17 18:26:18 +05:30
}
```
2018-12-13 13:39:08 +05:30
## List all applications
List all registered applications.
2019-03-02 22:35:43 +05:30
```text
2018-12-13 13:39:08 +05:30
GET /applications
```
2019-03-02 22:35:43 +05:30
Example request:
2020-03-09 13:42:32 +05:30
```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/applications
2018-12-13 13:39:08 +05:30
```
Example response:
```json
[
{
"id":1,
"application_id": "5832fc6e14300a0d962240a8144466eef4ee93ef0d218477e55f11cf12fc3737",
"application_name": "MyApplication",
2020-03-09 13:42:32 +05:30
"callback_url": "http://redirect.uri",
"confidential": true
2018-12-13 13:39:08 +05:30
}
]
```
2019-03-02 22:35:43 +05:30
NOTE: **Note:**
The `secret` value will not be exposed by this API.
2018-12-13 13:39:08 +05:30
## Delete an application
Delete a specific application.
Returns `204` if the request succeeds.
2019-03-02 22:35:43 +05:30
```text
2018-12-13 13:39:08 +05:30
DELETE /applications/:id
```
Parameters:
2019-12-04 20:38:33 +05:30
| Attribute | Type | Required | Description |
|:----------|:--------|:---------|:----------------------------------------------------|
| `id` | integer | yes | The id of the application (not the application_id). |
2018-12-13 13:39:08 +05:30
2019-03-02 22:35:43 +05:30
Example request:
2020-03-09 13:42:32 +05:30
```shell
2019-02-15 15:39:39 +05:30
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/applications/:id
2018-12-13 13:39:08 +05:30
```