アプリケーションAPI

GitLab 10.5 で導入されました。

Applications API は、インスタンス全体の OAuth アプリケーションをオペレーションします：

Applications API は、グループアプリケーションや個々のユーザーのアプリケーションを管理するために使用することはできません。

note
アプリケーションAPIを使用できるのは、管理者ユーザーのみです。

アプリケーションの作成

JSONペイロードを投稿してアプリケーションを作成します。

リクエストに成功した場合は200 を返します。

POST /applications

パラメータを指定します：

属性種類必須説明
name文字列です。yesアプリケーションの名前
redirect_uri文字列です。yesアプリケーションのリダイレクトURI。
scopes文字列です。yesアプリケーションのスコープ。スペースで区切って複数のスコープを指定できます。
confidentialbooleanいいえアプリケーションは、クライアントの秘密を守れる場所で使用されます。ネイティブモバイルアプリとシングルページアプリは機密性がないとみなされます。デフォルトはtrue です。

リクエストの例

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
     --data "name=MyApplication&redirect_uri=http://redirect.uri&scopes=api read_user email" \
     "https://gitlab.example.com/api/v4/applications"

応答例

{
    "id":1,
    "application_id": "5832fc6e14300a0d962240a8144466eef4ee93ef0d218477e55f11cf12fc3737",
    "application_name": "MyApplication",
    "secret": "ee1dd64b6adc89cf7e2c23099301ccc2c61b441064e9324d963c46902a85ec34",
    "callback_url": "http://redirect.uri",
    "confidential": true
}

すべてのアプリケーションのリスト

登録されているすべてのアプリケーションを一覧表示します。

GET /applications

リクエストの例

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/applications"

応答例

[
    {
        "id":1,
        "application_id": "5832fc6e14300a0d962240a8144466eef4ee93ef0d218477e55f11cf12fc3737",
        "application_name": "MyApplication",
        "callback_url": "http://redirect.uri",
        "confidential": true
    }
]
note
secret の値は、この API では公開していません。

アプリケーションの削除

特定のアプリケーションを削除します。

リクエストに成功した場合は204 を返します。

DELETE /applications/:id

パラメータを指定します：

属性種類必須説明
id整数。yesアプリケーションの ID (application_id ではありません)。

リクエストの例

curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/applications/:id"