SubAccount概要

Prev Next

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

Sub Accountは、複数のユーザーが同じリソースを利用・管理できるようにサブアカウントを提供する NAVERクラウドプラットフォームのサービスです。Sub Accountサービスは、サブアカウント、グループ、ポリシー、ロール、External Access機能関連の APIを RESTful形式で提供します。

Sub Accountの共通設定

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

リクエスト

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

API URL

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

サブアカウント、グループ、ポリシー、ロール: https://subaccount.apigw.ntruss.com
外部アクセス権限: https://externalaccess.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

レスポンス

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

レスポンスデータタイプ

共通レスポンスデータタイプを説明します。

ProcessResult
ProcessResultは API処理結果を定義します。ProcessResultの説明は次の通りです。

フィールド タイプ 必須の有無 説明
success Boolean Required API処理結果
  • true | false
    • true: 成功
    • false: 失敗
id String Optional 作成/更新結果 ID
  • 作成、一括追加/削除 APIで使用
message String Optional API処理結果メッセージ

ProcessResultの構文とレスポンスのサンプルコードは次の通りです。

  • 構文
    ProcessResult {
      Boolean success;
      String id;
      String message;
    }
    
  • {
      "id": "",
      "success": true
    }
    

ErrorResponse
ErrorResponseは、API呼び出しの失敗時、失敗に対する内容を定義します。ErrorResponseの説明は次の通りです。

フィールド タイプ 必須の有無 説明
errorCode Integer Required Required
message String Required String

ErrorResponseの構文とサンプルコードは次の通りです。

  • 構文
    ErrorResponse {
      int errorCode;
      String message;
    }
    
  • {
      "errorCode": 9011,
      "message": "既に存在するロール名です。"
    }
    

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

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

HTTPステータスコード コード メッセージ 説明
200 - 最大制限値を超えています。 制限を超過
400 120 重複している IDです。他の IDを入力してください。 重複した IDを入力
400 30 無効な subAccountIです。 存在しないサブアカウント IDを入力
400 30 無効な groupNoです。 存在しないグループ IDを入力
400 400 Request format is not json 入力値形式エラー
400 400 sessionExpirationDays is required, Request format is not json パラメータ入力エラー
400 400 アクセス制限 IPアドレス帯域数は最大100個です。 IPアドレス帯域数制限を超過
  • コンソールアクセスが可能な IPアドレス帯域数は最大100個
400 400 ロール名を入力してください: [roleName] ロール名入力漏れ
  • 3~100文字以内で入力
400 400 ロール名は3~100文字以内で入力してください。: [roleName] ロール名文字数エラー
400 400 ロールタイプを指定してください: [roleType] ロールタイプ入力エラー
  • ロールタイプを指定
400 400 無効なロールタイプです。 ロールタイプ入力エラー
  • 有効なロールタイプを指定
400 400 isMyAccountが抜けています。: [isMyAccount] isMyAccountパラメータ漏れ
400 9001 アカウント名を入力してください。 アカウント名の入力漏れまたはエラー
400 9001 ログイン IDを入力してください。 ログイン IDの入力が必要
400 9002 ロールタイプが Serverの場合、未使用セッションタイムアウトは設定できません。 パラメータ入力エラー
  • セッションタイムアウトを指定できないロールタイプ
400 9002 セッションタイムアウトは[600、1800、3600、10800]秒にのみ設定できます。 セッションタイムアウト入力エラー
400 9010 文字、数字、記号の「.」、「_」、「-」のみ使用して3~100文字以内で入力してください。先頭文字は文字にします。 入力値エラー
  • 英数字、記号を使用して3~100文字以内で入力
400 9010 英字の小文字、数字のみ使用して3~20文字以内で入力してください。 URL形式エラー
  • 英字の小文字、数字のみ使用して3~20文字以内で入力
400 9011 既に存在するロール名です。 既に使用中のロール名を入力
400 9015 安全でないパスワードです。 使用できないパスワードを入力
400 904 無効な API Keyです。 存在しない Access Keyを入力
401 30 無効な subAccountIです。 存在しないサブアカウント IDを入力
404 30 無効な idNoです。 存在しないサブアカウント IDを入力
404 30 無効な roleNoです。 存在しないロール IDを入力
404 404 登録されていないポリシーです。 存在しないポリシー IDを入力
404 910 ロールに合わないエンティティがあります。 ロールタイプに合わない適用対象が存在
409 9012 対象の Roleに登録可能なエンティティ数を超えています。 ロール適用対象が制限を超過
409 9012 最大制限値を超えています。 制限を超過
500 500 Internal Server Error 内部サーバエラー
参考

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

Sub Account API

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

サブアカウント

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

API 説明
サブアカウントリストの照会 サブアカウントリストを照会
サブアカウントの照会 サブアカウントの詳細を個別照会
サブアカウントの作成 サブアカウントを作成
サブアカウントの更新 サブアカウント情報を更新
サブアカウントの削除 サブアカウントを削除
Access Keyの照会 サブアカウントの Access Keyを照会
Access Keyの作成 サブアカウントの Access Keyを作成
Access Keyの削除 サブアカウントの Access Keyを削除
Access Key状態の設定 サブアカウント Access Keyの 有効化・無効化設定
ログインアクセスキーの照会 サブアカウントのログインアドレスに使用されるログインアクセスキーを照会
ログインアクセスキーの設定 サブアカウントのログインアドレスに使用されるログインアクセスキーを設定
ログイン IDのチェック サブアカウントログイン IDの有効性と重複をチェック
ログインパスワードのチェック サブアカウントログインパスワードの有効性と複雑さをチェック
アイドルセッションタイムアウトの照会 サブアカウントのアイドルセッションタイムアウトを照会
アイドルセッションタイムアウトの設定 サブアカウントのアイドルセッションタイムアウトを設定
ログインパスワード有効期限の照会 サブアカウントのログインパスワード有効期限(変更周期)を照会
ログインパスワード有効期限の設定 サブアカウントのログインパスワード有効期限(変更周期)を設定
ログインパスワードの再設定 サブアカウントのログインパスワードを変更
ポリシーの割り当て サブアカウントにポリシーを割り当て
ポリシーの削除 サブアカウントに割り当てられたポリシーを削除
グループの追加 サブアカウントをグループに追加
グループの削除 サブアカウントをグループから削除
コンソールアクセスルールの照会 サブアカウントのコンソールアクセスルールを照会
コンソールアクセスルールの更新 サブアカウントのコンソールアクセスルールを更新
APIアクセスルールの照会 サブアカウントの APIアクセスルールを照会
APIアクセスルールの更新 サブアカウントの APIアクセスルールを更新
2段階認証情報の照会 サブアカウントの2段階認証情報を照会
タグの照会 サブアカウントに追加されたタグを照会
タグの追加 サブアカウントにタグを追加
タグの削除 サブアカウントに追加されたタグを削除
ユーザー情報の照会 権限が付与されたサブアカウントのユーザー情報を照会
ユーザー IDの照会 サブアカウント IDを照会

グループ

グループ関連 APIの説明は次の通りです。

API 説明
グループリストの照会 グループリストの照会
グループの照会 グループの詳細を個別照会
グループの作成 グループを作成
グループの更新 グループ情報を更新
グループの削除 グループを削除
サブアカウントの追加 グループにサブアカウントを追加
サブアカウントの削除 グループからサブアカウントを削除
ポリシーの割り当て グループにポリシーを割り当て
ポリシーの削除 グループに割り当てられたポリシーを削除
タグの照会 グループに追加されたタグを照会
タグの追加 グループにタグを追加
タグの削除 グループに追加されたタグを削除

ポリシー

ポリシー関連 APIの説明は次の通りです。

API 説明
ポリシーリストの照会 ポリシーリストを照会
ポリシーの照会 ポリシーの詳細を個別照会
ポリシー有効性の確認 ユーザー定義ポリシー(User Created)の有効性を確認
ポリシーの作成 ユーザー定義ポリシー(User Created)を作成
ポリシーの更新 ユーザー定義ポリシー(User Created)情報を更新
ポリシーリストの削除 2つ以上のユーザー定義ポリシー(User Created)を一括削除
ポリシーの削除 ユーザー定義ポリシー(User Created)を削除
ポリシーに割り当てられたリソースの照会 ポリシーに割り当てられたリソース(サブアカウント、グループ、ロール)を照会
タグの照会 ユーザー定義ポリシー(User Created)に追加されたタグを照会
タグの追加 ユーザー定義ポリシー(User Created)にタグを追加
タグの削除 ユーザー定義ポリシー(User Created)に追加されたタグを削除

ロール

ロール関連 APIの説明は次の通りです。

API 説明
ロールリストの照会 ロールリストを照会
ロールの照会 ロールの詳細を個別照会
ロールの作成 ロールを作成
ロールの更新 ロール情報を更新
ロールの削除 ロールを削除
ポリシーの割り当て ロールにポリシーを割り当て
ポリシーの削除 ロールに割り当てられたポリシーを削除
ロール(Account)適用対象の照会 Accountロール適用対象を照会
ロール(Account)適用対象の追加 Accountロール適用対象を追加
ロール(Account)適用対象の削除 Accountロール適用対象を削除
ロール(Server、Service)適用対象の追加 Server、Serviceロール適用対象を追加
ロール(Server、Service)適用対象の削除 Server、Serviceロール適用対象を削除
ロールリスト状態の設定 2つ以上のロールを有効化または無効化に一括設定
ロール状態の設定 ロールの有効化または無効化を設定
タグの照会 ロールに追加されたタグを照会
タグの追加 ロールにタグを追加
タグの削除 ロールに追加されたタグを削除
切り替え可能なロールの照会 サブアカウントで切り替え可能なロールを照会
切り替え可能なロールの登録 サブアカウントで切り替え可能なロールを登録
切り替え可能なロールの更新 サブアカウントで切り替え可能なロール情報を更新
切り替え可能なロールの削除 サブアカウントで切り替え可能なロールを削除

External Access

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

API 説明
Trust Anchorリストの照会 Trust Anchorリストを照会
Trust Anchorの照会 Trust Anchorの詳細を個別照会
Trust Anchorの作成 Trust Anchorを作成
Trust Anchorの更新 Trust Anchor情報を更新
Trust Anchorの有効化 Trust Anchor状態の有効化を設定
Trust Anchorの無効化 Trust Anchor状態の無効化を設定
Trust Anchorの削除 Trust Anchorを削除
Profileリストの照会 Profileリストを照会
Profileの照会 Profileの詳細を個別照会
Profileの作成 Profileの作成
Profileの更新 Profile情報を更新
Profileの有効化 Profile状態の有効化を設定
Profileの無効化 Profile状態の無効化を設定
Profileの削除 Profileを削除
Subjectリストの照会 Subjectリストを照会
Subjectの照会 Subjectの詳細を個別照会
Subject Activityリストの照会 Subject Activityリスト(同じ Subjectを持つ証明書の詳細な使用履歴)を照会
CRLリストの照会 CRL(証明書失効リスト)リストを照会
CRLの照会 CRL(証明書失効リスト)の詳細を個別照会
CRLの作成 CRL(証明書失効リスト)を作成
CRLの更新 CRL(証明書失効リスト)情報を更新
CRLの有効化 CRL(証明書失効リスト)状態の有効化を設定
CRLの無効化 CRL(証明書失効リスト)状態の無効化を設定
CRLの削除 CRL(証明書失効リスト)を削除

Sub Account関連リソース

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