Tenantの更新

Prev Next

Classic/VPC環境で利用できます。

Tenant情報を更新します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
PUT /api/v1/tenant

リクエストヘッダ

Ncloud Single Sign-On APIで共通して使用されるヘッダの詳細は、Ncloud Single Sign-Onのリクエストヘッダをご参照ください。

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
tenantAlias String Required Tenant Alias(エイリアス)
mbrLoginAllow String Optional メインアカウントでログインできるかどうか
  • UNUSED | ALLOW | DENY
    • UNUSED: Application別設定に従う
    • ALLOW: 許可
    • DENY: 拒否

リクエスト例

リクエストのサンプルコードは次の通りです。

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"
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
success Boolean - API処理結果
  • true | false
    • true: 成功
    • false: 失敗
message String - 結果メッセージ
  • successがfalseの場合、表示

レスポンスステータスコード

Ncloud Single Sign-On APIで共通して使用されるレスポンスステータスコードの詳細は、Ncloud Single Sign-Onのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "success": true
}