SSO Userの作成

最新のコンテンツが反映されていません。早急にアップデート内容をご提供できるよう努めております。最新のコンテンツ内容は韓国語ページをご参照ください。

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

外部アカウントのユーザー情報に基づいて SSO Userを作成します。SSO Userの作成に使用した外部アカウントで NAVERクラウドプラットフォームにログインできます。

参考

SSO Userは最大100個まで作成できます。

リクエスト

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

メソッド	URI
POST	/api/v1/users

リクエストヘッダ

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

リクエストボディ

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

フィールド	タイプ	必須の有無	説明
`loginId`	String	Required	SSO Userログイン ID 3~60文字メール形式作成後は変更不可
`description`	String	Optional	SSO Userの説明 0~300文字
`userProfile`	Object	Optional	SSO User Profile情報
`userProfile.firstName`	String	Optional	SSO Userの名(下の名前) 0~200文字
`userProfile.lastName`	String	Optional	SSO Userの姓(苗字) 0~200文字
`userProfile.email`	String	Optional	SSO Userのメールアドレス 0~200文字
`userProfile.empNo`	String	Optional	SSO Userの社員番号 0~200文字
`userProfile.phoneCountryCode`	String	Optional	SSO Userの国番号 0~10文字国番号形式
`userProfile.phoneNo`	String	Optional	SSO Userの携帯電話番号 0~200文字携帯電話番号形式
`userProfile.deptName`	String	Optional	SSO Userの部署名 0~200文字
`accessRules`	Object	Required	アクセスルール情報
`accessRules.consoleAccessAllowed`	Boolean	Required	コンソールアクセスを許可するかどうか `true` \| `false` `true`: 許可 `false`: 許可しない
`accessRules.apiAccessAllowed`	Boolean	Required	API Gatewayアクセスを許可するかどうか `true` \| `false` `true`: 許可 `false`: 許可しない

リクエスト例

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

curl --location --request POST 'https://sso.apigw.ntruss.com/api/v1/users' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
    "loginId": "******@ncloud.com",
    "description": "SSO User",
    "userProfile": {
        "firstName": "太郎",
        "lastName": "田中",
        "email": "******@ncloud.com",
        "empNo": "00112233",
        "phoneCountryCode": "82",
        "phoneNo": "010-0000-0000",
        "deptName": "部署"
    },
    "accessRules": {
        "consoleAccessAllowed": true,
        "apiAccessAllowed": true
    }
}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`userId`	String	-	SSO User ID
`loginId`	String	-	SSO Userログイン ID
`nrn`	String	-	SSO Userに対する NAVERクラウドプラットフォームリソースの識別値
`userProfile`	Object	-	SSO User Profile情報
`userProfile.firstName`	String	-	SSO Userの名(下の名前)
`userProfile.lastName`	String	-	SSO Userの姓(苗字)
`userProfile.email`	String	-	SSO Userのメールアドレス
`userProfile.emailVerified`	Boolean	-	メールアドレスは認証済みかどうか `true` \| `false` `true`: 認証完了 `false`: 認証が必要
`userProfile.empNo`	String	-	SSO Userの社員番号
`userProfile.phoneCountryCode`	String	-	SSO Userの国番号
`userProfile.phoneNo`	String	-	SSO Userの携帯電話番号
`userProfile.phoneNoVerified`	Boolean	-	携帯電話番号は認証済みかどうか `true` \| `false` `true`: 認証完了 `false`: 認証が必要
`userProfile.deptName`	String	-	SSO Userの部署名
`accessRules`	Object	-	アクセスルール情報
`accessRules.consoleAccessAllowed`	Boolean	-	コンソールアクセスを許可するかどうか `true` \| `false` `true`: 許可 `false`: 許可しない
`accessRules.apiAccessAllowed`	Boolean	-	API Gatewayアクセスを許可するかどうか `true` \| `false` `true`: 許可 `false`: 許可しない
`status`	String	-	SSO Userの状態 `active` \| `suspended` `active`: 使用中(有効化) `suspended`: 停止(無効化)
`description`	String	-	SSO Userの説明
`lastLoginAt`	String	-	SSO Userの最終アクセス日時 ISO 8601形式
`createdAt`	String	-	SSO Userの作成日時 ISO 8601形式
`updatedAt`	String	-	SSO Userの更新日時 ISO 8601形式

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

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

レスポンス例

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

{
    "userId": "8306bedf-****-****-****-40394feacec8",
    "loginId": "******@ncloud.com",
    "nrn": "nrn:PUB:SSO::*******:User/8306bedf-****-****-****-40394feacec8",
    "userProfile": {
        "firstName": "太郎",
        "lastName": "田中",
        "email": "******@ncloud.com",
        "emailVerified": true,
        "empNo": "00112233",
        "phoneCountryCode": "82",
        "phoneNo": "010-0000-0000",
        "phoneNoVerified": true,
        "deptName": "部署"
    },
    "accessRules": {
        "consoleAccessAllowed": true,
        "apiAccessAllowed": true
    },
    "status": "active",
    "createdAt": "2025-01-03T05:04:54Z",
    "updatedAt": "2025-01-03T05:04:54Z",
    "description": "SSO User"
}