2) Security365 회사 별 빌트인 프로파일 조회 및 업데이트
Security365 회사 별 빌트인 프로파일 조회
API
| Method | URL |
|---|---|
| POST | /builtInProfile/info/all |
Request Header
| Name | Required | Description |
|---|---|---|
| Authorization | required | 사용자 인증 수단, JWT값 Authorization: Bearer {JWT}- 참고 : JWT값은 인증/인가 서비스를 통해 발급 받는다. - 주의 : 해당 토큰은 요청 본문에 포함된 companyId로 발급된 토큰이어야 한다. |
Request Body
| Name | Required | Type | Description |
|---|---|---|---|
| companyId | required | string | Security365 SHIELD ID 서비스에 등록 된 companyId |
Response
| Name | Type | Description |
|---|---|---|
| code | int | 성공 여부 (성공:0) |
| data | JsonArray | 빌트인 프로파일 목록 |
| key | string | 어트리뷰트 이름 |
| value | string | 어트리뷰트 값 |
| desc | string | 어트리뷰트 상세 |
| use | string | 어트리뷰트 사용 유무 |
| additionalInformation | string | 어트리뷰트 설명 |
Examples
Response
- 빌트인 프로파일 조회 성공
{
"code": 0,
"data": [
{
"key": "TENANT_APP_ID",
"value": "9a24cf56-aeb0-468d-a15a-f27bf8aa0a95",
"use": true,
"additionalInformation": "회사별 App Id"
},
{
"key": "TENANT_APP_SECRET",
"value": "IictJisoIywlJSUoKSQmKSQlJCwnISIsJCgsKyotISo",
"use": true,
"additionalInformation": "회사별 App Secret"
},
...(생략)
]
}
- 토큰 검증 실패
{
"code": 40101,
"error": "invalid_token",
"message": "Invalid token."
}
- 일치하는 companyId 없음
{
"code": 40102,
"error": "Failed",
"message": "No matching company ID found"
}
- 내부 서비스 실패
{
"code": 50001,
"error": "server_error",
"message": "An unexpected error has occurred in the internal system."
}
Security365 회사 별 빌트인 프로파일 업데이트
API
| Method | URL |
|---|---|
| POST | /builtInProfile/info/update |
Request Header
| Name | Required | Description |
|---|---|---|
| Authorization | required | 사용자 인증 수단, JWT값 Authorization: Bearer {JWT}- 참고 : JWT값은 인증/인가 서비스를 통해 발급 받는다. - 주의 : 해당 토큰은 요청 본문에 포함된 companyId로 발급된 토큰이어야 한다. |
Request Body
| Name | Required | Type | Description |
|---|---|---|---|
| companyId | required | string | Security365 SHIELD ID 서비스에 등록 된 companyId |
| data | required | array | 빌트인 프로파일 목록 |
| key | required | string | 어트리뷰트 이름 |
| value | required | string | 어트리뷰트 값 |
| desc | required | string | 어트리뷰트 상세 |
| use | required | string | 어트리뷰트 사용 유무 |
| additionalInformation | required | string | 어트리뷰트 설명 |
Response
| Name | Type | Description |
|---|---|---|
| code | int | 성공 여부 (성공:0) |
| message | string | 응답 내용 |
Examples
Response
- 빌트인 프로파일 업데이트 성공
{
"code": 0,
"message" : "BuiltIn Profile Update Successfully"
}
- 토큰 검증 실패
{
"code": 40101,
"error": "invalid_token",
"message": "Invalid token."
}
- 필수 파라미터 없음
{
"code": 40105,
"error": "Failed",
"message": "Missing required input values"
}
- 내부 서비스 실패
{
"code": 50001,
"error": "server_error",
"message": "An unexpected error has occurred in the internal system."
}