Bulk create SSO users

Available in Classic and VPC

Bulk create SSO users of one or more based on the user information of an external account. You can log in to the NAVER Cloud Platform with the external account used to create the SSO user.

Note

Up to 100 SSO users can be created.

Request

This section describes the request format. The method and URI are as follows:

Method	URI
POST	/api/v1/users/bulk

Request headers

For information about the headers common to all Ncloud Single Sign-On APIs, see Ncloud Single Sign-On request headers.

Request body

You can include the following data in the body of your request:

Field	Type	Required	Description
`params`	Array	Required	SSO user information

`params`

The following describes params.

Field	Type	Required	Description
`loginId`	String	Required	SSO user login ID 3-60 characters Email format Can't be changed after creation
`description`	String	Optional	SSO user description 0-300 characters
`userProfile`	Object	Optional	SSO user profile information
`userProfile.firstName`	String	Optional	SSO user name 0-200 characters
`userProfile.lastName`	String	Optional	SSO user last name 0-200 characters
`userProfile.email`	String	Optional	SSO user email address 0-200 characters
`userProfile.empNo`	String	Optional	SSO user employee number 0-200 characters
`userProfile.phoneCountryCode`	String	Optional	SSO user country code 0-10 characters Country code format
`userProfile.phoneNo`	String	Optional	SSO user mobile phone number 0-200 characters Mobile phone number format
`userProfile.deptName`	String	Optional	SSO user department name 0-200 characters
`accessRules`	Object	Required	Access rule information
`accessRules.consoleAccessAllowed`	Boolean	Required	Whether to allow console access `true` \| `false` `true`: allow `false`: not allow
`accessRules.apiAccessAllowed`	Boolean	Required	Whether to allow API Gateway access `true` \| `false` `true`: allow `false`: not allow

Request example

The request example is as follows:

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": "Gildong",
                "lastName": "Hong",
                "email": "******@ncloud.com",
                "empNo": "0012341234",
                "phoneCountryCode": "82",
                "phoneNo": "010-0000-0000",
                "deptName": "Department 1"
            },
            "accessRules": {
                "consoleAccessAllowed": true,
                "apiAccessAllowed": true
            }
        },
        {
            "loginId": "******@ncloud.com",
            "description": "SSO User",
            "userProfile": {
                "firstName": "Cheolsu",
                "lastName": "Kim",
                "email": "******@ncloud.com",
                "empNo": "00110011",
                "phoneCountryCode": "82",
                "phoneNo": "010-1100-0000",
                "deptName": "Department 2"
            },
            "accessRules": {
                "consoleAccessAllowed": true,
                "apiAccessAllowed": true
            }
        }
    ]
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field	Type	Required	Description
`id`	String	-	SSO user ID
`name`	String	-	SSO user login ID
`nrn`	String	-	NAVER Cloud Platform resource identification value for SSO user
`success`	Boolean	-	API processing result `true` \| `false` `true`: succeeded `false`: failed
`message`	String	-	Result message Displayed if `success` is `false`

Response status codes

For information about the response status codes common to all Ncloud Single Sign-On APIs, see Ncloud Single Sign-On response status codes.

Response example

The response example is as follows:

[
    {
        "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
    }
]