SSO Userアクセスルールの更新

Prev Next

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

SSO Userアクセスルールを更新します。

リクエスト

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

メソッド URI
PUT /api/v1/users/{userId}/access-rules

リクエストヘッダ

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

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
userId String Required SSO User IDリスト

リクエストボディ

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

フィールド タイプ 必須の有無 説明
consoleAccessAllowed Boolean Required コンソールアクセスを許可するかどうか
  • true | false
    • true: 許可
    • false: 許可しない
apiAccessAllowed Boolean Required API Gatewayアクセスを許可するかどうか
  • true | false
    • true: 許可
    • false: 許可しない

リクエスト例

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

curl --location --request PUT 'https://sso.apigw.ntruss.com/api/v1/users/ba0def04-****-****-****-ff0b962016f7/access-rules' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
    "consoleAccessAllowed": false,
    "apiAccessAllowed": false
}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
id String - SSO User ID
nrn String - SSO Userに対する NAVERクラウドプラットフォームリソースの識別値
success Boolean - API処理結果
  • true | false
    • true: 成功
    • false: 失敗
message String - 結果メッセージ
  • successがfalseの場合、表示

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

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

レスポンス例

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

{
    "id": "ba0def04-****-****-****-ff0b962016f7",
    "nrn": "nrn:PUB:SSO::*******:User/ba0def04-****-****-****-ff0b962016f7",
    "success": true
}