SSO Userの一括作成

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

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

参考

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

リクエスト

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

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

リクエストヘッダ

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

リクエストボディ

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

フィールド	タイプ	必須の有無	説明
`params`	Array	Required	SSO User情報

`params`

paramsの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`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`: 許可しない
`tags`	Object	Optional	ポリシーのタグリソースごとに最大20個 `{tagKey}:{tagValue}`形式で入力 tagKey: 英数字、記号の「、.、/、=、+、-、@」を組み合わせて128文字以内で入力 tagValue: 英数字、記号の「、.、/、=、+、-、@」を組み合わせて256文字以内で入力

リクエスト例

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

curl --location POST 'https://sso.apigw.ntruss.com/api/v1/users/bulk' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
    "params": [
        {
            "loginId": "******@ncloud.com",
            "description": "SSO User",
            "userProfile": {
                "firstName": "ギルドン",
                "lastName": "ホン",
                "email": "******@ncloud.com",
                "empNo": "0012341234",
                "phoneCountryCode": "82",
                "phoneNo": "010-0000-0000",
                "deptName": "部署1"
            },
            "accessRules": {
                "consoleAccessAllowed": true,
                "apiAccessAllowed": true
            },
            tags: {
                "tagKey1": "tagValue1",
                "team": "a"
            }
        },
        {
            "loginId": "******@ncloud.com",
            "description": "SSO User",
            "userProfile": {
                "firstName": "チョルス",
                "lastName": "キム",
                "email": "******@ncloud.com",
                "empNo": "00110011",
                "phoneCountryCode": "82",
                "phoneNo": "010-1100-0000",
                "deptName": "部署2"
            },
            "accessRules": {
                "consoleAccessAllowed": true,
                "apiAccessAllowed": true
            },
            tags: {
                "tagKey2: "tagValue2",
                "team": "b"
            }
        }
    ]
}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`id`	String	-	SSO User ID
`name`	String	-	SSO Userログイン ID
`nrn`	String	-	SSO Userに対する NAVERクラウドプラットフォームリソースの識別値
`success`	Boolean	-	API処理結果 `true` \| `false` `true`: 成功 `false`: 失敗
`message`	String	-	結果メッセージ `success`が`false`の場合、表示

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

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

レスポンス例

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

[
    {
        "id": "6b0d0df7-****-****-****-1a11f29b5c34",
        "name": "******@ncloud.com",
        "nrn": "nrn:PUB:SSO::*******:User/6b0d0df7-****-****-****-1a11f29b5c34",
        "success": true
    },
    {
        "id": "ba0def04-****-****-****-ff0b962016f7",
        "name": "******@ncloud.com",
        "nrn": "nrn:PUB:SSO::*******:User/ba0def04-****-****-****-ff0b962016f7",
        "success": true
    }
]