SSO User 생성

Classic/VPC 환경에서 이용 가능합니다.

외부 계정 사용자 정보를 기반으로 SSO User를 생성합니다. SSO User 생성에 사용한 외부 계정으로 네이버 클라우드 플랫폼에 로그인할 수 있습니다.

참고

SSO User는 최대 100개까지 생성할 수 있습니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드	URI
POST	/api/v1/users

요청 헤더

Ncloud Single Sign-On API에서 공통으로 사용하는 헤더에 대한 정보는 Ncloud Single Sign-On 요청 헤더를 참조해 주십시오.

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`loginId`	String	Required	SSO User 로그인 아이디 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.gov-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 아이디
`loginId`	String	-	SSO User 로그인 아이디
`nrn`	String	-	SSO User에 대한 네이버 클라우드 플랫폼 리소스 식별 값
`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"
}