Attribute Mapperの照会
    • PDF

    Attribute Mapperの照会

    • PDF

    記事の要約

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

    Attribute Mapperを照会します。

    参考

    Ncloud Single Sign-Onサービスのユーザー属性情報と AWS、OneLoginなどの他のサービスで設定したユーザー属性情報を連携する方法は、Ncloud Single Sign-Onご利用ガイドをご参照ください。

    リクエスト

    リクエスト形式を説明します。リクエスト形式は次の通りです。

    メソッドURI
    GET/api/v1/tenant/saml-idp/profile-mapping

    リクエストヘッダ

    Ncloud Single Sign-On APIで共通して使用されるヘッダの詳細は、Ncloud Single Sign-Onのリクエストヘッダをご参照ください。

    リクエスト例

    リクエストのサンプルコードは次の通りです。

    curl --location --request GET 'https://sso.apigw.ntruss.com/api/v1/tenant/saml-idp/profile-mapping' \
    --header 'x-ncp-apigw-timestamp: {Timestamp}' \
    --header 'x-ncp-iam-access-key: {Access Key}' \
    --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
    

    レスポンス

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

    レスポンスボディ

    レスポンスボディの説明は次の通りです。

    フィールドタイプ必須の有無説明
    firstNameObject-名(下の名前)情報
    firstName.displayNameString-NAVERクラウドプラットフォームの Ncloud Single Sign-On > Tenant メニューのユーザー Profile管理画面に表示されるユーザー Profile名
    firstName.syncModeString-属性情報更新ポリシー
    • none | import | force
      • none: 更新しない
      • import: 初回ログイン時のみ更新
      • force: ログインするたびに更新
    firstName.idpValueString-NAVERクラウドプラットフォームの Single Sign-Onサービスに渡す属性(AttributeName)
    • 渡す属性がない場合、空の文字列""に設定
    lastNameObject-姓(苗字)情報
    lastName.displayNameString-NAVERクラウドプラットフォームの Ncloud Single Sign-On > Tenant メニューのユーザー Profile管理画面に表示されるユーザー Profile名
    lastName.syncModeString-属性情報更新ポリシー
    • none | import | force
      • none: 更新しない
      • import: 初回ログイン時のみ更新
      • force: ログインするたびに更新
    lastName.idpValueString-NAVERクラウドプラットフォームの Single Sign-Onサービスに渡す属性(AttributeName)
    • 渡す属性がない場合、空の文字列""に設定
    emailObject-メール情報
    email.displayNameString-NAVERクラウドプラットフォームの Ncloud Single Sign-On > Tenant メニューのユーザー Profile管理画面に表示されるユーザー Profile名
    email.syncModeString-属性情報更新ポリシー
    • none | import | force
      • none: 更新しない
      • import: 初回ログイン時のみ更新
      • force: ログインするたびに更新
    email.idpValueString-NAVERクラウドプラットフォームの Single Sign-Onサービスに渡す属性(AttributeName)
    • 渡す属性がない場合、空の文字列""に設定
    emailVerifiedObject-メール認証情報
    emailVerified.displayNameString-NAVERクラウドプラットフォームの Ncloud Single Sign-On > Tenant メニューのユーザー Profile管理画面に表示されるユーザー Profile名
    emailVerified.syncModeString-属性情報更新ポリシー
    • none | import | force
      • none: 更新しない
      • import: 初回ログイン時のみ更新
      • force: ログインするたびに更新
    emailVerified.idpValueString-NAVERクラウドプラットフォームの Single Sign-Onサービスに渡す属性(AttributeName)
    • 渡す属性がない場合、空の文字列""に設定
    empNoObject-社員番号情報
    empNo.displayNameString-NAVERクラウドプラットフォームの Ncloud Single Sign-On > Tenant メニューのユーザー Profile管理画面に表示されるユーザー Profile名
    empNo.syncModeString-属性情報更新ポリシー
    • none | import | force
      • none: 更新しない
      • import: 初回ログイン時のみ更新
      • force: ログインするたびに更新
    empNo.idpValueString-NAVERクラウドプラットフォームの Single Sign-Onサービスに渡す属性(AttributeName)
    • 渡す属性がない場合、空の文字列""に設定
    phoneNoObject-携帯電話番号情報
    phoneNo.displayNameString-NAVERクラウドプラットフォームの Ncloud Single Sign-On > Tenant メニューのユーザー Profile管理画面に表示されるユーザー Profile名
    phoneNo.syncModeString-属性情報更新ポリシー
    • none | import | force
      • none: 更新しない
      • import: 初回ログイン時のみ更新
      • force: ログインするたびに更新
    phoneNo.idpValueString-NAVERクラウドプラットフォームの Single Sign-Onサービスに渡す属性(AttributeName)
    • 渡す属性がない場合、空の文字列""に設定
    phoneNoVerifiedObject-携帯電話番号認証情報
    phoneNoVerified.displayNameString-NAVERクラウドプラットフォームの Ncloud Single Sign-On > Tenant メニューのユーザー Profile管理画面に表示されるユーザー Profile名
    phoneNoVerified.syncModeString-属性情報更新ポリシー
    • none | import | force
      • none: 更新しない
      • import: 初回ログイン時のみ更新
      • force: ログインするたびに更新
    phoneNoVerified.idpValueString-NAVERクラウドプラットフォームの Single Sign-Onサービスに渡す属性(AttributeName)
    • 渡す属性がない場合、空の文字列""に設定
    phoneCountryCodeObject-国番号情報
    phoneCountryCode.displayNameString-NAVERクラウドプラットフォームの Ncloud Single Sign-On > Tenant メニューのユーザー Profile管理画面に表示されるユーザー Profile名
    phoneCountryCode.syncModeString-属性情報更新ポリシー
    • none | import | force
      • none: 更新しない
      • import: 初回ログイン時のみ更新
      • force: ログインするたびに更新
    phoneCountryCode.idpValueString-NAVERクラウドプラットフォームの Single Sign-Onサービスに渡す属性(AttributeName)
    • 渡す属性がない場合、空の文字列""に設定
    deptNameObject-部署情報
    deptName.displayNameString-NAVERクラウドプラットフォームの Ncloud Single Sign-On > Tenant メニューのユーザー Profile管理画面に表示されるユーザー Profile名
    deptName.syncModeString-属性情報更新ポリシー
    • none | import | force
      • none: 更新しない
      • import: 初回ログイン時のみ更新
      • force: ログインするたびに更新
    deptName.idpValueString-NAVERクラウドプラットフォームの Single Sign-Onサービスに渡す属性(AttributeName)
    • 渡す属性がない場合、空の文字列""に設定

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

    Ncloud Single Sign-On APIで共通して使用されるレスポンスステータスコードの詳細は、Ncloud Single Sign-Onのレスポンスステータスコードをご参照ください。

    レスポンス例

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

    {
        "firstName": {
            "displayName": "First Name",
            "syncMode": "import",
            "idpValue": "${user:givenName}"
        },
        "lastName": {
            "displayName": "Last Name",
            "syncMode": "import",
            "idpValue": "${user:familyName}"
        },
        "email": {
            "displayName": "Email",
            "syncMode": "import",
            "idpValue": "${user:email}"
        },
        "emailVerified": {
            "displayName": "Email Verified",
            "syncMode": "import",
            "idpValue": ""
        },
        "empNo": {
            "displayName": "Employee Number",
            "syncMode": "import",
            "idpValue": ""
        },
        "phoneNo": {
            "displayName": "Phone Number",
            "syncMode": "import",
            "idpValue": ""
        },
        "phoneNoVerified": {
            "displayName": "Phone Number Verified",
            "syncMode": "import",
            "idpValue": ""
        },
        "phoneCountryCode": {
            "displayName": "Phone Country Code",
            "syncMode": "import",
            "idpValue": ""
        },
        "deptName": {
            "displayName": "Department",
            "syncMode": "import",
            "idpValue": ""
        }
    }
    

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

    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.