最新のコンテンツが反映されていません。早急にアップデート内容をご提供できるよう努めております。最新のコンテンツ内容は韓国語ページをご参照ください。
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
リクエストヘッダ
リクエストヘッダの説明は次の通りです。
| フィールド | 必須の有無 | 説明 |
|---|---|---|
x-ncp-apigw-timestamp |
Required | 1970年1月1日00:00:00協定世界時(UTC)からの経過時間(ミリ秒)
|
x-ncp-iam-access-key |
Required | NAVERクラウドプラットフォームから発行された Access Key
|
x-ncp-apigw-signature-v2 |
Required | NAVERクラウドプラットフォームから発行された Access Keyとマッピングする Secret Keyと HMAC暗号化アルゴリズム(HmacSHA256)でリクエスト情報を暗号化した後、Base64にエンコードした署名 |
Content-type |
Optional | リクエストデータの形式
|
Accept |
Optional | レスポンスデータの形式
|
レスポンス
共通レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
ProcessResult
ProcessResultは API処理結果を定義します。ProcessResultの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
success |
Boolean | Required | API処理結果
|
id |
String | Optional | 作成/更新結果 ID
|
message |
String | Optional | API処理結果メッセージ |
ErrorResponse
ErrorResponseは API呼び出し失敗情報を定義します。ErrorResponseの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
| errorCode | Integer | Required | エラーコード |
| message | String | Required | エラーメッセージ |
レスポンスステータスコード
レスポンスステータスコードの説明は次の通りです。
| HTTPステータスコード | コード | メッセージ | 説明 |
|---|---|---|---|
| 400 | 400 | ユーザーはこのグループに属していません。 | グループに属していないユーザーを入力 |
| 400 | 400 | Permission Setが存在しません。 | Permission Setが存在しない |
| 400 | 400 | 既に存在する Application名です。 | 既に存在する Application名を入力 |
| 400 | 400 | Tenant already exists | 既に Tenantが存在 |
| 400 | 400 | 既に使用されている Login IDです。 | 既に使用されているログイン IDを入力 |
| 400 | 500 | Policyが存在しません。 | 存在しないポリシー名を入力 |
| 400 | 9016 | 存在しない Applicationです。 | 存在しない Application IDを入力 |
| 400 | 9020 | There is a registered identity provider. | External IdPが既に存在 |
| 400 | 9021 | This identify provider doesn't exist. | External IdPが存在しない |
| 400 | 9023 | Organizationが連携されている状態では Identity Providerを削除できません。 | Organizationが連携されている状態の場合、Identity Providerは削除不可 |
| 400 | 9024 | Invalid metadata format. | メタデータ形式エラー |
| 400 | 9025 | There is no certificate information for signing in the metadata. | メタデータに署名用の証明書情報が存在しない |
| 400 | 9026 | There are two or more certificates for signing in the metadata. | メタデータに署名用証明書が2つ以上存在 |
| 400 | 9027 | There is no SingleSignOnService binding in the metadata. | メタデータにプロトコルバインディング情報が存在しない |
| 400 | 9028 | There is no SingleSignOnService location in the metadata. | メタデータにバインディングプロトコルとマッピングする SAMLログイン URL情報が存在しない |
| 400 | 9029 | There is no entityId in the metadata. | メタデータにentityID情報が存在しない |
| 400 | 9030 | There is no IdPSSODescriptor in the metadata. | メタデータにIDPSSODescriptor情報が存在しない |
| 400 | 9031 | メタデータに SingleSignOnServiceがありません。 | メタデータに SingleSignOnService情報が存在しない |
| 400 | 9032 | There is no SingleSignOnService POST binding or Redirect binding in the metadata. | メタデータに HTTP-POSTまたは HTTP-Redirect情報が存在しない |
| 400 | 9033 | idpSigninUrl値が URL形式ではありません。 | idpSigninUrl値の形式エラー |
| 400 | 9034 | There is no KeyInfo in the metadata. | メタデータにKeyInfo情報が存在しない |
| 400 | 9035 | Organizationのマスターアカウントではありません。 | マスターアカウントではないアカウントで Organization連携をリクエスト |
| 400 | 9036 | Organizationが存在しません。 | マスターアカウントに Organizationが存在しない |
| 400 | 9046 | Invalid certificate format. | メタデータ署名用証明書形式エラー |
| 400 | 9050 | This user doesn't exist. | 存在しない SSO User IDを入力 |
| 400 | 9060 | グループ名が既に存在します。 | 既に使用されているグループ名を入力 |
| 400 | 9061 | This group doesn't exist. | 存在しないグループ IDを入力 |
| 400 | 9070 | Permission Set名が既に存在します。 | 既に使用されている Permission Set名を入力 |
| 400 | 9071 | 少なくとも一つの Policyを選択する必要があります。 | ポリシー IDが入力されていない |
| 400 | 9072 | 存在しないマネージドポリシーです。 | 存在しないマネージドポリシー(System Managed) IDを入力 |
| 400 | 9073 | PermissionSetが存在しません。 | 存在しない Permission Set IDを入力 |
| 400 | 9080 | Assignment does not exist. | 存在しない Assignment IDを入力 |
| 400 | 9081 | Assignment Targetが一致しない | 一致しない Assignment Targetを入力 |
| 400 | 9083 | Assignment Targetが存在しない | 存在しない Assignment Targetを入力 |
| 400 | 9084 | An assignment created with the specified account and permission set already exists. | 同じ情報で作成された Assignmentが既に存在 |
| 400 | 9085 | The assigned account is invalid. | 存在しないアカウント番号を入力 |
| 400 | 9086 | A target already exists in the assignment. | 既に追加済みのターゲット情報を入力 |
| 400 | 9087 | The Assignment name already exists. | 既に使用されている Assignment名を入力 |
| 400 | 9100 | The IP ACL does not exist. | 存在しない IP ACL IDを入力 |
| 400 | 9101 | IP ACL destination cannot be empty. | Assignment IDが抜け落ちている |
| 400 | 9102 | A target already exists in the assignment. | 既に追加済みの Assignment IDを入力 |
| 400 | 9103 | Assignment - remaining IP ACL mapping exists. | IP ACLに Assignmentが追加されていて、削除できない |
| 400 | 9104 | IP ACL destination does not match. | 存在しない Assignment - IP ACLマッピング情報を入力 |
| 400 | 9105 | Assignment - IP ACL mapping does not exist. | 既に存在する Assignment - IP ACLマッピング情報を入力 |
| 400 | 9106 | Invalid access restriction setting for Assignment. | Assignmentアクセス制限がfalse |
| 400 | 9110 | 既に MFA Deviceが存在します。 | SSO Userに MFA Deviceが既に存在 |
| 400 | 9111 | 無効な OTPです。 | 有効ではない OTP情報を入力 |
| 400 | 9112 | 存在しない MFA Deviceです。 | SSO Userに MFA Deviceが存在しない |
| 400 | 9113 | 2段階認証は未適用状態です。 | 2段階認証が適用されていない |
NAVERクラウドプラットフォームで共通して使用されるレスポンスステータスコードの詳細は、Ncloud APIのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
成功
呼び出しに成功した場合のレスポンスのサンプルコードは次の通りです。
- ProcessResult
{
"id": "",
"success": true
}
失敗
呼び出しに失敗した場合のレスポンスのサンプルコードは次の通りです。
{
"errorCode": 9060,
"message": "グループ名が既に存在します。"
}
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についてユーザーの理解に役立つよう、さまざまな関連リソースを提供しています。
- Ncloud Single Sign-On APIの使用方法
- 署名(シグネチャー)の作成: リクエストヘッダに追加する署名の作成方法
- API Gatewayご利用ガイド: リクエストヘッダに追加する API Keyを発行
- Sub Accountご利用ガイド: リクエストヘッダに追加する Access Keyの発行方法
- Ncloudの共通レスポンスステータスコード: Ncloud Single Sign-Onサービスで使用される NAVERクラウドプラットフォームの共通レスポンスステータスコード情報
- Ncloud Single Sign-Onサービスの使用方法
- Ncloud Single Sign-Onご利用ガイド: NAVERクラウドプラットフォームコンソールで Ncloud Single Sign-Onを使用する方法
- Ncloud使用環境ガイド: VPC、Classic環境とサポート有無に関するガイド
- 料金の紹介、特徴、詳細機能: Ncloud Single Sign-Onの料金の紹介、特徴、詳細機能のサマリー
- サービスのお知らせ: Ncloud Single Sign-Onサービスに関するお知らせ
- よくある質問: Ncloud Single Sign-Onサービスに関するよくあるご質問
- お問い合わせ: APIガイドだけでは不明な点が解消されない場合、直接お問い合わせ