Attribute Mapper 수정
    • PDF

    Attribute Mapper 수정

    • PDF

    기사 요약

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

    Attribute Mapper를 수정합니다.

    참고

    Ncloud Single Sign-On 서비스의 사용자 속성 정보와 AWS, OneLogin과 같은 다른 서비스에서 설정한 사용자 속성 정보를 연결하는 방법은 Ncloud Single Sign-On 사용 가이드를 참조해 주십시오.

    요청

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

    메서드URI
    POST/api/v1/tenant/saml-idp/profile-mapping

    요청 헤더

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

    요청 바디

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

    필드타입필수 여부설명
    firstNameObjectRequired이름 정보
    firstName.syncModeStringRequired속성 정보 업데이트 정책
    • none | import | force
      • none: 업데이트 안 함
      • import: 최초 로그인 시에만 업데이트
      • force: 로그인할 때마다 업데이트
    firstName.idpValueStringRequired네이버 클라우드 플랫폼의 Single Sign-On 서비스로 전달할 속성(AttributeName)
    • 0~200자
    • 전달할 속성이 없을 경우, 빈 문자열 ""로 설정
    lastNameObjectRequired성씨 정보
    lastName.syncModeStringRequired속성 정보 업데이트 정책
    • none | import | force
      • none: 업데이트 안 함
      • import: 최초 로그인 시에만 업데이트
      • force: 로그인할 때마다 업데이트
    lastName.idpValueStringRequired네이버 클라우드 플랫폼의 Single Sign-On 서비스로 전달할 속성(AttributeName)
    • 0~200자
    • 전달할 속성이 없을 경우, 빈 문자열 ""로 설정
    emailObjectRequired이메일 정보
    email.syncModeStringRequired속성 정보 업데이트 정책
    • none | import | force
      • none: 업데이트 안 함
      • import: 최초 로그인 시에만 업데이트
      • force: 로그인할 때마다 업데이트
    email.idpValueStringRequired네이버 클라우드 플랫폼의 Single Sign-On 서비스로 전달할 속성(AttributeName)
    • 0~200자
    • 전달할 속성이 없을 경우, 빈 문자열 ""로 설정
    emailVerifiedObjectRequired이메일 인증 정보
    emailVerified.syncModeStringRequired속성 정보 업데이트 정책
    • none | import | force
      • none: 업데이트 안 함
      • import: 최초 로그인 시에만 업데이트
      • force: 로그인할 때마다 업데이트
    emailVerified.idpValueStringRequired네이버 클라우드 플랫폼의 Single Sign-On 서비스로 전달할 속성(AttributeName)
    • 0~200자
    • 전달할 속성이 없을 경우, 빈 문자열 ""로 설정
    empNoObjectRequired사원 번호 정보
    empNo.syncModeStringRequired속성 정보 업데이트 정책
    • none | import | force
      • none: 업데이트 안 함
      • import: 최초 로그인 시에만 업데이트
      • force: 로그인할 때마다 업데이트
    empNo.idpValueStringRequired네이버 클라우드 플랫폼의 Single Sign-On 서비스로 전달할 속성(AttributeName)
    • 0~200자
    • 전달할 속성이 없을 경우, 빈 문자열 ""로 설정
    phoneNoObjectRequired핸드폰 번호 정보
    phoneNo.syncModeStringRequired속성 정보 업데이트 정책
    • none | import | force
      • none: 업데이트 안 함
      • import: 최초 로그인 시에만 업데이트
      • force: 로그인할 때마다 업데이트
    phoneNo.idpValueStringRequired네이버 클라우드 플랫폼의 Single Sign-On 서비스로 전달할 속성(AttributeName)
    • 0~200자
    • 전달할 속성이 없을 경우, 빈 문자열 ""로 설정
    phoneNoVerifiedObjectRequired핸드폰 번호 인증 정보
    phoneNoVerified.syncModeStringRequired속성 정보 업데이트 정책
    • none | import | force
      • none: 업데이트 안 함
      • import: 최초 로그인 시에만 업데이트
      • force: 로그인할 때마다 업데이트
    phoneNoVerified.idpValueStringRequired네이버 클라우드 플랫폼의 Single Sign-On 서비스로 전달할 속성(AttributeName)
    • 0~200자
    • 전달할 속성이 없을 경우, 빈 문자열 ""로 설정
    phoneCountryCodeObjectRequired국가 번호 정보
    phoneCountryCode.syncModeStringRequired속성 정보 업데이트 정책
    • none | import | force
      • none: 업데이트 안 함
      • import: 최초 로그인 시에만 업데이트
      • force: 로그인할 때마다 업데이트
    phoneCountryCode.idpValueStringRequired네이버 클라우드 플랫폼의 Single Sign-On 서비스로 전달할 속성(AttributeName)
    • 0~200자
    • 전달할 속성이 없을 경우, 빈 문자열 ""로 설정
    deptNameObjectRequired부서 정보
    deptName.syncModeStringRequired속성 정보 업데이트 정책
    • none | import | force
      • none: 업데이트 안 함
      • import: 최초 로그인 시에만 업데이트
      • force: 로그인할 때마다 업데이트
    deptName.idpValueStringRequired네이버 클라우드 플랫폼의 Single Sign-On 서비스로 전달할 속성(AttributeName)
    • 0~200자
    • 전달할 속성이 없을 경우, 빈 문자열 ""로 설정

    요청 예시

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

    curl --location --request POST 'https://sso.apigw.gov-ntruss.com/api/v1/tenant/saml-idp/profile-mapping' \
    --header 'x-ncp-apigw-timestamp: {Timestamp}' \
    --header 'x-ncp-iam-access-key: {Access Key}' \
    --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
    --data '{
        "firstName": {
            "syncMode": "force",
            "idpValue": "${user:givenName}"
        },
        "lastName": {
            "syncMode": "import",
            "idpValue": "${user:familyName}"
        },
        "email": {
            "syncMode": "import",
            "idpValue": "${user:email}"
        },
        "emailVerified": {
            "syncMode": "import",
            "idpValue": ""
        },
        "empNo": {
            "syncMode": "import",
            "idpValue": ""
        },
        "phoneNo": {
            "syncMode": "import",
            "idpValue": ""
        },
        "phoneNoVerified": {
            "syncMode": "import",
            "idpValue": ""
        },
        "phoneCountryCode": {
            "syncMode": "import",
            "idpValue": ""
        },
        "deptName": {
            "syncMode": "import",
            "idpValue": ""
        }
    }'
    

    응답

    응답 형식을 설명합니다.

    응답 바디

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

    필드타입필수 여부설명
    successBoolean-API 처리 결과
    • true | false
      • true: 성공
      • false: 실패
    messageString-결과 메시지
    • successfalse인 경우, 표시

    응답 상태 코드

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

    응답 예시

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

    {
        "success": true
    }
    

    이 문서가 도움이 되었습니까?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.