토큰 정보 API
Offering: GitLab Self-Managed
이 API를 사용하여 임의의 토큰에 대한 세부 정보를 검색하고 취소합니다. 요청 시 personal, project 또는 group access 토큰은 glpat 또는 현재 커스텀 접두사로 시작해야 합니다. 지정된 토큰에 대한 정보를 검색합니다.
이 API를 사용하여 임의의 토큰에 대한 세부 정보를 검색하고 취소합니다. 토큰 정보를 노출하는 다른 API와 달리, 이 API는 특정 토큰 유형을 알지 않고도 토큰 세부 정보를 검색하거나 취소할 수 있습니다.
토큰 접두사#
요청 시 personal, project 또는 group access 토큰은 glpat 또는 현재 커스텀 접두사로 시작해야 합니다. 토큰이 이전 커스텀 접두사로 시작하면 작업이 실패합니다. 이전 커스텀 접두사 지원에 대한 관심은 이슈 165663에서 추적됩니다.
사전 요구 사항:
- 인스턴스에 대한 관리자 액세스 권한이 있어야 합니다.
토큰 정보 조회#
히스토리
- GitLab 17.5에서
admin_agnostic_token_finder라는 플래그와 함께 도입되었습니다. 기본적으로 비활성화됩니다. - GitLab 17.8에서 일반 사용 가능하게 되었습니다. 기능 플래그
admin_agnostic_token_finder가 제거되었습니다. - GitLab 17.6에서 피드 토큰이 추가되었습니다.
- GitLab 17.7에서 OAuth 애플리케이션 시크릿이 추가되었습니다.
- GitLab 17.7에서 클러스터 에이전트 토큰이 추가되었습니다.
- GitLab 17.7에서 러너 인증 토큰이 추가되었습니다.
- GitLab 17.7에서 파이프라인 트리거 토큰이 추가되었습니다.
- GitLab 17.9에서 CI/CD 작업 토큰이 추가되었습니다.
- GitLab 17.9에서 기능 플래그 클라이언트 토큰이 추가되었습니다.
- GitLab 17.9에서 GitLab 세션 쿠키가 추가되었습니다.
- GitLab 17.9에서 수신 이메일 토큰이 추가되었습니다.
지정된 토큰에 대한 정보를 검색합니다. 이 엔드포인트는 다음 토큰을 지원합니다:
- 개인 액세스 토큰
- 가장 토큰
- 배포 토큰
- 피드 토큰
- OAuth 애플리케이션 시크릿
- 클러스터 에이전트 토큰
- 러너 인증 토큰
- 파이프라인 트리거 토큰
- CI/CD 작업 토큰
- 기능 플래그 클라이언트 토큰
- GitLab 세션 쿠키
- 수신 이메일 토큰
POST /api/v4/admin/token
지원되는 속성:
| 속성 | 유형 | 필수 여부 | 설명 |
|---|---|---|---|
token |
문자열 | 예 | 식별할 기존 토큰. Personal, project 또는 group access 토큰은 glpat 또는 현재 커스텀 접두사로 시작해야 합니다. |
성공하면 200과 토큰에 대한 정보를 반환합니다.
다음 상태 코드를 반환할 수 있습니다:
200 OK: 토큰에 대한 정보.401 Unauthorized: 사용자가 승인되지 않음.403 Forbidden: 사용자가 관리자가 아님.404 Not Found: 토큰을 찾을 수 없음.422 Unprocessable: 토큰 유형이 지원되지 않음.
요청 예시:
curl --request POST \
--url "https://gitlab.example.com/api/v4/admin/token" \
--header "PRIVATE-TOKEN: <your_access_token>" \
--header 'Content-Type: application/json' \
--data '{"token": "glpat-<example-token>"}'
응답 예시:
{
"id": 1,
"user_id": 70,
"name": "project-access-token",
"revoked": false,
"expires_at": "2024-10-04",
"created_at": "2024-09-04T07:19:18.652Z",
"updated_at": "2024-09-04T07:19:18.652Z",
"scopes": [
"api",
"read_api"
],
"impersonation": false,
"expire_notification_delivered": false,
"last_used_at": null,
"after_expiry_notification_delivered": false,
"previous_personal_access_token_id": null,
"advanced_scopes": null,
"organization_id": 1
}
토큰 취소#
히스토리
- GitLab 17.9에서 클러스터 에이전트 토큰이 추가되었습니다.
- GitLab 17.9에서 러너 인증 토큰이 추가되었습니다.
- GitLab 17.9에서 OAuth 애플리케이션 시크릿이 추가되었습니다.
- GitLab 17.9에서 수신 이메일 토큰이 추가되었습니다.
- GitLab 17.9에서 기능 플래그 클라이언트 토큰이 추가되었습니다.
- GitLab 17.10에서
token_api_expire_pipeline_triggers라는 플래그와 함께 파이프라인 트리거 토큰이 추가되었습니다. 기본적으로 비활성화됩니다. - GitLab 17.11에서 GitLab 세션이 추가되었습니다.
이 기능의 사용 가능 여부는 기능 플래그로 제어됩니다. 자세한 내용은 기록을 참조하세요. 이 기능은 테스트용으로 사용 가능하지만 프로덕션 사용 준비가 되지 않았습니다.
토큰 유형에 따라 지정된 토큰을 취소, 재설정 또는 삭제합니다. 이 엔드포인트는 다음 토큰 유형을 지원합니다:
| 토큰 유형 | 지원되는 작업 |
|---|---|
| 개인 액세스 토큰 | 취소 |
| 가장 토큰 | 취소 |
| 프로젝트 액세스 토큰 | 취소 |
| 그룹 액세스 토큰 | 취소 |
| 배포 토큰 | 취소 |
| 클러스터 에이전트 토큰 | 취소 |
| 파이프라인 트리거 토큰 | 취소 |
| 피드 토큰 | 재설정 |
| 러너 인증 토큰 | 재설정 |
| OAuth 애플리케이션 시크릿 | 재설정 |
| 수신 이메일 토큰 | 재설정 |
| 기능 플래그 클라이언트 토큰 | 재설정 |
| GitLab 세션 쿠키 | 삭제 |
DELETE /api/v4/admin/token
지원되는 속성:
| 속성 | 유형 | 필수 여부 | 설명 |
|---|---|---|---|
token |
문자열 | 예 | 취소할 기존 토큰. Personal, project 또는 group access 토큰은 glpat 또는 현재 커스텀 접두사로 시작해야 합니다. |
성공하면 내용 없이 204를 반환합니다.
다음 상태 코드를 반환할 수 있습니다:
204 No content: 토큰이 취소되었습니다.401 Unauthorized: 사용자가 승인되지 않음.403 Forbidden: 사용자가 관리자가 아님.404 Not Found: 토큰을 찾을 수 없음.422 Unprocessable: 토큰 유형이 지원되지 않음.
요청 예시:
curl --request DELETE \
--url "https://gitlab.example.com/api/v4/admin/token" \
--header "PRIVATE-TOKEN: <your_access_token>" \
--header 'Content-Type: application/json' \
--data '{"token": "glpat-<example-token>"}'
