Integrate Organization

Prev Next

Available in Classic and VPC

Set integration with the Organization service.

Request

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

Method URI
POST /api/v1/tenant/organization

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
enable Boolean Required Organization integration status
  • true | false
    • true: integrated
    • false: integration disabled

Request example

The request example is as follows:

curl --location --request POST 'https://sso.apigw.ntruss.com/api/v1/tenant/organization' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
   "enable": true
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
organizationEnabledAt String - Organization integration date and time
  • ISO 8601 format
  • Displayed if organizationEnabled is true
organizationEnabled Boolean - Organization integration status
  • true | false
    • true: integration completed
    • false: integration disabled

Response status codes

For information about the response 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:

{
    "organizationEnabledAt": "2025-02-06T06:17:07Z",
    "organizationEnabled": true
}