チケットの送信 マイチケット
ようこそ
ログイン  会員登録

Swaggerで "View Audit Log "のAPIを使用するには?

本書では、"監査ログの表示" セクションとその使用方法 (特に Swagger ツールを使用した場合) について説明します。


「監査ログの表示」では、現在のユーザーの監査ログの詳細を取得することができます。 

情報の取得を開始するには、ユーザーアカウントでAPI機能が有効になっており、トークンが生成されている必要があります。 

すでにアクティブなAPI機能を持つアカウントでトークンを生成する手順 

1.API設定 "セクションに移動する

2.ここをクリック" リンクをクリックし、" パーソナルアクセストークン" セクションに移動します。個人用アクセストークン" セクションに移動します。

3.Generate new token "ボタンをクリックします。

4. トークン名を入力し、パーミッションを確認する

 

5."トークン保存 "ボタンをクリックします。 ボタン

生成されたトークンは、Swaggerツールでさらに認証を行うために使用する必要があります。 生成されたトークンを編集、取り消し、削除することが可能です。

 

View Audit logs」セクションのAPIを使用するにはどうすればよいですか? 

前提条件 

  • アカウントでAPI機能が有効になっている
  • 生成されたトークン
  • 生成されたトークンのパーミッションを確認 -ユーザー:監査ログ
  • ベアラートークン 認証用

監査ログ閲覧」APIをSwaggerでさらに利用するためのユーザーを認証する手順

1.API設定 "セクションに移動する

2.API Documentation "リンクをクリックし、Swaggerセクションに移動します。

 

3.認証」ボタンをクリックする 

4. T開いたモーダルで Bearer と入力し、その後にスペースを空けてください (以下のスクリーンショットを参照)。

5.生成されたトークンを「Personal Access Tokens」セクションからコピーします(API設定 >" click here link "> Personal Access Tokensセクション >Copy token)。 

6.コピーしたトークンを、Bearerの後に開いたモーダルに貼り付けます。 

7.認証」ボタンをクリックする

8.閉じる」ボタンをクリックする

9.認証に成功すると、以下のスクリーンショットのようなボタンが表示されます。

 

10. これでユーザーの認証が完了し、Swaggerツールを使ってAPIを使い始めることができるようになりました

Swaggerによる「View Audit logs」APIの使用手順

PowerDMARC APIドキュメントは、プラットフォームの様々なセクションに対するAPIの説明を提供します。

前提条件 

  • 生成されたトークン
  •  Swagger上の正規ユーザー(上記の手順を参照)。 

Swaggerによる「View Audit logs」APIの利用開始手順

1.検索フィールドに「View audit logs」と入力する

 

2.情報の拡充 

3.試してみる」ボタンをクリックする

 

4.View 監査ログは、日付(from/to、日付形式は年/月/日)でのみフィルタリング可能ですが、パラメータでページ数およびページあたりの項目数を指定することができます。 

5.1ページあたりの項目数、ページ番号、日付によるフィルタリングを指定します(以下のスクリーンショットを参照)。

 

6.実行 "ボタンをクリック

7.リクエスト情報(Curl、リクエストURL)、レスポンス情報(ステータスコード、レスポンスボディ、レスポンスヘッダ)の確認


応答可能なステータスコード

  • レスポンスのステータスコード200は、リクエストが正常に処理され、ユーザーに対してレスポンス情報が提供されることを意味します。 
  • 401は、ユーザーが認証されていないことを意味します(トークンが提供されていない、または無効)。
  • 403は、ユーザーが要求されたリソースを取得する権限がないことを意味します(新しいトークンの生成時に権限が指定されていない)。

このナレッジセッションがお役に立つことを願っています。より安全なメール体験を楽しむために DMARCを導入してください。


P
PowerDMARCは、このソリューション記事の著者です。

役に立ったと思いますか? はい いいえ

フィードバックを送信する
お役に立てず申し訳ありません。この記事を改善するために、ご意見をお聞かせください。