Edit tenant

Prev Next

Available in Classic and VPC

Edit tenant information.

Request

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

Method URI
PUT /api/v1/tenant

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
tenantAlias String Required Tenant alias
  • URL information will also change when edited, so you need to Reset external IdP with the changed URL information
mbrLoginAllow String Optional Whether to allow main account login
  • UNUSED | ALLOW | DENY
    • UNUSED: Follow settings for each application
    • ALLOW: allow
    • DENY: deny

Request example

The request example is as follows:

curl --location --request PUT 'https://sso.apigw.ntruss.com/api/v1/tenant' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
    "tenantAlias": "d71d79e8-****-****-****-281f2a1d5d45",
    "mbrLoginAllow": "ALLOW"
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
success Boolean - API processing result
  • true | false
    • true: succeeded
    • false: failed
message String - Result message
  • Displayed if success is false

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:

{
    "success": true
}