Organization 개요

인쇄
공유
PDF

기사 요약

이 요약이 도움이 되었나요?

의견을 보내 주셔서 감사합니다.

Classic/VPC 환경에서 이용 가능합니다.

개요

RESTful API 방식의 HTTP GET/POST/PUT/DELETE 메서드 호출을 통해 Organization, 계정, 계정 그룹, Quota Policy를 관리할 수 있습니다.

공통설정

API URL

GET or POST or PUT or DELETE
https://organization.apigw.ntruss.com/open-api/v1/

요청 헤더

NAVER Cloud Platform 인증키 및 Signature 생성 가이드 바로가기

헤더 명	설명	비고
x-ncp-apigw-timestamp	1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(millisecond)로 나타낸 것APIGW 서버와 시간차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주	Ncloud 공통
x-ncp-iam-access-key	NAVER Cloud Platform 포털에서 발급받은 Access Key ID 값	Ncloud 공통
x-ncp-apigw-signature-v2	Access Key ID 값 과 Secret Key 로 암호화한 서명	Ncloud 공통

기본정보

Organization API는 크게 4가지 기능을 제공합니다.

Organization 관리(조회/생성/삭제)
계정관리(정보 조회 및 초대)
계정 그룹관리(조회, 생성, 이동, 변경, 삭제)
Quota Policy 관리(Quota Policy 조회, 생성, 삭제, 적용)

오퍼레이션

Organization은 다음과 같은 api를 통해 작동됩니다.

Organization 관련 API

Organization 조회 (GET /org)
Organization 생성 (POST /org)
Organization 삭제 (DELETE /org/{organizationNo})

계정 관리 관련 API

계정 목록 조회 (GET /account/group/{organizationGroupNo})
계정 탈퇴 신청 목록 조회 (GET /account/leave)
계정 강제 탈퇴 (POST /account/leave/force)
계정 탈퇴 승인/거절 (POST /account/leave)
계정 초대 (POST /account/invite)
초대 목록 조회 (GET /account/invite/invitation)
계정 초대 승인(POST /account/invite)
계정 초대 거절 (POST /account/reject)

계정 그룹 관련 API

계정 그룹 조회 (GET /group/tree)
계정 그룹 생성 (POST /group)
계정 그룹 삭제 (DELETE /group/{organizationGroupNo})
계정 그룹 이름 변경 (PUT /group/{organizationGroupNo})
계정 그룹 이동 (POST /group/move)

Quota Policy 관리 관련 API

리전 목록 조회 (GET /policy/regionNo)
리소스 카테고리 조회 (GET /policy/category/{regionNo})
리소스 목록 조회 (GET /policy/resource/{regionNo}/{categoryCode})
리소스 유형 목록 조회 (GET /policy/detail/{regionNo}/{resourceTypeCode})
Quota Policy 조회 (GET /policy/list)
Quota Policy 상세 조회 (GET /policy/allotment/{memberNo}/{regionNo})
적용 Quota Policy 목록 조회 (GET /policy/applied)
Quota Policy 생성 (POST /policy)
Quota Policy 적용 (POST /policy/apply)
Quota Policy 적용 해제 (POST /policy/remove)
Quota Policy 삭제 (DELETE /policy)

응답 코드

서비스 공통 오류 코드

서비스 공통 응답 코드는 API Guide > 3. 호출 > 실패 가이드를 참조해 주십시오.

Organization 오류 코드

Organization 오류 코드는 아래 내용을 참고해 주세요.

HttpStatusCode	ErrorCode	ErrorMessage	Description
403	COMMON_101	마스터 계정이 아닙니다.	마스터 계정 아님
403	COMMON_102	메일발송에 실패했습니다. 잠시 후 다시 시도해주세요.	메일 발송 실패
403	COMMON_103	내부 서버 오류가 발생 하였습니다. 문제가 계속 될 경우 고객지원(1544-5876)으로 문의해 주세요.	내부 서버 오류
403	COMMON_104	잦은 요청으로 기능 수행이 잠시 제한됩니다.	잦은 요청 오류
403	ACCOUNT_101	현재 미납 요금이 존재하여 새로운 계정을 Organization에 초대할 수 없습니다.	초대 실패 (Organization에 미납금액 존재)
403	ACCOUNT_102	같은 거주지 국가의 계정만 초대할 수 있습니다.	초대 실패 (마스터 계정, 멤버 계정 간 거주지 국가 상이)
403	ACCOUNT_103	이미 초대한 계정입니다.	초대 실패 (이미 초대한 계정)
403	ACCOUNT_104	이미 가입한 Organization이 존재합니다.	초대 실패 (이미 다른 Organization에 가입된 계정)
403	ACCOUNT_105	Account 정보를 다시 한 번 확인하세요.	초대 실패 (Login ID, Member No 오류)
403	ACCOUNT_106	이미 Organization에 가입된 계정입니다.	초대 승인 실패 (이미 가입된 계정)
403	ACCOUNT_107	Pin Code를 다시 확인해주세요.	초대 승인 실패 (Pin Code 오류)
403	ACCOUNT_108	초대 유효기간이 만료되었습니다.	초대 승인 실패 (초대 유효기간 만료)
403	ACCOUNT_109	아직 납부되지 않은 미납금액이 존재합니다.	초대 승인 실패 (미납금액 존재)
403	ACCOUNT_110	초대할 수 없는 계정입니다. 초대할 계정을 다시 한번 확인해 주세요.	초대 실패 (초대할 수 없는 계정)
403	ACCOUNT_201	Account 정보를 다시 한 번 확인하세요.	탈퇴 실패 (Login ID, Member No 오류)
403	ACCOUNT_202	미납이 존재합니다.	탈퇴 실패 (미납금액 존재)
403	ACCOUNT_203	결제수단이 존재하지 않습니다.	탈퇴 실패 (결재수단 미등록)
403	ACCOUNT_204	매월 1일 00시 00분 ~ 2일 23시 59분 사이에 탈퇴를 진행할 수 없습니다. 3일 이후에 진행해주세요.	탈퇴 실패 (매월 1일 00시 - 2일 24시 사이 탈퇴 불가)
403	ORG_101	이미 가입한 Organization이 존재합니다.	Organization 생성 실패 (이미 다른 Organization에 가입된 계정)
403	ORG_102	사업자 계정이 아닙니다.	Organization 생성 실패 (사업자 계정 아님)
403	ORG_103	결제수단이 존재하지 않습니다.	Organization 생성 실패 (결재수단 미등록)
403	ORG_104	미납이 존재합니다.	Organization 생성 실패 (미납금액 존재)
403	ORG_201	멤버 계정 혹은 대기중인 계정이 존재하는 Organization을 삭제할 수 없습니다.	Organization 삭제 실패 (멤버 계정 또는 대기중인 계정 존재)
403	GROUP_101	이름은 필수값입니다.	그룹 생성/수정 실패 (이름 필수값)
403	GROUP_102	이름은 3~50자 사이여야합니다.	그룹 생성/수정 실패 (이름 3-50자 사이만 허용)
403	GROUP_103	이름은 영문자, 숫자, “-”, “_”, “.” 문자만 입력 가능합니다.	그룹 생성/수정 실패 (이름 영문, 숫자, -,_, . 만 입력 가능)
403	GROUP_104	그룹은 5단계까지만 생성가능합니다.	그룹 생성/수정 실패 (그룹 5단계 이하 생성 가능)
403	GROUP_105	상위 노드가 존재하지 않습니다.	그룹 생성/수정 실패 (상위 노드 누락)
403	GROUP_106	적합한 Organization이 아닙니다.	그룹 생성/수정 실패 (본인 그룹 아님)
403	GROUP_201	적합한 Organization이 아닙니다.	그룹 삭제 실패 (본인 그룹 아님)
403	GROUP_202	하위 그룹 혹은 계정이 존재하여 삭제할 수 없습니다.	그룹 삭제 실패 (하위 그룹 또는 계정 존재)
403	GROUP_301	그룹은 5단계까지만 생성가능합니다.	그룹 이동 실패 (그룹 5단계 이하 생성 가능)
403	QUOTA_101	최대 갯수를 넘어 생성할 수 없습니다.	정책 오류 (리소스 최대 한도 초과)
401	COMMON_201	메인 계정으로만 수행할 수 있는 기능입니다.	권한 오류 (Master 계정 아님)

응답 오류 예시

{
 "timestamp": "2022-11-29T13:55:11Z",
 "status": 401,
 "error": "UNAUTHORIZED",
 "message": " .",
 "code": "COMMON_201"
}

계정 유형에 따른 사용 가능 API

Organization의 마스터 계정, 멤버 계정 별로 사용 가능한 API의 제약이 있습니다.

계정 유형	사용 가능 API
-	Organization 생성 (POST /org)
마스터 계정	Organization 조회 (GET /org)
마스터 계정	Organization 삭제 (DELETE /org/{organizationNo})
마스터 계정	계정 목록 조회 (GET /account/group/{organizationGroupNo})
마스터 계정	계정 탈퇴 신청 목록 조회 (GET /account/leave)
마스터 계정	계정 강제 탈퇴 (POST /account/leave/force)
마스터 계정	계정 탈퇴 승인/거절 (POST /account/leave)
마스터 계정	계정 초대 (POST /account/invite)
-	초대 목록 조회 (GET /account/invite/invitation)
-	계정 초대 승인(POST /account/invite)
-	계정 초대 거절 (POST /account/reject)
마스터 계정	계정 그룹 조회 (GET /group/tree)
마스터 계정	계정 그룹 생성 (POST /group)
마스터 계정	계정 그룹 삭제 (DELETE /group/{organizationGroupNo})
마스터 계정	계정 그룹 이름 변경 (PUT /group/{organizationGroupNo})
마스터 계정	계정 그룹 이동 (POST /group/move)
마스터 계정	리전 목록 조회 (GET /policy/regionNo)
마스터 계정	리소스 카테고리 조회 (GET /policy/category/{regionNo})
마스터 계정	리소스 목록 조회 (GET /policy/resource/{regionNo}/{categoryCode})
마스터 계정	리소스 유형 목록 조회 (GET /policy/detail/{regionNo}/{resourceTypeCode})
마스터 계정	Quota Policy 조회 (GET /policy/list)
마스터 계정	Quota Policy 상세 조회 (GET /policy/allotment/{memberNo}/{regionNo})
마스터 계정	적용 Quota Policy 목록 조회 (GET /policy/applied)
마스터 계정	Quota Policy 생성 (POST /policy)
마스터 계정	Quota Policy 적용 (POST /policy/apply)
마스터 계정	Quota Policy 적용 해제 (POST /policy/remove)
마스터 계정	Quota Policy 삭제 (DELETE /policy)

이 문서가 도움이 되었습니까?

What's Next

Organization 조회

개요
공통설정
오퍼레이션
응답 코드

태그

Organization