Ncloud Single Sign-On の概要
    • 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説明
    getApplicationsApplicationリストを照会
    getApplicationApplicationを個別照会
    postApplicationApplication作成
    putApplicationApplicationを変更
    deleteApplicationApplicationアンインストール
    renewalClientSecret(Oauth2) Client Secretを再作成

    Tenant

    Tenantに関連した APIリストは、次の通りです。

    API説明
    getTenantTenantを照会
    postTenantTenant作成
    putTenantTenant変更
    deleteTenantTenant削除

    External IDP

    External IDPに関連した APIリストは、次の通りです。

    API説明
    postExternalIdPExternal IDPを登録
    getExternalIdPExternal IDPを照会
    deleteExternalIdPExternal IDPを削除
    putExternalIdPExternal IDPを変更
    modifyAttributeMapperAttributeMapperを変更
    getAttributeMapperAttributeMapperを照会
    parseExternalIdpMetadataExternal IDPメタデータをパース
    getSpMetadataNcloud Single Sign-Onメタデータを照会
    getSpUrldataNcloud Single Sign-On URLデータを照会
    putLoginSettingExternal IDPのログイン情報設定
    postOrganizationOrganization連携

    User

    Userに関連した APIリストは、次の通りです。

    API説明
    validateUserLoginIdUser Login IDの有効性検証
    postUserUserを個別作成
    postUsersUserを一括作成
    putUserUserを変更
    deleteUserUserを削除
    deleteUsersUserリストを削除
    getUserUserを個別照会
    getUsersUserリストを照会
    getUserAccessRuleUser AccessRuleを照会
    putUserAccessRuleUser AccessRuleを変更
    getUserProfileUser Profileを照会
    postUserToGroupUserを Groupに追加
    getUserGroupsUserが属する Groupリストを照会
    getUserGroupUserが属する Groupを個別照会
    deleteUserFromGroupUserを Groupから削除
    changeUserStatusUser状態を変更
    getUserSessionUserセッションを照会
    expireUserSessionUserセッションが有効期限切れ
    getUserAssignmentsUserが属する Assignmentリストを照会
    deleteUserFromAssignmentUserを Assignmentから削除

    Group

    Groupに関連した APIリストは、次の通りです。

    API説明
    validateGroupNameGroup名の有効性検証
    postGroupGroupを作成
    getGroupsGroupリストを照会
    getUserGroupを個別照会
    putGroupGroupを変更
    deleteGroupGroupを削除
    deleteGroupsGroupリストを削除
    postGroupToUserGroupを Userに追加
    getGroupUsersGroupに属する Userリストを照会
    getGroupAssignmentGroupが属する Assignmentリストを照会
    deleteGroupFromUserGroupを Userから削除
    deleteGroupFromAssignmentGroupを Assignmentから削除

    PermissionSet

    PermissionSetに関連した APIリストは、次の通りです。

    API説明
    postPermissionSetPermissionSetを作成
    getPermissionSetsPermissionSetリストを照会
    getPermissionSetPermissionSetを個別照会
    putPermissionSetPermissionSetを変更
    deletePermissionSetPermissionSetを削除
    deletePermissionSetsPermissionSetリストを削除
    getPoliciesPermission Setに割り当てできる Policyリストを照会
    existsPolicyPermissionSet内の Policy存在有無を確認
    deletePolicyFromPermissionSetPermissionSet内の Policyを削除
    validatePermissionSetNamePermissionSetの名前パターン、重複チェック

    Assignment

    Assignmentに関連した APIリストは、次の通りです。

    API説明
    postAssignmentAssignment作成
    getAssignmentsAssignmentリストを照会
    getAssignmentAssignmentを個別照会
    putAssignmentAssignment変更
    changeAssignmentStatusAssignment状態を変更
    deleteAssignmentAssignment削除
    getAssignmentTargetsAssignment Targetリストを照会
    postAssignmentTargetsAssignment Targetを Assignmentに追加
    deleteAssignmentTargetsAssignment Targetを削除
    getAssignmentExistsPolicyAssignment内の対象 Policyの存在有無を確認
    getAssignmentByTargetTypeTargetTypeと一致する Assignmentリストを照会
    getAccountsAccountリストを照会

    IP ACL

    IP ACLに関連した APIリストは、次の通りです。

    API説明
    validateIpAclNameIP ACL名の有効性検証
    postIPACLIP ACL作成
    putIPACLIP ACL変更
    deleteIPACLsIP ACLリスト削除
    deleteIPACLIP ACLを個別削除
    getIPACLsIP ACLリストを照会
    getIPACLIP ACLを個別照会
    addIpAclToAssignmentsIP ACLに Assignmentを追加
    getIpAclAssignmentsIP ACLが含まれた Assignmentを照会
    deleteIpAclAssignmentsIP ACLに割り当てられた Assignmentを削除

    共通設定

    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-keyNAVERクラウドプラットフォームから発行された API Keyまたは IAMから発行された AccessKeyNcloud API共通ヘッダ
    x-ncp-apigw-signature-v2- 上記ユースケースの Bodyを AccessKeyとマッピングする SecretKeyで暗号化した署名
    - HMAC暗号化アルゴリズムは HmacSHA256を使用
    Ncloud API共通ヘッダ

    共通モデル

    ProcessResult

    パラメータ名必須有無タイプ説明
    successYBoolean処理結果
    idNString作成/変更結果 ID
    messageNString処理結果メッセージ
    • model
    ProcessResult {
      Boolean success;
      String id;
      String message;
    }
    
    • json
    {
      "id": "",
      "success": true
    }
    

    エラーコード

    Ncloud Single Sign-On APIで共通して使用するエラーコードを紹介します。サービス全体で共通して使用するエラーコードについての詳細は、NAVER Cloud Platform APIをご参照ください。

    パラメータ名必須有無タイプ説明
    errorCodeYintエラーコード
    messageYStringエラーメッセージ

    Ncloud Single Sign-On APIの共通エラーコード構文の例は、次の通りです。

    • model
    ErrorResponse {
      int errorCode;
      String message;
    }
    
    • json
    {
      "errorCode": 9011,
      "message": "エラーメッセージ"
    }
    

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

    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.