Applications API
Tier: Free, Premium, Ultimate
Offering: GitLab.com, Self-managed, GitLab Dedicated
Applications API는 인스턴스 전체의 OAuth 애플리케이션에 작용합니다.
Applications API를 사용하여 그룹 애플리케이션 또는 개별 사용자의 애플리케이션을 관리할 수 없습니다.
참고: 관리자 사용자만 Applications API를 사용할 수 있습니다.
애플리케이션 생성
JSON 페이로드를 게시하여 애플리케이션을 생성하세요.
요청이 성공하면 200
을 반환합니다.
POST /applications
지원되는 속성:
속성 | 유형 | 필수 | 설명 |
---|---|---|---|
name
| string | 예 | 애플리케이션 이름. |
redirect_uri
| string | 예 | 애플리케이션의 리디렉션 URI. |
scopes
| string | 예 | 애플리케이션의 범위. 각 범위를 공백으로 구분하여 여러 범위를 지정할 수 있습니다. |
confidential
| boolean | 아니오 | 클라이언트 비밀을 비밀로 유지해야 하는 애플리케이션 사용 여부. 네이티브 모바일 앱 및 단일 페이지 앱은 비비밀로 간주됩니다. 제공되지 않으면 기본적으로 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
}
]
참고:
이 API에서 secret
값을 노출하지 않습니다.
애플리케이션 삭제
특정 애플리케이션을 삭제합니다.
요청이 성공하면 204
를 반환합니다.
DELETE /applications/:id
지원되는 속성:
속성 | 유형 | 필수 | 설명 |
---|---|---|---|
id
| integer | 예 | 애플리케이션 ID(application_id 가 아님).
|
예제 요청:
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/applications/:id"
애플리케이션 시크릿 갱신
- GitLab 16.11에서 도입되었습니다.
애플리케이션 시크릿을 갱신합니다. 요청이 성공하면 200
을 반환합니다.
POST /applications/:id/renew-secret
지원되는 속성:
속성 | 유형 | 필수 | 설명 |
---|---|---|---|
id
| integer | 예 | 애플리케이션 ID(application_id 가 아님).
|
예제 요청:
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/applications/:id/renew-secret"
예제 응답:
{
"id":1,
"application_id": "5832fc6e14300a0d962240a8144466eef4ee93ef0d218477e55f11cf12fc3737",
"application_name": "MyApplication",
"secret": "ee1dd64b6adc89cf7e2c23099301ccc2c61b441064e9324d963c46902a85ec34",
"callback_url": "http://redirect.uri",
"confidential": true
}