Documentation Index

Fetch the complete documentation index at: https://api.ncloud-docs.com/llms.txt

Use this file to discover all available pages before exploring further.

Register SP certificate

Prev Next

Available in Classic and VPC

Register an external SAML SP certificate.

Request

This section describes the request format. The method and URI are as follows:

Method URI
POST /api/v1/tenant/saml-idp/sp-certificates

Request headers

For information about the headers common to all Ncloud Single Sign-On APIs, see Ncloud Single Sign-On request headers.

Request body

You can include the following data in the body of your request:

Field Type Required Description
certificateExpireDays Integer Required Certificate expiration date (day)
  • 180 | 270 | 365 | 730 | 1095 | 1460 | 1825 | 3650
keySize Integer Required Certificate key size (bit)
  • 1024 | 2048
algorithm String Required Hash algorithm used to sign SAML requests
  • SHA-1 | SHA-256
    • SHA-1: SHA-1 hash algorithm
    • SHA-256: SHA-256 hash algorithm

Request example

The request example is as follows:

curl --location --request POST 'https://sso.apigw.ntruss.com/api/v1/tenant/saml-idp/sp-certificates' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
    "certificateExpireDays" : 3650,
    "keySize": 2048,
    "algorithm": "SHA-256"
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
id String - SP certificate's unique identifier
success Boolean - API processing result

Response status codes

For information about the HTTP status codes common to all Ncloud Single Sign-On APIs, see Ncloud Single Sign-On response status codes.

Response example

The response example is as follows:

{
    "id": "ba0def04-****-****-****-ff0b962016f7",
    "success": true
}