Classic/VPC環境で利用できます。
Organizationからメンバーアカウントを強制退会処理します。
リクエスト
リクエスト形式を説明します。リクエスト形式は次の通りです。
| メソッド | URI |
|---|---|
| POST | /open-api/v1/account/leave/force |
リクエストヘッダ
Organization APIで共通して使用されるヘッダの詳細は、Organizationのリクエストヘッダをご参照ください。
リクエストボディ
リクエストボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
memberNo |
Integer | Required | メンバーアカウントの会員番号
|
memberName |
String | Required | メンバーアカウントのユーザー名
|
リクエスト例
リクエストのサンプルコードは次の通りです。
curl --location --request POST 'https://organization.apigw.ntruss.com/open-api/v1/account/leave/force' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
"memberNo": 270****,
"memberName": "佐藤一郎"
}'
レスポンス
レスポンス形式を説明します。
レスポンスボディ
レスポンスボディの説明は次の通りです。
| フィールド | タイプ | 必須の有無 | 説明 |
|---|---|---|---|
result |
String | - | API処理結果 |
レスポンスステータスコード
Organization APIで共通して使用されるレスポンスステータスコードの詳細は、Organizationのレスポンスステータスコードをご参照ください。
レスポンス例
レスポンスのサンプルコードは次の通りです。
{
"result": "SUCCESS"
}