Attribute Mapperの変更

印刷する
共有
PDF

記事の要約

この要約は役に立ちましたか?

ご意見ありがとうございます

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

Attribute Mapperを変更します。

参考

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

ユーザー Profileの管理
サービス別 Attribute Mapperの設定方法

リクエスト

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

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

リクエストヘッダ

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

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`firstName`	Object	Required	名(下の名前)情報
`firstName.syncMode`	String	Required	属性情報更新ポリシー `none` \| `import` \| `force` `none`: 更新しない `import`: 初回ログイン時のみ更新 `force`: ログインするたびに更新
`firstName.idpValue`	String	Required	NAVERクラウドプラットフォームの Single Sign-Onサービスに渡す属性(AttributeName) 0~200文字渡す属性がない場合、空の文字列`""`に設定
`lastName`	Object	Required	姓(苗字)情報
`lastName.syncMode`	String	Required	属性情報更新ポリシー `none` \| `import` \| `force` `none`: 更新しない `import`: 初回ログイン時のみ更新 `force`: ログインするたびに更新
`lastName.idpValue`	String	Required	NAVERクラウドプラットフォームの Single Sign-Onサービスに渡す属性(AttributeName) 0~200文字渡す属性がない場合、空の文字列`""`に設定
`email`	Object	Required	メール情報
`email.syncMode`	String	Required	属性情報更新ポリシー `none` \| `import` \| `force` `none`: 更新しない `import`: 初回ログイン時のみ更新 `force`: ログインするたびに更新
`email.idpValue`	String	Required	NAVERクラウドプラットフォームの Single Sign-Onサービスに渡す属性(AttributeName) 0~200文字渡す属性がない場合、空の文字列`""`に設定
`emailVerified`	Object	Required	メール認証情報
`emailVerified.syncMode`	String	Required	属性情報更新ポリシー `none` \| `import` \| `force` `none`: 更新しない `import`: 初回ログイン時のみ更新 `force`: ログインするたびに更新
`emailVerified.idpValue`	String	Required	NAVERクラウドプラットフォームの Single Sign-Onサービスに渡す属性(AttributeName) 0~200文字渡す属性がない場合、空の文字列`""`に設定
`empNo`	Object	Required	社員番号情報
`empNo.syncMode`	String	Required	属性情報更新ポリシー `none` \| `import` \| `force` `none`: 更新しない `import`: 初回ログイン時のみ更新 `force`: ログインするたびに更新
`empNo.idpValue`	String	Required	NAVERクラウドプラットフォームの Single Sign-Onサービスに渡す属性(AttributeName) 0~200文字渡す属性がない場合、空の文字列`""`に設定
`phoneNo`	Object	Required	携帯電話番号情報
`phoneNo.syncMode`	String	Required	属性情報更新ポリシー `none` \| `import` \| `force` `none`: 更新しない `import`: 初回ログイン時のみ更新 `force`: ログインするたびに更新
`phoneNo.idpValue`	String	Required	NAVERクラウドプラットフォームの Single Sign-Onサービスに渡す属性(AttributeName) 0~200文字渡す属性がない場合、空の文字列`""`に設定
`phoneNoVerified`	Object	Required	携帯電話番号認証情報
`phoneNoVerified.syncMode`	String	Required	属性情報更新ポリシー `none` \| `import` \| `force` `none`: 更新しない `import`: 初回ログイン時のみ更新 `force`: ログインするたびに更新
`phoneNoVerified.idpValue`	String	Required	NAVERクラウドプラットフォームの Single Sign-Onサービスに渡す属性(AttributeName) 0~200文字渡す属性がない場合、空の文字列`""`に設定
`phoneCountryCode`	Object	Required	国番号情報
`phoneCountryCode.syncMode`	String	Required	属性情報更新ポリシー `none` \| `import` \| `force` `none`: 更新しない `import`: 初回ログイン時のみ更新 `force`: ログインするたびに更新
`phoneCountryCode.idpValue`	String	Required	NAVERクラウドプラットフォームの Single Sign-Onサービスに渡す属性(AttributeName) 0~200文字渡す属性がない場合、空の文字列`""`に設定
`deptName`	Object	Required	部署情報
`deptName.syncMode`	String	Required	属性情報更新ポリシー `none` \| `import` \| `force` `none`: 更新しない `import`: 初回ログイン時のみ更新 `force`: ログインするたびに更新
`deptName.idpValue`	String	Required	NAVERクラウドプラットフォームの Single Sign-Onサービスに渡す属性(AttributeName) 0~200文字渡す属性がない場合、空の文字列`""`に設定

リクエスト例

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

curl --location --request POST '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}' \
--data '{
    "firstName": {
        "syncMode": "force",
        "idpValue": "${user:givenName}"
    },
    "lastName": {
        "syncMode": "import",
        "idpValue": "${user:familyName}"
    },
    "email": {
        "syncMode": "import",
        "idpValue": "${user:email}"
    },
    "emailVerified": {
        "syncMode": "import",
        "idpValue": ""
    },
    "empNo": {
        "syncMode": "import",
        "idpValue": ""
    },
    "phoneNo": {
        "syncMode": "import",
        "idpValue": ""
    },
    "phoneNoVerified": {
        "syncMode": "import",
        "idpValue": ""
    },
    "phoneCountryCode": {
        "syncMode": "import",
        "idpValue": ""
    },
    "deptName": {
        "syncMode": "import",
        "idpValue": ""
    }
}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`success`	Boolean	-	API処理結果 `true` \| `false` `true`: 成功 `false`: 失敗
`message`	String	-	結果メッセージ `success`が`false`の場合、表示

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

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

レスポンス例

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

{
    "success": true
}

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

What's Next

External IdPメタデータのパース

リクエスト
レスポンス