ダッシュボードのユーザーアカウントを削除する

delete

/scim/v2/Users/{id}

このエンドポイントを使用して、SCIM POST メソッドによって返されるリソース id を指定することによって、既存のダッシュボードユーザーを永続的に削除します。

これは、BrazeダッシュボードのCompany Usersセクションでユーザーを削除するのと同様である。

前提条件

このエンドポイントを使うには、SCIMトークンが必要だ。X-Request-Origin ヘッダーとしてサービス Origin を使用します。詳細については、「自動ユーザープロビジョニング」を参照してください。

レート制限

このエンドポイントには、1日あたり1社あたり5000リクエストのレート制限があります。このレート制限は、API レート制限に記載されているように、/scim/v2/Users/ PUT、GET、および POST エンドポイントと共有されます。

パスパラメーター

パラメータ required データ型説明

id 必須文字列ユーザーのリソースID。このパラメータは、POST /scim/v2/Users/ またはGET /scim/v2/Users?filter=userName eq "[email protected]" メソッドによって返される。

要求本文:

Content-Type: application/json
X-Request-Origin: YOUR-REQUEST-ORIGIN-HERE
Authorization: Bearer YOUR-REST-API-KEY

例のリクエスト

curl --location --request DELETE 'https://rest.iad-01.braze.com/scim/v2/Users/dfa245b7-24195aec-887bb3ad-602b3340' \
--header 'Content-Type: application/json' \
--header 'X-Request-Origin: YOUR-REQUEST-ORIGIN-HERE' \
--header 'Authorization: Bearer YOUR-SCIM-TOKEN-HERE' \

応答

エラー応答例

HTTP/1.1 204 Not Found
Content-Type: text/html; charset=UTF-8

このIDを持つ開発者がBrazeに存在しない場合、エンドポイントは次のように応答する：

HTTP/1.1 404 Not Found
Content-Type: text/html; charset=UTF-8

{
    "schemas": ["urn:ietf:params:scim:api:messages:2.0:Error"],
    "detail": "User not found",
    "status": 404
}

GitHub でこのページを編集

「このページはどの程度役に立ちましたか?」

GitHub でこのページを編集

New Stuff!