앱
앱은 외부 서비스 또는 시스템과 SpaceONE을 연동하는 데 사용됩니다.
사용자는 API 인증을 위한 Client ID 및 Client Secret을 발급받아, 특정 권한을 가진 앱을 생성할 수 있습니다.
이를 통해 클라우드 리소스를 관리하거나, SpaceONE의 다양한 기능을 자동화할 수 있습니다.
앱 생성하기
앱 생성 모달 열기
앱 페이지에서 우측 상단의 [생성] 버튼을 클릭합니다.
앱 정보 입력
앱 정보를 입력합니다.
- 이름
- 프로젝트 할당: 앱을 특정 프로젝트에 속하도록 설정할지 여부를 선택합니다. 활성화하면 프로젝트를 지정할 수 있습니다.
- 워크스페이스 역할(Role): 앱이 속한 워크스페이스에서 가질 역할을 선택합니다. (e.g.,
Workspace Owner) - 태그 (선택사항): 앱을 쉽게 관리하기 위해 추가하는 메타데이터입니다.
Client ID & Client Secret 발급받기
앱이 생성되면, Client Secret이 발급되며, 이는 API/CLI 환경에서 앱을 인증하고 관리하는 데 사용됩니다.
⚠️
Client Secret은 한 번만 제공되므로 즉시 다운로드해야 합니다. 이후에는 복구할 수 없으므로 안전하게 보관해야 합니다.
Client ID
- 앱을 식별하는 고유한 값으로, SpaceONE API를 사용할 때 인증을 위해 필요합니다.
- JSON 형식으로 제공되며,
app_id,client_secret,role_type,workspace_id등의 정보가 포함됩니다.
SpaceONE CLI (spacectl)
- SpaceONE의 CLI 툴인 spacectl을 사용하여 리소스를 관리할 수 있도록 설정하는 파일입니다.
token값이 포함되어 있으며, 이를 사용하여 API 요청을 인증할 수 있습니다.- endpoints 정보도 포함되어 있어, SpaceONE의 gRPC API에 연결할 수 있습니다.
Client Secret 재발급
특정 앱의 Client Secret을 재발급하려면, 목록에서 해당 앱을 선택 후, 작업 드롭다운에서 [Client Secret 재생성] 버튼을 클릭합니다.
앱 활성화 및 비활성화 하기
목록에서 해당 앱을 선택 후, 작업 드롭다운에서 [활성화] 또는 [비활성화] 버튼을 클릭합니다.
앱 수정 및 삭제하기
목록에서 해당 앱을 선택 후, 작업 드롭다운에서 [수정] 또는 [삭제] 버튼을 클릭합니다.
REST API와 gRPC 정보 확인하기
앱 페이지 하단에서는 해당 앱과 관련된 API 엔드포인트 정보를 확인할 수 있습니다.
REST 및 gRPC 두 가지 방식으로 API 요청이 가능합니다.
REST API
사용 가능한 SpaceONE의 REST API 엔드포인트를 확인할 수 있습니다.
제공되는 엔드포인트는 Swagger UI 링크로, 클릭하면 API 문서를 확인하고 테스트할 수 있습니다.
gRPC
각 서비스별 엔드포인트와 이름이 표로 제공되며, 필요한 서비스의 gRPC 주소를 확인할 수 있습니다.
