SubAccount概要
    • PDF

    SubAccount概要

    • PDF

    記事の要約

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

    レスポンス

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

    レスポンスデータタイプ

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

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

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

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

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

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

    フィールドタイプ必須の有無説明
    errorCodeIntegerRequiredRequired
    messageStringRequiredString

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

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

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

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

    HTTPステータスコードコードメッセージ説明
    200-最大制限値を超えています。制限を超過
    400120重複している IDです。他の IDを入力してください。重複した IDを入力
    40030無効な subAccountIです。存在しないサブアカウント IDを入力
    40030無効な groupNoです。存在しないグループ IDを入力
    400400Request format is not json入力値形式エラー
    400400sessionExpirationDays is required, Request format is not jsonパラメータ入力エラー
    400400アクセス制限 IPアドレス帯域数は最大100個です。IPアドレス帯域数制限を超過
    • コンソールアクセスが可能な IPアドレス帯域数は最大100個
    400400ロール名を入力してください: [roleName]ロール名入力漏れ
    • 3~100文字以内で入力
    400400ロール名は3~100文字以内で入力してください。: [roleName]ロール名文字数エラー
    400400ロールタイプを指定してください: [roleType]ロールタイプ入力エラー
    • ロールタイプを指定
    400400無効なロールタイプです。ロールタイプ入力エラー
    • 有効なロールタイプを指定
    400400isMyAccountが抜けています。: [isMyAccount]isMyAccountパラメータ漏れ
    4009001アカウント名を入力してください。アカウント名の入力漏れまたはエラー
    4009001ログイン IDを入力してください。ログイン IDの入力が必要
    4009002ロールタイプが Serverの場合、未使用セッションタイムアウトは設定できません。パラメータ入力エラー
    • セッションタイムアウトを指定できないロールタイプ
    4009002セッションタイムアウトは[600、1800、3600、10800]秒にのみ設定できます。セッションタイムアウト入力エラー
    4009010文字、数字、記号の「.」、「_」、「-」のみ使用して3~100文字以内で入力してください。先頭文字は文字にします。入力値エラー
    • 英数字、記号を使用して3~100文字以内で入力
    4009010英字の小文字、数字のみ使用して3~20文字以内で入力してください。URL形式エラー
    • 英字の小文字、数字のみ使用して3~20文字以内で入力
    4009011既に存在するロール名です。既に使用中のロール名を入力
    4009015安全でないパスワードです。使用できないパスワードを入力
    400904無効な API Keyです。存在しない Access Keyを入力
    40130無効な subAccountIです。存在しないサブアカウント IDを入力
    40430無効な idNoです。存在しないサブアカウント IDを入力
    40430無効な roleNoです。存在しないロール IDを入力
    404404登録されていないポリシーです。存在しないポリシー IDを入力
    404910ロールに合わないエンティティがあります。ロールタイプに合わない適用対象が存在
    4099012対象の Roleに登録可能なエンティティ数を超えています。ロール適用対象が制限を超過
    4099012最大制限値を超えています。制限を超過
    500500Internal 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についてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。


    この記事は役に立ちましたか?

    Changing your password will log you out immediately. Use the new password to log back in.
    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.