Attribute Mapperの照会

印刷する
共有
Twitter
Linkedin
Facebook
Email
PDF

記事の要約

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

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

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

Attribute Mapperを照会します。

参考

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

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

リクエスト

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

メソッド	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}'

レスポンス

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

レスポンスボディ

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

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

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

リクエスト
- リクエストヘッダ
- リクエスト例
レスポンス