- 인쇄
- 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 | 설명 |
---|---|
getApplications | Application 목록 조회 |
getApplication | Application 단건 조회 |
postApplication | Application 생성 |
putApplication | Application 수정 |
deleteApplication | Application 삭제 |
renewalClientSecret | (Oauth2) Client Secret 재생성 |
Tenant
Tenant와 관련된 API 목록은 다음과 같습니다.
API | 설명 |
---|---|
getTenant | Tenant 조회 |
postTenant | Tenant 생성 |
putTenant | Tenant 수정 |
deleteTenant | Tenant 삭제 |
External IdP
External IdP와 관련된 API 목록은 다음과 같습니다.
API | 설명 |
---|---|
postExternalIdP | External IDP 등록 |
getExternalIdP | External IDP 조회 |
putExternalIdP | External IDP 수정 |
deleteExternalIdP | External IDP 삭제 |
putAttributeMapper | AttributeMapper 수정 |
getAttributeMapper | AttributeMapper 조회 |
parseExternalIdPMetadata | External IDP 메타데이터 파싱 |
getSpMetadata | Ncloud Single Sign-On 메타데이터 조회 |
getSpUrlData | Ncloud Single Sign-On URL데이터 조회 |
putLoginSetting | External IDP 로그인 설정 |
postOrganization | Organization 연동 |
User
User와 관련된 API 목록은 다음과 같습니다.
API | 설명 |
---|---|
validateUserLoginId | User Login ID 유효성 검사 |
postUser | User 생성 |
postUsers | User 대량 생성 |
putUser | User 수정 |
deleteUser | User 삭제 |
deleteUsers | User 목록 삭제 |
getUsers | User 목록 조회 |
getUser | User 단건 조회 |
getUserAccessRule | User Access Rules 조회 |
putUserAccessRule | User Access Rules 수정 |
getUserProfile | User Profile 조회 |
postUserToGroup | User를 Group에 추가 |
getUserGroups | User를 포함하는 Group 목록 조회 |
getUserGroup | User를 포함하는 Group 단건 조회 |
deleteUserFromGroup | User를 Group에서 제거 |
changeUserStatus | User 상태 변경 |
getUserSession | User Session 조회 |
expireUserSession | User Session 만료 |
getUserAssignment | User가 속한 Assignment 목록 조회 |
deleteUserFromAssignment | User를 Assignment에서 제거 |
Group
Group과 관련된 API 목록은 다음과 같습니다.
API | 설명 |
---|---|
validateGroupName | Group 이름 유효성 검사 |
postGroup | Group 생성 |
getGroups | Group 목록 조회 |
getGroup | Group 단건 조회 |
putGroup | Group 수정 |
deleteGroup | Group 삭제 |
deleteGroups | Group 목록 삭제 |
postGroupToUser | Group을 User에 추가 |
getGroupUsers | Group에 속한 User 목록 조회 |
getGroupAssignments | Group이 속한 Assignment 목록 조회 |
deleteGroupFromUser | Group을 User에서 제거 |
deleteGroupFromAssignment | Group을 Assignment에서 제거 |
PermissionSet
PermissionSet과 관련된 API 목록은 다음과 같습니다.
API | 설명 |
---|---|
getPermissionSets | Permission Set 목록 조회 |
getPermissionSet | Permission Set 단건 조회 |
postPermissionSet | Permission Set 생성 |
putPermissionSet | Permission Set 수정 |
deletePermissionSet | Permission Set 삭제 |
deletePermissionSets | Permission Set 다건 삭제 |
getPolicies | Permission Set에 할당 할 수 있는 Policy 목록 조회 |
existsPolicy | Permission Set 내 Policy 존재 여부 확인 |
deletePolicyFromPermissionSet | Permission Set 내 Policy 삭제 |
validatePermissionSetName | Permission Set 이름 유효성 검사 |
Assignment
Assignment와 관련된 API 목록은 다음과 같습니다.
API | 설명 |
---|---|
postAssignment | Assignment 생성 |
getAssignments | Assignment 목록 조회 |
getAssignment | Assignment 단건 조회 |
putAssignment | Assignment 수정 |
changeAssignmentStatus | Assignment 상태 변경 |
deleteAssignment | Assignment 삭제 |
getAssignmentTargets | Assignment Target 조회 |
postAssignmentTargets | Assignment Target 추가 |
deleteAssignmentTargets | Assignment Target 삭제 |
getAccounts | Account 목록 조회 |
addAssignmentIpAcls | Assignment에 IP ACL 추가 |
getAssignmentsIpAcls | Assignment에 속한 IP ACL 목록 조회 |
deleteAssignmentIpAcls | Assignment에 속한 IP ACL 삭제 |
IP ACL
IP ACL과 관련된 API 목록은 다음과 같습니다.
API | 설명 |
---|---|
validateIpAclName | IP ACL 이름 유효성 검사 |
postIPACL | IP ACL 생성 |
putIPACL | IP ACL 수정 |
deleteIPACLs | IP ACL 목록 삭제 |
deleteIPACL | IP ACL 단건 삭제 |
getIPACLs | IP ACL 목록 조회 |
getIPACL | IP ACL 단건 조회 |
addIpAclToAssignments | IP ACL에 Assignment 추가 |
getIpAclAssignments | IP ACL이 포함된 Assignment 조회 |
deleteIpAclAssignments | IP 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에서 발급받은 AccessKey | Ncloud API 공통 헤더 |
x-ncp-apigw-signature-v2 | - 위 예제의 Body를 AccessKey와 맵핑되는 SecretKey로 암호화한 서명 - HMAC 암호화 알고리즘은 HmacSHA256 사용 | Ncloud API 공통 헤더 |
공통 모델
ProcessResult
파라미터 명 | 필수 여부 | 타입 | 설명 |
---|---|---|---|
success | Y | Boolean | 처리 결과 |
id | N | String | 생성/수정 결과 ID |
message | N | String | 처리 결과 메시지 |
- model
ProcessResult {
Boolean success;
String id;
String message;
}
- json
{
"id": "",
"success": true
}
오류 코드
공통으로 사용하는 오류 코드를 설명합니다. 여기에서는 Ncloud Single Sign-On API에서 공통으로 사용하는 오류 코드를 소개합니다. 서비스 전체에서 공통으로 사용하는 오류 코드에 대한 자세한 내용은 NAVER Cloud Platform API를 참고해 주십시오.
파라미터 명 | 필수 여부 | 타입 | 설명 |
---|---|---|---|
errorCode | Y | int | 에러 코드 |
message | Y | String | 에러 메시지 |
Ncloud Single Sign-On API의 공통 오류 코드 구문 예시는 다음과 같습니다.
- model
ErrorResponse {
int errorCode;
String message;
}
- json
{
"errorCode": 9011,
"message": "에러 메시지"
}