2020-10-26 17:08:22 -04:00
---
2021-04-23 11:09:37 -04:00
stage: Manage
2022-01-26 22:14:06 -05:00
group: Authentication and Authorization
2022-09-21 17:13:33 -04:00
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments
2020-10-26 17:08:22 -04:00
---
2021-09-07 14:10:39 -04:00
# Applications API **(FREE)**
2017-01-04 17:07:49 -05:00
2020-02-06 10:09:11 -05:00
> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8160) in GitLab 10.5.
2018-01-23 04:50:10 -05:00
2021-03-16 14:11:53 -04:00
The Applications API operates on instance-wide OAuth applications for:
2018-01-23 04:50:10 -05:00
2019-01-11 10:38:15 -05:00
- [Using GitLab as an authentication provider ](../integration/oauth_provider.md ).
- [Allowing access to GitLab resources on a user's behalf ](oauth2.md ).
2018-10-11 06:54:15 -04:00
2021-03-16 14:11:53 -04:00
The Applications API cannot be used to manage group applications or applications of individual users.
2020-12-04 16:09:29 -05:00
NOTE:
2021-02-15 19:09:01 -05:00
Only administrator users can use the Applications API.
2017-01-04 17:07:49 -05:00
2019-01-11 10:38:15 -05:00
## Create an application
Create an application by posting a JSON payload.
2017-01-04 17:07:49 -05:00
Returns `200` if the request succeeds.
2020-05-19 23:08:04 -04:00
```plaintext
2017-01-04 17:07:49 -05:00
POST /applications
```
2019-01-11 10:38:15 -05:00
Parameters:
2020-01-22 13:08:47 -05:00
| Attribute | Type | Required | Description |
|:---------------|:--------|:---------|:---------------------------------|
| `name` | string | yes | Name of the application. |
| `redirect_uri` | string | yes | Redirect URI of the application. |
2021-09-30 05:12:38 -04:00
| `scopes` | string | yes | Scopes of the application. You can specify multiple scopes by separating each scope using a space. |
2020-12-16 10:10:18 -05:00
| `confidential` | boolean | no | The application is 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-01-11 10:38:15 -05:00
Example request:
2017-01-04 17:07:49 -05:00
2020-01-30 10:09:15 -05:00
```shell
2021-06-02 11:09:59 -04:00
curl --request POST --header "PRIVATE-TOKEN: < your_access_token > " \
2021-09-30 05:12:38 -04:00
--data "name=MyApplication& redirect_uri=http://redirect.uri& scopes=api read_user email" \
2021-06-02 11:09:59 -04:00
"https://gitlab.example.com/api/v4/applications"
2017-01-04 17:07:49 -05:00
```
Example response:
```json
2018-01-23 04:50:10 -05:00
{
2018-10-11 06:54:15 -04:00
"id":1,
2017-01-04 17:07:49 -05:00
"application_id": "5832fc6e14300a0d962240a8144466eef4ee93ef0d218477e55f11cf12fc3737",
2018-10-11 06:54:15 -04:00
"application_name": "MyApplication",
2017-01-04 17:07:49 -05:00
"secret": "ee1dd64b6adc89cf7e2c23099301ccc2c61b441064e9324d963c46902a85ec34",
2020-01-22 13:08:47 -05:00
"callback_url": "http://redirect.uri",
"confidential": true
2017-01-04 17:07:49 -05:00
}
```
2018-10-11 06:54:15 -04:00
## List all applications
List all registered applications.
2020-05-19 23:08:04 -04:00
```plaintext
2018-10-11 06:54:15 -04:00
GET /applications
```
2019-01-11 10:38:15 -05:00
Example request:
2020-01-30 10:09:15 -05:00
```shell
2020-05-27 20:08:37 -04:00
curl --header "PRIVATE-TOKEN: < your_access_token > " "https://gitlab.example.com/api/v4/applications"
2018-10-11 06:54:15 -04:00
```
Example response:
```json
[
{
"id":1,
"application_id": "5832fc6e14300a0d962240a8144466eef4ee93ef0d218477e55f11cf12fc3737",
"application_name": "MyApplication",
2020-01-22 13:08:47 -05:00
"callback_url": "http://redirect.uri",
"confidential": true
2018-10-11 06:54:15 -04:00
}
]
```
2020-12-04 16:09:29 -05:00
NOTE:
2020-12-16 10:10:18 -05:00
The `secret` value is not exposed by this API.
2018-10-11 06:54:15 -04:00
## Delete an application
Delete a specific application.
Returns `204` if the request succeeds.
2020-05-19 23:08:04 -04:00
```plaintext
2018-10-11 06:54:15 -04:00
DELETE /applications/:id
```
Parameters:
2019-09-01 19:55:51 -04:00
| Attribute | Type | Required | Description |
|:----------|:--------|:---------|:----------------------------------------------------|
2020-05-07 02:09:38 -04:00
| `id` | integer | yes | The ID of the application (not the application_id). |
2018-10-11 06:54:15 -04:00
2019-01-11 10:38:15 -05:00
Example request:
2020-01-30 10:09:15 -05:00
```shell
2020-05-27 20:08:37 -04:00
curl --request DELETE --header "PRIVATE-TOKEN: < your_access_token > " "https://gitlab.example.com/api/v4/applications/:id"
2018-10-11 06:54:15 -04:00
```