SSO Userアクセスルールの照会

Prev Next

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

SSO Userアクセスルールを照会します。

リクエスト

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

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

リクエストヘッダ

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

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

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

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

リクエスト例

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

curl --location --request GET '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}'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
    "consoleAccessAllowed": true,
    "apiAccessAllowed": true
}