リクエスト

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

メソッド	URI
POST	/api/v1/users/{enable\|disable}

リクエストヘッダ

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

リクエストボディ

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

フィールド	タイプ	必須の有無	説明
`userIds`	Array	Required	SSO User IDリスト SSO Userリストの照会を参照

リクエスト例

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

SSO Userを使用(有効化)状態に設定する場合

SSO Userを使用(有効化)状態に設定する場合のリクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://sso.apigw.ntruss.com/api/v1/users/enable' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
    "userIds": [
        "ba0def04-****-****-****-ff0b962016f7",
        "e019a8b4-****-****-****-887b25e7961d"
    ]
}'

SSO Userを停止(無効化)状態に設定する場合

SSO Userを停止(無効化)状態に設定する場合のリクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://sso.apigw.ntruss.com/api/v1/users/disable' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
    "userIds": [
        "ba0def04-****-****-****-ff0b962016f7",
        "e019a8b4-****-****-****-887b25e7961d"
    ]
}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`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
    },
    {
        "id": "e019a8b4-****-****-****-887b25e7961d",
        "nrn": "nrn:PUB:SSO::*******:User/e019a8b4-****-****-****-887b25e7961d",
        "success": true
    }
]

この記事は役に立ちましたか?

リクエスト
レスポンス