Single Sign-On 개요
    • PDF

    Single Sign-On 개요

    • PDF

    Article Summary

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

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

    오퍼레이션

    Single Sign-On은 Application, Tenant 오퍼레이션을 제공하고 있습니다.

    Application

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

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

    Tenant

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

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

    공통 설정

    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
    }
    

    오류 코드

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

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

    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.