​
1. 엔드포인트

GET/Projection
GET https://rest-api.argosidentity.com/v3/projection

​
2. 인증

x-api-key 헤더에 API 키를 포함시켜야 합니다:

x-api-key
x-api-key: {yourAPIKey}

​
3. 요청 파라미터

There is no requirement for the request body.

​
4. 요청 예시

GET/Projection
curl --location 'https://rest-api.argosidentity.com/v3/projection' \
--header 'x-api-key: {yourAPIKey}'

​
5. 응답

​
5-1. 성공 응답

{
    "items": [
        {
            "projection_id": "{projection_id}",
            "name": "{name}",
            "mode": "{mode}",
            "fields": [
                "gender",
                "nationality"
            ],
            "created_at": "2023-12-01T12:34:56.789Z"
        },
        {
            "projection_id": "{projection_id}",
            "name": "{name}",
            "mode": "{mode}",
            "fields": [
                "gender",
                "nationality"
            ],
            "created_at": "2023-12-01T12:34:56.789Z"
        }
    ],
    "message": "Get projection list success"
}

​
5-2. 응답 데이터

필드명설명데이터 타입카테고리
projection_idThe unique ID of the generated projectionStringProjection Info
nameThe projection nameStringProjection Info
modeThe projection mode. Currently, there is only the exclude option.StringProjection Info
fieldsThe list to exclude specific fields.Array<String>Projection Info
created_atCreated Time (Type of ISO 8601)StringProjection Info

​
5-3. 오류 코드

상태 코드오류 메시지설명
404Projection not found지정한 projectionId에 해당하는 프로젝션이 없을 때
405Method not allowed for /projections/projectionId pathGET, DELETE 이외의 HTTP 메서드(POST, PUT 등)로 요청한 경우
500Internal server error서버 내부에서 처리되지 않은 예외가 발생한 경우