Login
      目次 x
      Organization の概要
        • 印刷する
        • PDF
        目次

        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-timestamp1970年1月1日00:00:00協定世界時(UTC)からの経過時間をミリ秒(millisecond)で表したもので、APIGWサーバとの時間差が5分以上の場合は無効なリクエストとみなすNcloud共通
          x-ncp-iam-access-keyNAVER Cloud Platformポータルで発行した Access Key ID値Ncloud共通
          x-ncp-apigw-signature-v2Access 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
          Change password!
          Changing your password will log you out immediately. Use the new password to log back in.
          Change profile
          Success!
          First name must have atleast 2 characters. Numbers and special characters are not allowed.
          Last name must have atleast 1 characters. Numbers and special characters are not allowed.
          Enter a valid email
          Enter a valid password
          Your profile has been successfully updated.
          Logout