- 印刷する
- PDF
Ncloud Single Sign-On の概要
- 印刷する
- PDF
Classic/VPC環境で利用できます。
Application/Tenant/External IDP/User/Group/Permission Set/Assignment情報を管理できる APIを提供します。
APIは RESTful API形式であり、HTTP GET/POST/PUT/DELETEメソッドを使用します。
オペレーション
Ncloud Single Sign-Onは、Application、Tenant、External IDP、User、Group、PermissionSet、Assignmentオペレーションを提供します。
Application
Applicationに関連した APIリストは、次の通りです。
API | 説明 |
---|---|
getApplications | Applicationリストを照会 |
getApplication | Applicationを個別照会 |
postApplication | Application作成 |
putApplication | Application変更 |
deleteApplication | Applicationアンインストール |
renewalClientSecret | (Oauth2) Client Secretを再作成 |
Tenant
Tenantに関連した APIリストは、次の通りです。
API | 説明 |
---|---|
getTenant | Tenantを照会 |
postTenant | Tenantを作成 |
putTenant | Tenantを変更 |
deleteTenant | Tenantを削除 |
External IDP
External IDPに関連した APIリストは、次の通りです。
API | 説明 |
---|---|
postExternalIdP | External IDPを登録 |
getExternalIdP | External IDPを照会 |
deleteExternalIdP | External IDPを削除 |
putExternalIdP | External IDPを変更 |
modifyAttributeMapper | AttributeMapperを変更 |
getAttributeMapper | AttributeMapperを照会 |
parseExternalIdpMetadata | External IDPメタデータをパース |
getSpMetadata | Ncloud Single Sign-Onメタデータを照会 |
getSpUrldata | Ncloud Single Sign-On URLデータを照会 |
putLoginSetting | External IDPのログイン情報設定 |
postOrganization | Organization連携 |
User
Userに関連した APIリストは、次の通りです。
API | 説明 |
---|---|
postUser | Userを個別作成 |
postUsers | Userを一括作成 |
putUser | Userを変更 |
deleteUser | Userを削除 |
deleteUsers | Userリストを削除 |
getUser | Userを個別照会 |
getUsers | Userリストを照会 |
getUserAccessRule | User AccessRuleを照会 |
putUserAccessRule | User AccessRuleを変更 |
getUserProfile | User Profileを照会 |
postUserToGroup | Userを Groupに追加 |
getUserGroups | Userが属する Groupリストを照会 |
getUserGroup | Userが属する Groupを個別照会 |
deleteUserFromGroup | Userを Groupから削除 |
changeUserStatus | User状態を変更 |
getUserSession | Userセッションを照会 |
expireUserSession | Userセッションが有効期限切れ |
getUserAssignments | Userが属する Assignmentリストを照会 |
deleteUserFromAssignment | Userを Assignmentから削除 |
Group
Groupに関連した APIリストは、次の通りです。
API | 説明 |
---|---|
postGroup | Groupを作成 |
getGroups | Groupリストを照会 |
getUser | Groupを個別照会 |
putGroup | Groupを変更 |
deleteGroup | Groupを削除 |
deleteGroups | Groupリストを削除 |
postGroupToUser | Groupを Userに追加 |
getGroupUsers | Groupに属する Userリストを照会 |
getGroupAssignment | Groupが属する Assignmentリストを照会 |
deleteGroupFromUser | Groupを Userから削除 |
deleteGroupFromAssignment | Groupを Assignmentから削除 |
PermissionSet
PermissionSetに関連した APIリストは、次の通りです。
API | 説明 |
---|---|
postPermissionSet | PermissionSetを作成 |
getPermissionSets | PermissionSetリストを照会 |
getPermissionSet | PermissionSetを個別照会 |
putPermissionSet | PermissionSetを変更 |
deletePermissionSet | PermissionSetを削除 |
deletePermissionSets | PermissionSetリストを削除 |
getPolicies | Permission Setに割り当てできる Policyリストを照会 |
existsPolicy | PermissionSet内の Policy存在有無を確認 |
deletePolicyFromPermissionSet | PermissionSet内の Policyを削除 |
validatePermissionSetName | PermissionSetの名前パターン、重複チェック |
Assignment
Assignmentに関連した APIリストは、次の通りです。
API | 説明 |
---|---|
postAssignment | Assignmentを作成 |
getAssignments | Assignmentリストを照会 |
getAssignment | Assignmentを個別照会 |
putAssignment | Assignmentを変更 |
changeAssignmentStatus | Assignment状態を変更 |
deleteAssignment | Assignmentを削除 |
getAssignmentTargets | Assignment Targetリストを照会 |
postAssignmentTargets | Assignment Targetを Assignmentに追加 |
deleteAssignmentTargets | Assignment Targetを削除 |
getAssignmentExistsPolicy | Assignment内の対象 Policyの存在有無を確認 |
getAssignmentByTargetType | TargetTypeと一致する Assignmentリストを照会 |
getAccounts | Accountリストを照会 |
共通設定
API URL
API URLは次の通りです。
https://sso.apigw.ntruss.com/api/v1
メソッド
使用可能なメソッドは、次の通りです。
GET, POST, PUT, DELETE
ヘッダ
リクエストヘッダ
共通して使用するリクエストヘッダをご案内します。一部のリクエストヘッダの場合、Ncloud API共通ヘッダであるため、詳細は Ncloud API共通ヘッダをご参照ください。リクエストヘッダについての説明は、次の通りです。
ヘッダ | 説明 | 種類 |
---|---|---|
x-ncp-apigw-timestamp | - 1970年1月1日00:00:00協定世界時(UTC)からの経過時間をミリ秒(Millisecond)で表したもの - API Gatewayサーバとの時間差が5分以上の場合は無効なリクエストとみなす | Ncloud API共通ヘッダ |
x-ncp-iam-access-key | NAVERクラウドプラットフォームから発行された API Keyまたは IAMから発行された AccessKey | Ncloud API共通ヘッダ |
x-ncp-apigw-signature-v2 | - 上記ユースケースの Bodyを AccessKeyとマッピングする SecretKeyで暗号化した署名 - HMAC暗号化アルゴリズムは HmacSHA256を使用 | Ncloud API共通ヘッダ |
共通モデル
ProcessResult
パラメータ名 | 必須有無 | タイプ | 説明 |
---|---|---|---|
success | Y | Boolean | 処理結果 |
id | N | String | 作成/変更結果 ID |
message | N | String | 処理結果メッセージ |
- model
ProcessResult {
Boolean success;
String id;
String message;
}
- json
{
"id": "",
"success": true
}
エラーコード
Ncloud Single Sign-On APIで共通して使用するエラーコードを紹介します。サービス全体で共通して使用するエラーコードについての詳細は、NAVER Cloud Platform APIをご参照ください。
パラメータ名 | 必須有無 | タイプ | 説明 |
---|---|---|---|
errorCode | Y | int | エラーコード |
message | Y | String | エラーメッセージ |
Ncloud Single Sign-On APIの共通エラーコード構文の例は、次の通りです。
- model
ErrorResponse {
int errorCode;
String message;
}
- json
{
"errorCode": 9011,
"message": "エラーメッセージ"
}