Ncloud Single Sign-On overview

The latest service changes have not yet been reflected in this content. We will update the content as soon as possible. Please refer to the Korean version for information on the latest updates.

Available in Classic and VPC

Ncloud Single Sign-On is a NAVER Cloud Platform service that builds a system that allows you to access various applications with a single account. The Ncloud Single Sign-On service provides APIs for application, tenant, external IdP, SSO user, group, permission set, assignment, and IP ACL features in a RESTful form.

Common Ncloud Single Sign-On settings

The following describes commonly used request and response formats in Ncloud Single Sign-On APIs.

Request

The following describes the common request format.

API URL

The request API URL is as follows.

https://sso.apigw.ntruss.com

Request headers

The following describes the request headers.

Response

The following describes the common response format.

Response data type

The following describes the common response date types.

ProcessResult

ProcessResult defines the API processing result. The following describes ProcessResult.

The following is a sample syntax and response of ProcessResult.

• Syntax

  ProcessResult {
      Boolean success;
      String id;
      String message;
  }
  

• Examples

  {
      "id": "",
      "success": true
  }
  

ErrorResponse

ErrorResponse defines the details of a failure when an API call fails. The following describes ErrorResponse.

The following is a sample syntax and response of ErrorResponse.

• Syntax

  ErrorResponse {
    int errorCode;
    String message;
  }
  

• Examples

  {
      "errorCode": 9060,
      "message": "The group name already exists."
  }
  

Response status codes

The following describes the response status codes.

Ncloud Single Sign-On API

The following describes the APIs provided by the Ncloud Single Sign-On service.

Application

The following describes the application-related APIs.

Tenant

The following describes the tenant-related APIs.

External IdP

The following describes the external IdP-related APIs.

SSO User

The following describes the SSO user-related APIs.

Group

The following describes the group-related APIs.

Permission Set

The following describes the permission set-related APIs.

Assignment

The following describes the assignment-related APIs.

IP ACL

The following describes the IP ACL-related APIs.

Ncloud Single Sign-On related resources

NAVER Cloud Platform provides a variety of related resources to help users better understand Ncloud Single Sign-On APIs.

• Ncloud Single Sign-On API guide
  • Create signature: how to create a signature to add to the request header
  • API Gateway User Guide: how to issue the API key to be added to the request header
  • Sub Account User guide: how to issue the access key to be added to the request header
  • Common Ncloud response status codes: information on common response status codes of NAVER Cloud Platform used by the Ncloud Single Sign-On service
• Ncloud Single Sign-On service guide
  • Ncloud Single Sign-On User Guide: how to use Ncloud Single Sign-On from the NAVER Cloud Platform console
  • Ncloud use environment guide: guide for VPC and Classic environments and support availability
  • Introduction to pricing, characteristics, and detailed features: summary of pricing system, characteristics, and detailed features of Ncloud Single Sign-On
  • Latest service news: the latest news on Ncloud Single Sign-On service
  • FAQ: frequently asked questions from the Ncloud Single Sign-On service users
  • Contact us: Send direct inquiries for unresolved questions that aren't answered by the API guide