Organizationの概要

Prev Next

Classic/VPC環境で利用できます。

Organizationは、組織が持つすべてのアカウントで発生した費用の統合決済とリソース使用ポリシーの管理機能を提供する NAVERクラウドプラットフォームのサービスです。Organizationサービスは、Organization、Account、Group、Quota Policy(利用限度ポリシー)機能関連 APIを RESTful形式で提供します。

Organizationの共通設定

Organization APIで共通して使用されるリクエスト形式とレスポンス形式を説明します。

リクエスト

共通リクエスト形式を説明します。

API URL

リクエスト API URLは次の通りです。

https://organization.apigw.ntruss.com

リクエストヘッダ

ヘッダの説明は次の通りです。

フィールド 必須の有無 説明
x-ncp-apigw-timestamp Required 1970年1月1日00:00:00協定世界時(UTC)からの経過時間(ミリ秒)
  • API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす
  • Unix Timestamp形式
x-ncp-iam-access-key Required NAVERクラウドプラットフォームから発行された Access Key
x-ncp-apigw-signature-v2 Required NAVERクラウドプラットフォームから発行された Access Keyとマッピングする Secret Keyと HMAC暗号化アルゴリズム(HmacSHA256)でリクエスト情報を暗号化した後、Base64でエンコードした署名
Accept Optional レスポンスデータの形式
  • application/json
Content-type Optional リクエストデータの形式
  • application/json

レスポンス

共通レスポンス形式を説明します。

レスポンスステータスコード

レスポンスステータスコードの説明は次の通りです。

HTTPステータスコード コード メッセージ 説明
401 COMMON_201 メインアカウントでのみ実行できる機能です。 マスターアカウントではない
403 COMMON_101 マスターアカウントではありません。 マスターアカウントではない
403 COMMON_102 メールを送信できません。しばらくしてからもう一度お試しください。 メール送信失敗
403 COMMON_103 内部サーバエラーが発生しました。エラーが続く場合、カスタマーサポート(+82-1544-5876)までお問い合わせください。 内部サーバエラー
403 COMMON_104 リクエストが頻繁過ぎるため、機能の実行が一定時間制限されます。 頻繁過ぎるリクエスト
403 ACCOUNT_101 現在、未払い料金が存在するため、新しいアカウントを Organizationに招待できません。 招待承認失敗: サービス利用料金未払い
403 ACCOUNT_102 居住している同じ国のアカウントのみ招待できます。 招待失敗: 居住地国が異なる
403 ACCOUNT_103 既に招待したアカウントです。 招待失敗: 既に招待済みのアカウント
403 ACCOUNT_104 既に登録済みの Organizationが存在します。 招待失敗: 招待対象が別の Organizationに登録されている
403 ACCOUNT_105 Account情報をもう一度確認してください。 招待失敗: アカウント情報入力エラー
403 ACCOUNT_106 Organizationに登録済みのアカウントです。 招待承認失敗: 既に登録済みのアカウント
403 ACCOUNT_107 Pin Codeをもう一度確認してください。 招待承認失敗: PINコード入力エラー
403 ACCOUNT_108 招待の有効期限が切れています。 招待承認失敗: 招待の有効期限切れ
403 ACCOUNT_109 まだ支払われていない利用料金が存在します。 招待承認失敗: サービス利用料金未払い
403 ACCOUNT_111 メンバーアカウントの招待は、マスターアカウントと同じ事業者番号を持つ企業会員に限って招待できます。 招待失敗: マスターアカウントと招待アカウントの事業者番号が一致しない
403 ACCOUNT_112 パートナー会員の締結/退会およびパートナーコードの変更が予定されているアカウント 招待承認失敗: パートナー会員の締結/退会およびパートナーコードの変更が予定されている
403 ACCOUNT_113 正常な会員でないか、会員情報の確認が取れないアカウント 招待失敗: 正常な会員でないか、会員情報の確認が取れない
403 ACCOUNT_114 Masterアカウントと異なる通貨コードを持つアカウント 招待失敗: マスターアカウントと通貨コードが異なる
403 ACCOUNT_115 Masterアカウントと会員タイプが異なるアカウント 招待失敗: マスターアカウントと会員タイプが異なる
403 ACCOUNT_116 パートナー代表アカウント 招待失敗: パートナー代表アカウント
403 ACCOUNT_117 Masterアカウントとパートナーコードが異なるアカウント 招待失敗: マスターアカウントとパートナーコードが異なる
403 ACCOUNT_201 アカウント名またはログイン IDが無効なアカウント 退会失敗: loginId、memberNoの入力エラー
403 ACCOUNT_202 未払料金が存在します。 退会失敗: サービス利用料金未払い
403 ACCOUNT_203 決済手段が存在していません。 退会失敗: 決済手段が登録されていない
403 ACCOUNT_204 毎月1日00時00分 ~2日23時59分の間は退会できません。3日以降に続行してください。 退会失敗: 利用制限時間
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文字以内で入力してください。 グループの作成/変更失敗: 入力エラー
403 GROUP_103 名前には英数字、記号の「-」、「_」、「.」のみ入力できます。 グループの作成/変更失敗: 入力エラー
403 GROUP_104 グループは5段階までのみ作成できます。 グループの作成/変更失敗: 制限範囲超過
403 GROUP_105 上位ノードが存在しません。 グループの作成/変更失敗: 上位ノード欠落
403 GROUP_106 適切な Organizationではありません。 グループの作成/変更失敗: 無効なリクエスト
  • マスターアカウント本人が所有するグループのみ作成/変更が可能
403 GROUP_201 適切な Organizationではありません。 グループ削除失敗: 無効なリクエスト
  • マスターアカウント本人が所有するグループのみ削除可能
403 GROUP_202 下位グループもしくはアカウントが存在するため、削除できません。 グループ削除失敗: 下位グループまたはアカウントが存在
403 GROUP_301 グループは5段階までのみ作成できます。 グループ移動失敗: 制限範囲超過
403 QUOTA_101 最大値を超えて作成することはできません。 ポリシー作成失敗: リソース最大値超過
参考

NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。

Organization API

Organizationサービスが提供する APIの説明は次の通りです。

Organization

Organization関連 APIの説明は次の通りです。

API 説明
Organizationの照会 Organizationを照会
  • マスターアカウントの場合に使用可能
Organizationの作成 Organizationを作成
  • マスターアカウントの場合に使用可能
Organizationの削除 Organizationを削除
  • マスターアカウントの場合に使用可能

アカウント

アカウント関連 APIの説明は次の通りです。

API 説明
アカウントリストの照会 Organization所属アカウントリストを照会
  • マスターアカウントの場合に使用可能
アカウントの招待 Organizationメンバーアカウントとして招待
  • マスターアカウントの場合に使用可能
招待リストの照会 Organizationのアカウント招待情報を照会
  • 招待された独立アカウントの場合に使用可能
招待の承認 Organizationの招待を承認
  • 招待された独立アカウントの場合に使用可能
招待の拒否 Organizationの招待を拒否
  • 招待された独立アカウントの場合に使用可能
退会申し込みリストの照会 退会申し込みリストを照会
  • マスターアカウントの場合に使用可能
退会申し込みの承認・却下 メンバー退会申し込みを承認または却下
  • マスターアカウントの場合に使用可能
強制退会 メンバーアカウントを強制退会
  • マスターアカウントの場合に使用可能

アカウントグループ

アカウントグループ関連 APIの説明は次の通りです。

API 説明
アカウントグループリストの照会 アカウントグループリストを照会
  • マスターアカウントの場合に使用可能
アカウントグループの作成 アカウントグループを作成
  • マスターアカウントの場合に使用可能
アカウントグループの削除 アカウントグループを削除
  • マスターアカウントの場合に使用可能
アカウントグループ名の変更 アカウントグループ名を変更
  • マスターアカウントの場合に使用可能
アカウントグループの移動 アカウントグループの位置を移動
  • マスターアカウントの場合に使用可能

Quota Policy

Quota Policy(利用限度ポリシー)関連 APIの説明は次の通りです。

API 説明
リージョンリストの照会 Quota Policyが適用可能なリージョンを照会
  • マスターアカウントの場合に使用可能
リソースカテゴリリストの照会 Quota Policyが適用可能なリソースカテゴリを照会
  • マスターアカウントの場合に使用可能
リソースリストの照会 Quota Policyが適用可能なリソースを照会
  • マスターアカウントの場合に使用可能
リソースタイプリストの照会 Quota Policyが適用可能なリソースの詳細タイプを照会
  • マスターアカウントの場合に使用可能
リソース利用限度の照会 アカウント別リソース利用限度を詳細照会
  • マスターアカウントの場合に使用可能
Quota Policyリストの照会 Quota Policyリストを照会
  • マスターアカウントの場合に使用可能
Quota Policyの作成 Quota Policyを作成
  • マスターアカウントの場合に使用可能
Quota Policyの削除 Quota Policyを削除
  • マスターアカウントの場合に使用可能
Quota Policy適用の照会 アカウントグループに適用された Quota Policyを照会
  • マスターアカウントの場合に使用可能
Quota Policyの適用 アカウントグループに Quota Policyを適用
  • マスターアカウントの場合に使用可能
Quota Policy適用の解除 アカウントグループに適用された Quota Policyを解除
  • マスターアカウントの場合に使用可能

Organization関連リソース

Organization APIについてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。