SSO User 수정
- 인쇄
- PDF
SSO User 수정
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
Classic/VPC 환경에서 이용 가능합니다.
SSO User 정보를 수정합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
메서드 | URI |
---|---|
PUT | /api/v1/users/{userId} |
요청 헤더
Ncloud Single Sign-On API에서 공통으로 사용하는 헤더에 대한 정보는 Ncloud Single Sign-On 요청 헤더를 참조해 주십시오.
요청 경로 파라미터
요청 경로 파라미터에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
userId | String | Required | SSO User 아이디 |
요청 바디
요청 바디에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
description | String | Optional | SSO User 설명
|
userProfile | Object | Optional | SSO User Profile 정보 |
userProfile.firstName | String | Optional | SSO User 이름
|
userProfile.lastName | String | Optional | SSO User 성
|
userProfile.email | String | Optional | SSO User 이메일 주소
|
userProfile.empNo | String | Optional | SSO User 사원 번호
|
userProfile.phoneCountryCode | String | Optional | SSO User 국가 번호
|
userProfile.phoneNo | String | Optional | SSO User 핸드폰 번호
|
userProfile.deptName | String | Optional | SSO User 부서 이름
|
accessRules | Object | Required | 접근 규칙 정보 |
accessRules.consoleAccessAllowed | Boolean | Required | 콘솔 접근 허용 여부
|
accessRules.apiAccessAllowed | Boolean | Required | API Gateway 접근 허용 여부
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request PUT 'https://sso.apigw.gov-ntruss.com/api/v1/users/8306bedf-****-****-****-40394feacec8' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
"description": "SSO User",
"userProfile": {
"firstName": "길동",
"lastName": "홍",
"email": "******@ncloud.com",
"empNo": "00112233",
"phoneCountryCode": "82",
"phoneNo": "010-1111-1111",
"deptName": "부서"
},
"accessRules": {
"consoleAccessAllowed": true,
"apiAccessAllowed": true
}
}'
응답
응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
id | String | - | SSO User 아이디 |
nrn | String | - | SSO User에 대한 네이버 클라우드 플랫폼 리소스 식별 값 |
success | Boolean | - | API 처리 결과
|
message | String | - | 결과 메시지
|
응답 상태 코드
Ncloud Single Sign-On API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud Single Sign-On 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
{
"id": "80d9ba0d-****-****-****-76afe6ea5b33",
"nrn": "nrn:PUB:SSO::*******:User/80d9ba0d-****-****-****-76afe6ea5b33",
"success": true
}
이 문서가 도움이 되었습니까?