메인 콘텐츠로 건너뛰기
현재 프로젝트의 설정 값을 응답하는 API입니다.
해당 API는 운영이 도움을 주기 위한 스냅값이므로 서비스 업데이트에 따라서 응답 구조가 사전 공지 없이 변경될 수 있습니다.

인증 헤더

아르고스 API는 x-api-key 헤더의 시크릿 키를 이용해 인증을 수행합니다. 시크릿 키는 대시보드 프로젝트 설정에서 확인할 수 있습니다. API 요청시 다음과 같이 x-api-key 헤더에 API 키를 포함시켜야 합니다:
x-api-key: {yourAPIKey}

요청

Query 파라미터

category
string
특정 카테고리에 해당하는 설정의 현재 값을 확인할 수 있습니다.,로 구분된 문자열을 전달하여 필터링이 가능합니다. 추후 카테고리가 추가될 예정입니다.가능한 값: management예시: category=management
curl -X GET 'https://rest-api.argosidentity.com/v3/projects/settings?category=management' \
-H 'x-api-key: {yourAPIKey}'

응답

성공 응답

traceId
string
아르고스에서 발급하는 API 요청의 고유 식별자입니다. 문의시 traceId를 첨부하면 더 빠르게 답변을 받을 수 있습니다.
item
object
현재 프로젝트의 설정 정보입니다.
{
  "traceId": "019a57b8-2bca-73de-94f0-220def0b60ee",
  "item": {
    "management": {
      "activateBlocking": {
        "activate": false
      },
      "admins": [
        "test@argosidentity.com"
      ],
      "description": " ",
      "formPrivacyPolicyUrl": " ",
      "formReturnUrl": " ",
      "formReturnUrlConfig": {
        "cf1": false,
        "cf2": false,
        "cf3": false,
        "email": false,
        "kycStatus": false,
        "submissionId": false,
        "userId": false,
        "skipResultPage": false,
        "isEncrypted": false
      },
      "formTermsOfUseUrl": " ",
      "ipWhitelist": {
        "admin": [],
        "api": []
      },
      "name": "test-project",
      "projectStatus": "open",
      "webhook": {
        "createTime": "2025-05-07T09:07:28.775Z",
        "url": "https://test.argosidentity.com",
        "members": [
          {
            "name": "test-member",
            "addDate": "2025-06-10T01:35:07.053Z",
            "email": "test@argosidentity.com"
          }
        ]
      }
    }
  }
}

실패 응답

오류 코드
statusCodecodemessage
400BAD_REQUESTInvalid query parameters
400INVALID_CATEGORYInvalid category parameter: [잘못된 카테고리들]
{
  "traceId": "018f1234-5678-90ab-cdef-123456789abc",
  "code": "BAD_REQUEST",
  "message": "Invalid query parameters"
}