MENU
      Ncloud Single Sign-Onの概要
        • PDF

        Ncloud Single Sign-Onの概要

        • PDF

        記事の要約

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

        Ncloud Single Sign-Onは、1つのアカウントでさまざまなアプリケーションにアクセスできるシステムを構築する NAVERクラウドプラットフォームのサービスです。Ncloud Single Sign-Onサービスは、Application、Tenant、External IdP、SSO User、グループ、Permission Set、Assignment、IP ACL機能関連の APIを RESTful形式で提供します。

        Ncloud Single Sign-Onの共通設定

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

        リクエスト

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

        API URL

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

        https://sso.apigw.ntruss.com
        HTTP

        リクエストヘッダ

        リクエストヘッダの説明は次の通りです。

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

        レスポンス

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

        レスポンスデータタイプ

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

        ProcessResult

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

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

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

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

        ErrorResponse

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

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

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

        • 構文
          ErrorResponse {
            int errorCode;
            String message;
          }
          Plain text
        • {
              "errorCode": 9060,
              "message": "グループ名が既に存在します。"
          }
          JSON

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

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

        HTTPステータスコードコードメッセージ説明
        400400ユーザーはこのグループに属していません。グループに属していないユーザーを入力
        400400Permission Setが存在しません。Permission Setが存在しない
        400400既に存在する Application名です。既に存在する Application名を入力
        400400Tenant already exists既に Tenantが存在
        400400既に使用されている Login IDです。既に使用されているログイン IDを入力
        400500Policyが存在しません。存在しないポリシー名を入力
        4009016存在しない Applicationです。存在しない Application IDを入力
        4009020There is a registered identity provider.External IdPが既に存在
        4009021This identify provider doesn't exist.External IdPが存在しない
        4009023Organizationが連携されている状態では Identity Providerを削除できません。Organizationが連携されている状態の場合、Identity Providerは削除不可
        4009024Invalid metadata format.メタデータ形式エラー
        4009025There is no certificate information for signing in the metadata.メタデータに署名用の証明書情報が存在しない
        4009026There are two or more certificates for signing in the metadata.メタデータに署名用証明書が2つ以上存在
        4009027There is no SingleSignOnService binding in the metadata.メタデータにプロトコルバインディング情報が存在しない
        4009028There is no SingleSignOnService location in the metadata.メタデータにバインディングプロトコルとマッピングする SAMLログイン URL情報が存在しない
        4009029There is no entityId in the metadata.メタデータにentityID情報が存在しない
        4009030There is no IdPSSODescriptor in the metadata.メタデータにIDPSSODescriptor情報が存在しない
        4009031メタデータに SingleSignOnServiceがありません。メタデータに SingleSignOnService情報が存在しない
        4009032There is no SingleSignOnService POST binding or Redirect binding in the metadata.メタデータに HTTP-POSTまたは HTTP-Redirect情報が存在しない
        4009033idpSigninUrl値が URL形式ではありません。idpSigninUrl値の形式エラー
        4009034There is no KeyInfo in the metadata.メタデータにKeyInfo情報が存在しない
        4009035Organizationのマスターアカウントではありません。マスターアカウントではないアカウントで Organization連携をリクエスト
        4009036Organizationが存在しません。マスターアカウントに Organizationが存在しない
        4009046Invalid certificate format.メタデータ署名用証明書形式エラー
        4009050This user doesn't exist.存在しない SSO User IDを入力
        4009060グループ名が既に存在します。既に使用されているグループ名を入力
        4009061This group doesn't exist.存在しないグループ IDを入力
        4009070Permission Set名が既に存在します。既に使用されている Permission Set名を入力
        4009071少なくとも一つの Policyを選択する必要があります。ポリシー IDが入力されていない
        4009072存在しないマネージドポリシーです。存在しないマネージドポリシー(System Managed) IDを入力
        4009073PermissionSetが存在しません。存在しない Permission Set IDを入力
        4009080Assignment does not exist.存在しない Assignment IDを入力
        4009081Assignment Targetが一致しない一致しない Assignment Targetを入力
        4009083Assignment Targetが存在しない存在しない Assignment Targetを入力
        4009084An assignment created with the specified account and permission set already exists.同じ情報で作成された Assignmentが既に存在
        4009085The assigned account is invalid.存在しないアカウント番号を入力
        4009086A target already exists in the assignment.既に追加済みのターゲット情報を入力
        4009087The Assignment name already exists.既に使用されている Assignment名を入力
        4009100The IP ACL does not exist.存在しない IP ACL IDを入力
        4009101IP ACL destination cannot be empty.Assignment IDが抜け落ちている
        4009102A target already exists in the assignment.既に追加済みの Assignment IDを入力
        4009103Assignment - remaining IP ACL mapping exists.IP ACLに Assignmentが追加されていて、削除できない
        4009104IP ACL destination does not match.存在しない Assignment - IP ACLマッピング情報を入力
        4009105Assignment - IP ACL mapping does not exist.既に存在する Assignment - IP ACLマッピング情報を入力
        4009106Invalid access restriction setting for Assignment.Assignmentアクセス制限がfalse
        4009110既に MFA Deviceが存在します。SSO Userに MFA Deviceが既に存在
        4009111無効な OTPです。有効ではない OTP情報を入力
        4009112存在しない MFA Deviceです。SSO Userに MFA Deviceが存在しない
        40091132段階認証は未適用状態です。2段階認証が適用されていない
        参考

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

        Ncloud Single Sign-On API

        Ncloud Single Sign-Onサービスが提供する APIの説明は次の通りです。

        Application

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

        API説明
        Applicationリストの照会Applicationリストを照会
        Applicationの照会Applicationの詳細を個別照会
        Applicationの作成Applicationを作成
        Applicationの更新Application情報を更新
        Applicationの削除Applicationを削除
        OAuth 2.0 Client Secretの再発行OAuth 2.0 Client Secretを再発行

        Tenant

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

        API説明
        Tenantの照会Tenantを照会
        Tenantの作成Tenantを作成
        Tenantの更新Tenant情報を更新
        Tenantの削除Tenantを削除

        External IdP

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

        API説明
        External IdPの照会External IdPを照会
        External IdPの作成External IdPを作成
        External IdPの更新External IdP情報を更新
        External IdPの削除External IdPを削除
        Attribute Mapperの照会Attribute Mapperを照会
        Attribute Mapperの変更Attribute Mapperを変更
        External IdPメタデータのパースExternal IdPメタデータをパース
        Ncloud Single Sign-Onメタデータの照会Ncloud Single Sign-Onメタデータを照会
        Ncloud Single Sign-On URLデータの照会Ncloud Single Sign-On URLデータを照会
        External IdPログインの設定External IdPログイン情報を設定
        Organization連携の設定Organization連携

        SSO User

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

        API説明
        SSO Userリストの照会SSO Userリストを照会
        SSO Userの照会SSO Userの詳細を個別照会
        SSO Userの作成SSO Userを個別作成
        SSO Userの一括作成1つ以上の Userを一括作成
        SSO Userの更新SSO User情報を更新
        SSO Userの一括削除1つ以上の Userを一括削除
        SSO Userの削除SSO Userを削除
        SSO Userログイン IDのチェックSSO Userログイン IDの有効性と重複をチェック
        SSO Userアクセスルールの照会SSO Userアクセスルールを照会
        SSO Userアクセスルールの更新SSO Userアクセスルールを更新
        SSO User Profileの照会SSO User Profileを照会
        SSO Userグループリストの照会グループリストを照会
        SSO Userグループの照会グループの詳細を個別照会
        SSO Userをグループに追加SSO Userをグループに追加
        SSO Userをグループから削除SSO Userをグループから削除
        SSO User状態の設定SSO Userを有効化または無効化に設定
        SSO Userセッションの照会SSO Userセッションを照会
        SSO UserセッションのタイムアウトSSO Userセッションのタイムアウト
        SSO User Assignmentリストの照会SSO Userが属する Assignmentリストを照会
        SSO Userを Assignmentから削除SSO Userを Assignmentから削除
        SSO User MFA Deviceリストの照会SSO Userが所有する MFA Deviceを照会
        SSO Userに MFA Deviceを追加SSO Userに MFA Deviceを追加
        SSO User MFA Deviceの削除SSO Userが所有する MFA Deviceを削除

        Group

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

        API説明
        グループリストの照会グループリストを照会
        グループの照会グループの詳細を個別照会
        グループの作成グループを作成
        グループの更新グループ情報を更新
        グループリストの削除1つ以上のグループを一括削除
        グループの削除グループを削除
        グループ名のチェックグループ名の有効性と重複をチェック
        グループの SSO Userリストの照会グループに属する SSO Userリストを照会
        グループに SSO Userを追加グループを SSO Userに追加
        グループを SSO Userから削除グループを SSO Userから削除
        グループ Assignmentリストの照会グループが属する Assignmentリストを照会
        グループを Assignmentから削除グループを Assignmentから削除

        Permission Set

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

        API説明
        Permission Setリストの照会Permission Setリストを照会
        Permission Setの照会Permission Setの詳細を個別照会
        Permission Setの作成Permission Setを作成
        Permission Setの更新Permission Set情報を更新
        Permission Setリストの削除1つ以上の Permission Setを一括削除
        Permission Setの削除Permission Setを削除
        Permission Set名のチェックPermission Set名の有効性と重複をチェック
        Permission Setポリシーの削除Permission Setに割り当てられたポリシーを削除
        マネージドポリシーリストの照会Permission Setに割り当て可能なマネージドポリシー(System Managed)リストを照会
        ユーザー定義ポリシーの存在有無の確認Permission Setにユーザー定義ポリシー(User Created)が存在するかどうかを確認

        Assignment

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

        API説明
        Assignmentリストの照会Assignmentリストを照会
        Assignmentの照会Assignmentの詳細を個別照会
        Assignmentの作成Assignmentを作成
        Assignmentの更新Assignment情報を更新
        Assignmentの削除Assignmentを削除
        Assignment状態の設定Assignmentを有効化または無効化に設定
        Assignmentターゲットリストの照会Assignmentに追加されたターゲット(SSO User、グループ)リストを照会
        Assignmentにターゲットを追加Assignmentにターゲット(SSO User、グループ)を追加
        Assignmentからターゲットを削除Assignmentからターゲット(SSO User、グループ)を削除
        Assignment IP ACLリストの照会Assignmentに追加された IP ACLリストを照会
        Assignmentに IP ACLを追加Assignmentに IP ACLを追加
        Assignmentから IP ACLを削除Assignmentに追加された IP ACLを削除
        Assignmentアカウントリストの照会Organizationに追加されたアカウントリストを照会
        ユーザー定義ポリシーの存在有無の確認対象アカウントにユーザー定義ポリシー(User Created)が存在するかどうか確認

        IP ACL

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

        API説明
        IP ACLリストの照会IP ACLリストを照会
        IP ACLの照会IP ACLの詳細を個別照会
        IP ACLの作成IP ACLを作成
        IP ACLの更新IP ACL情報を更新
        IP ACLリストの削除1つ以上の IP ACLを一括削除
        IP ACLの削除IP ACLを削除
        IP ACL名のチェックIP ACL名の有効性と重複をチェック
        IP ACLの Asssignmentリストの照会IP ACLに追加された Assignmentリストを照会
        IP ACLに Assignmentを追加IP ACLに Assignmentを追加
        IP ACLから Assignmentを削除IP ACLから Assignmentを削除

        Ncloud Single Sign-On関連リソース

        Ncloud Single Sign-On 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.