Ncloud Single Sign-On 개요
    • PDF

    Ncloud Single Sign-On 개요

    • PDF

    기사 요약

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

    Application, Tenant, External IDP, User, Group, PermissionSet, Assignment 정보를 관리할 수 있는 API를 제공합니다.
    API는 RESTful API 형태이며 HTTP GET/POST/PUT/DELETE 메소드를 사용합니다.

    오퍼레이션

    Ncloud Single Sign-On은 Application, Tenant, External IdP, User, Group, PermissionSet, Assignment 오퍼레이션을 제공하고 있습니다.

    Application

    Application과 관련된 API 목록은 다음과 같습니다.

    API설명
    getApplicationsApplication 목록 조회
    getApplicationApplication 단건 조회
    postApplicationApplication 생성
    putApplicationApplication 수정
    deleteApplicationApplication 삭제
    renewalClientSecret(Oauth2) Client Secret 재생성

    Tenant

    Tenant와 관련된 API 목록은 다음과 같습니다.

    API설명
    getTenantTenant 조회
    postTenantTenant 생성
    putTenantTenant 수정
    deleteTenantTenant 삭제

    External IdP

    External IdP와 관련된 API 목록은 다음과 같습니다.

    API설명
    postExternalIdPExternal IDP 등록
    getExternalIdPExternal IDP 조회
    putExternalIdPExternal IDP 수정
    deleteExternalIdPExternal IDP 삭제
    putAttributeMapperAttributeMapper 수정
    getAttributeMapperAttributeMapper 조회
    parseExternalIdPMetadataExternal IDP 메타데이터 파싱
    getSpMetadataNcloud Single Sign-On 메타데이터 조회
    getSpUrlDataNcloud Single Sign-On URL데이터 조회
    putLoginSettingExternal IDP 로그인 설정
    postOrganizationOrganization 연동

    User

    User와 관련된 API 목록은 다음과 같습니다.

    API설명
    validateUserLoginIdUser Login ID 유효성 검사
    postUserUser 생성
    postUsersUser 대량 생성
    putUserUser 수정
    deleteUserUser 삭제
    deleteUsersUser 목록 삭제
    getUsersUser 목록 조회
    getUserUser 단건 조회
    getUserAccessRuleUser Access Rules 조회
    putUserAccessRuleUser Access Rules 수정
    getUserProfileUser Profile 조회
    postUserToGroupUser를 Group에 추가
    getUserGroupsUser를 포함하는 Group 목록 조회
    getUserGroupUser를 포함하는 Group 단건 조회
    deleteUserFromGroupUser를 Group에서 제거
    changeUserStatusUser 상태 변경
    getUserSessionUser Session 조회
    expireUserSessionUser Session 만료
    getUserAssignmentUser가 속한 Assignment 목록 조회
    deleteUserFromAssignmentUser를 Assignment에서 제거

    Group

    Group과 관련된 API 목록은 다음과 같습니다.

    API설명
    validateGroupNameGroup 이름 유효성 검사
    postGroupGroup 생성
    getGroupsGroup 목록 조회
    getGroupGroup 단건 조회
    putGroupGroup 수정
    deleteGroupGroup 삭제
    deleteGroupsGroup 목록 삭제
    postGroupToUserGroup을 User에 추가
    getGroupUsersGroup에 속한 User 목록 조회
    getGroupAssignmentsGroup이 속한 Assignment 목록 조회
    deleteGroupFromUserGroup을 User에서 제거
    deleteGroupFromAssignmentGroup을 Assignment에서 제거

    PermissionSet

    PermissionSet과 관련된 API 목록은 다음과 같습니다.

    API설명
    getPermissionSetsPermission Set 목록 조회
    getPermissionSetPermission Set 단건 조회
    postPermissionSetPermission Set 생성
    putPermissionSetPermission Set 수정
    deletePermissionSetPermission Set 삭제
    deletePermissionSetsPermission Set 다건 삭제
    getPoliciesPermission Set에 할당 할 수 있는 Policy 목록 조회
    existsPolicyPermission Set 내 Policy 존재 여부 확인
    deletePolicyFromPermissionSetPermission Set 내 Policy 삭제
    validatePermissionSetNamePermission Set 이름 유효성 검사

    Assignment

    Assignment와 관련된 API 목록은 다음과 같습니다.

    API설명
    postAssignmentAssignment 생성
    getAssignmentsAssignment 목록 조회
    getAssignmentAssignment 단건 조회
    putAssignmentAssignment 수정
    changeAssignmentStatusAssignment 상태 변경
    deleteAssignmentAssignment 삭제
    getAssignmentTargetsAssignment Target 조회
    postAssignmentTargetsAssignment Target 추가
    deleteAssignmentTargetsAssignment Target 삭제
    getAccountsAccount 목록 조회
    addAssignmentIpAclsAssignment에 IP ACL 추가
    getAssignmentsIpAclsAssignment에 속한 IP ACL 목록 조회
    deleteAssignmentIpAclsAssignment에 속한 IP ACL 삭제

    IP ACL

    IP ACL과 관련된 API 목록은 다음과 같습니다.

    API설명
    validateIpAclNameIP ACL 이름 유효성 검사
    postIPACLIP ACL 생성
    putIPACLIP ACL 수정
    deleteIPACLsIP ACL 목록 삭제
    deleteIPACLIP ACL 단건 삭제
    getIPACLsIP ACL 목록 조회
    getIPACLIP ACL 단건 조회
    addIpAclToAssignmentsIP ACL에 Assignment 추가
    getIpAclAssignmentsIP ACL이 포함된 Assignment 조회
    deleteIpAclAssignmentsIP ACL에 할당된 Assignment 제거

    공통 설정

    API URL

    API URL은 다음과 같습니다.

    https://sso.apigw.ntruss.com/api/v1
    

    메서드

    사용 가능한 메서드는 다음과 같습니다.

    GET, POST, PUT, DELETE
    

    헤더

    요청 헤더

    공통으로 사용하는 요청 헤더를 안내합니다. 일부 요청 헤더의 경우 Ncloud API 공통 헤더이기 때문에 자세한 내용은 Ncloud API 공통 헤더를 참고해 주십시오. 요청 헤더에 대한 설명은 다음과 같습니다.

    헤더설명종류
    x-ncp-apigw-timestamp- 1970 년 1 월 1 일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타낸 것
    - API Gateway 서버와 시간 차가 5 분 이상 나는 경우 유효하지 않은 요청으로 간주
    Ncloud API 공통 헤더
    x-ncp-iam-access-key네이버 클라우드 플랫폼에서 발급받은 API Key 또는 IAM에서 발급받은 AccessKeyNcloud API 공통 헤더
    x-ncp-apigw-signature-v2- 위 예제의 Body를 AccessKey와 맵핑되는 SecretKey로 암호화한 서명
    - HMAC 암호화 알고리즘은 HmacSHA256 사용
    Ncloud API 공통 헤더

    공통 모델

    ProcessResult

    파라미터 명필수 여부타입설명
    successYBoolean처리 결과
    idNString생성/수정 결과 ID
    messageNString처리 결과 메시지
    • model
    ProcessResult {
      Boolean success;
      String id;
      String message;
    }
    
    • json
    {
      "id": "",
      "success": true
    }
    

    오류 코드

    공통으로 사용하는 오류 코드를 설명합니다. 여기에서는 Ncloud Single Sign-On API에서 공통으로 사용하는 오류 코드를 소개합니다. 서비스 전체에서 공통으로 사용하는 오류 코드에 대한 자세한 내용은 NAVER Cloud Platform API를 참고해 주십시오.

    파라미터 명필수 여부타입설명
    errorCodeYint에러 코드
    messageYString에러 메시지

    Ncloud Single Sign-On API의 공통 오류 코드 구문 예시는 다음과 같습니다.

    • model
    ErrorResponse {
      int errorCode;
      String message;
    }
    
    • json
    {
      "errorCode": 9011,
      "message": "에러 메시지"
    }
    

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

    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.