updateUser

이 가이드는 API 명세를 기반으로 AI가 자동 생성했습니다.

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

Ncloud 표준 표현을 적용한 API입니다.

SSO User 정보를 수정합니다. 요청 본문에 포함하지 않은 필드는 값이 삭제되므로, 유지할 값도 함께 전달해야 합니다.

요청

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

메서드	URI
PUT	/users/{userId}

요청 헤더

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

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`userId`	String (uuid)	Required	SSO User 아이디 <예시> 1a2b3c4d-1111-4abc-8def-0123456789ab

요청 바디

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

필드	타입	필수 여부	설명
`description`	String \| null	Optional	SSO User 설명 길이: ~ 300 <예시> example description
`userProfile`	Object<UserProfileParamV2>	Optional	SSO User Profile (이름, 이메일, 사원번호, 전화번호, 부서 등)
`accessRules`	Object<AccessRulesParam>	Required	SSO User 접근 규칙 (콘솔/API 접근 허용 여부)

UserProfileParamV2

SSO User Profile

필드	타입	필수 여부	설명
`firstName`	String \| null	Optional	이름 길이: ~ 200 <예시> John
`lastName`	String \| null	Optional	성 길이: ~ 200 <예시> Doe
`email`	String (email) \| null	Optional	이메일 패턴: `^(?:[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,})?$` 길이: ~ 200 <예시> user@example.com
`employeeNo`	String \| null	Optional	사원번호 길이: ~ 200 <예시> E12345
`phoneCountryCode`	String \| null	Optional	국가 번호 패턴: `^(?:\d{1,4})?$` 길이: ~ 4 <예시> 82
`phoneNo`	String \| null	Optional	전화번호 패턴: `^(?:\d{3}-\d{3,4}-\d{4}\|\d{9,11})?$` 길이: ~ 13 <예시> 010-0000-0000
`departmentName`	String \| null	Optional	부서명 길이: ~ 200 <예시> example-department

AccessRulesParam

SSO User 접근 규칙

필드	타입	필수 여부	설명
`consoleAccessAllowed`	Boolean	Required	콘솔 접근 허용 여부 `true` \| `false` true: 허용 false: 허용 안 함 <예시> true
`apiAccessAllowed`	Boolean	Required	API Gateway 접근 허용 여부 `true` \| `false` true: 허용 false: 허용 안 함 <예시> true

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request PUT 'https://sso.apigw.ntruss.com/api/v2/users/1a2b3c4d-1111-4abc-8def-0123456789ab' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
  "accessRules": {
    "consoleAccessAllowed": true,
    "apiAccessAllowed": true
  }
}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드	타입	필수 여부	설명
`userId`	String (uuid)	-	SSO User 아이디 <예시> 1a2b3c4d-1111-4abc-8def-0123456789ab
`loginId`	String (email)	-	SSO User 로그인 아이디 <예시> user@example.com
`nrn`	String	-	SSO User에 대한 네이버 클라우드 플랫폼 리소스 식별 값 <예시> nrn:PUB:SSO::1234567:User/1a2b3c4d-1111-4abc-8def-0123456789ab
`userProfile`	Object<UserProfileResponseV2>	-	SSO User Profile 정보
`accessRules`	Object<AccessRulesResponse>	-	SSO User 접근 규칙 (콘솔/API 접근 허용 여부)
`status`	String	-	SSO User 상태 `ACTIVATED` \| `SUSPENDED` \| `DELETED` ACTIVATED: 사용 중(활성화) SUSPENDED: 정지(비활성화) DELETED: 삭제됨 <예시> ACTIVATED
`lastLoginDateTime`	String (date-time)	-	SSO User 최종 접속 일시 <예시> 2025-01-02T09:00:00Z
`createdDateTime`	String (date-time)	-	SSO User 생성 일시 <예시> 2025-01-02T09:00:00Z
`updatedDateTime`	String (date-time)	-	SSO User 수정 일시 <예시> 2025-01-02T09:00:00Z
`description`	String	-	SSO User 설명 <예시> example description

UserProfileResponseV2

SSO User Profile 정보

필드	타입	필수 여부	설명
`firstName`	String	-	SSO User 이름 <예시> John
`lastName`	String	-	SSO User 성 <예시> Doe
`email`	String (email)	-	SSO User 이메일 주소 <예시> user@example.com
`emailVerified`	Boolean	-	이메일 주소 인증 여부 `true` \| `false` true: 인증 완료 false: 인증 필요 <예시> true
`employeeNo`	String	-	SSO User 사원 번호 <예시> 12345678
`phoneCountryCode`	String	-	SSO User 국가 번호 <예시> 82
`phoneNo`	String	-	SSO User 핸드폰 번호 <예시> 010-1234-5678
`phoneNoVerified`	Boolean	-	핸드폰 번호 인증 여부 `true` \| `false` true: 인증 완료 false: 인증 필요 <예시> true
`departmentName`	String	-	SSO User 부서 이름 <예시> example-department

AccessRulesResponse

SSO User 접근 규칙

필드	타입	필수 여부	설명
`consoleAccessAllowed`	Boolean	-	콘솔 접근 허용 여부 `true` \| `false` true: 허용 false: 허용 안 함 <예시> true
`apiAccessAllowed`	Boolean	-	API Gateway 접근 허용 여부 `true` \| `false` true: 허용 false: 허용 안 함 <예시> true

응답 상태 코드

Ncloud Single Sign-On API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud Single Sign-On 응답 상태 코드를 참조해 주십시오.

이 API에만 해당하는 응답 상태 코드는 다음과 같습니다.

HTTP 상태 코드	코드	메시지	설명
200	-	-	요청 처리 성공
404	NotFound	One or more of the resources in the request does not exist in the system.	잘못된 URL 요청, 마스터 계정에 Organization이 존재하지 않음, 존재하지 않는 관리형 정책(System Managed) 아이디 입력, SSO User에 MFA Device가 존재하지 않음
404	ResourceNotFound	The specified resource could not be found.	생성된 Tenant가 없음, 존재하지 않는 자원 아이디 입력
404	UserNotFound	The specified user could not be found.	존재하지 않는 SSO User 아이디 입력

응답 예시

응답 예시는 다음과 같습니다.

{
  "userId": "1a2b3c4d-1111-4abc-8def-0123456789ab",
  "loginId": "user@example.com",
  "nrn": "nrn:PUB:SSO::1234567:User/1a2b3c4d-1111-4abc-8def-0123456789ab",
  "userProfile": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "user@example.com",
    "emailVerified": true,
    "employeeNo": "12345678",
    "phoneCountryCode": "82",
    "phoneNo": "010-1234-5678",
    "phoneNoVerified": true,
    "departmentName": "example-department"
  },
  "accessRules": {
    "consoleAccessAllowed": true,
    "apiAccessAllowed": true
  },
  "status": "ACTIVATED",
  "lastLoginDateTime": "2025-01-02T09:00:00Z",
  "createdDateTime": "2025-01-02T09:00:00Z",
  "updatedDateTime": "2025-01-02T09:00:00Z",
  "description": "example description"
}