권한 그룹 목록 조회
전체 권한 그룹 목록을 조회한다.
권한 그룹 목록 조회 API는 GET 메소드로 호출되며, 상세 스펙 및 호출 예제는 아래와 같습니다.
| HTTP URL | /api/oris/v1/groups |
|---|---|
| HTTP Method | GET |
| HTTP | 항목 | TYPE(길이) | 필수 | 값 | 설명 |
|---|---|---|---|---|---|
| Header | Authorization | string | Y | Bearer <access_token> | 로그인 시 ORIS로부터 전송받은 access_token을 HTTP Header에 추가 [scope = inquiry] |
| HTTP | 항목 | TYPE(길이) | 필수 | 값 | 설명 |
|---|---|---|---|---|---|
| Body | groups[] | array<object> | Y | - | 권한 그룹 목록 |
| groups[].groupId | string(26) | Y | 01JPPFGQ5BZZXYBKS8SJS0MAHX | 권한 그룹 ID | |
| groups[].name | string(100) | Y | ADMIN | 권한 그룹명 | |
| groups[].description | string(1000) | Y | 모든 권한 | 권한 그룹 설명 | |
| groups[].roles[] | array<object> | Y | - | 권한들 | |
| groups[].roles[].roleId | integer(int32) | Y | 1 | 권한 ID | |
| groups[].roles[].name | string(100) | Y | EX | 권한명 | |
| groups[].roles[].description | string(1000) | Y | 모든 권한 | 권한 설명 |
{
"groups": [
{
"groupId": "01JPPFGQ5BZZXYBKS8SJS0MAHX",
"name": "ADMIN",
"description": "모든 권한",
"roles": [
{
"roleId": 1,
"name": "EX",
"description": "모든 권한"
}
]
}
]
}| HTTP | 항목 | TYPE(길이) | 필수 | 값 | 설명 |
|---|---|---|---|---|---|
| Body | message | string | N | 요청에 실패했습니다. | 오류 메시지 |
| code | string("ERROR" | "BAD_REQUEST" | "INVALID_REQUEST" | "UNAUTHORIZED" | "FORBIDDEN" | "ACCESS_TOKEN_REQUIRED" | "ACCESS_TOKEN_EXPIRED" | "ACCESS_TOKEN_INVALID" | "ACCESS_TOKEN_NOT_ENOUGH_PERMISSION" | "AGENCY_NOT_FOUND" | "AGENCY_NOT_ACTIVE" | "AGENCY_NOT_APPROVED" | "AGENCY_NOT_MATCH" | "AGENCY_ACCESS_DENIED" | "AGENCY_CODE_DUPLICATED" | "MEMBER_NOT_FOUND" | "MEMBER_NOT_ACTIVE" | "MEMBER_NOT_MATCH" | "MEMBER_PASSWORD_NOT_MATCH" | "MEMBER_EMAIL_DUPLICATED" | "MEMBER_PASSWORD_RESET" | "MEMBER_PASSWORD_RESET_WITH_OLD" | "MEMBER_PASSWORD_INVALID_FORMAT" | "MEMBER_PASSWORD_FAIL_LIMIT_EXCEEDED" | "MEMBER_PASSWORD_EXPIRED" | "MEMBER_ACCOUNT_LOCKED" | "MEMBER_PASSWORD_REUSED" | "MEMBER_ACCESS_DENIED" | "API_KEY_NOT_FOUND" | "USER_NOT_FOUND" | "USER_NOT_ACTIVE" | "ACCOUNT_NOT_FOUND" | "REMITTANCE_NOT_FOUND" | "REMITTANCE_ALREADY_EXISTS" | "REMITTANCE_ALREADY_CANCELED" | "REMITTANCE_ACCOUNT_YEAR_MISMATCH" | "THREAD_NOT_FOUND" | "THREAD_ACCESS_DENIED" | "POST_NOT_FOUND" | "POST_ACCESS_DENIED" | "COMMENT_NOT_FOUND" | "COMMENT_ACCESS_DENIED" | "FILE_NOT_FOUND" | "FILE_ACCESS_DENIED" | "FILE_ALREADY_ATTACHED" | "FILE_DELETE_FAILED" | "TERM_NOT_FOUND" | "TERM_CANNOT_UPDATE" | "TERM_CANNOT_DELETE" | "TERM_CANNOT_SET_INITIATION_DATE" | "TERM_CANNOT_WITHDRAW_INITIATION_DATE" | "TERM_TYPE_NOT_FOUND" | "CONSENT_REQUIRED" | "CONSENT_NOT_FOUND" | "CONSENT_NOT_MATCH" | "GROUP_NOT_FOUND" | "GROUP_UPDATE_FORBIDDEN" | "GROUP_DELETE_FORBIDDEN" | "BATCH_NOT_FOUND" | "BATCH_CHUNK_NOT_FOUND") | N | ERROR | 오류 코드 |
{
"code": "BAD_REQUEST",
"message": "Failed to convert value of type 'java.lang.String' to required type 'java.lang.Boolean'"
}{
"code": "BAD_REQUEST",
"message": "Failed to convert value of type 'java.lang.String' to required type 'java.lang.Boolean'"
}{
"code": "BAD_REQUEST",
"message": "Validation failed for argument at index 0 in method"
}{
"code": "BAD_REQUEST",
"message": "Malformed JSON request"
}{
"code": "BAD_REQUEST",
"message": "Invalid argument"
}{
"code": "ACCESS_TOKEN_REQUIRED",
"message": "Access token is required for authentication."
}{
"code": "ACCESS_TOKEN_INVALID",
"message": "Invalid access token signature."
}{
"code": "CONSENT_REQUIRED",
"message": "Consent is required for 개인정보보호서약서",
"missingConsentType": "개인정보보호서약서"
}{
"code": "AGENCY_ACCESS_DENIED",
"message": "Agency access denied"
}{
"code": "ACCESS_TOKEN_EXPIRED",
"message": "Access token has expired."
}{
"code": "BAD_REQUEST",
"message": "No handler found for the request"
}