はじめに
Secure Code Warrior Okta Workflowsコネクタを使用すると、フロー内でSecure Code Warriorのコースと評価のデータを活用できます。たとえば、機密性の高いコードリポジトリへのアクセスを許可する前に、評価を使用して開発者のセキュリティコンピテンシーを検証できます。より詳細な使用例については、当社のブログ投稿をご覧ください。
また、コネクタを使用して、Secure Code Warriorプラットフォームからのユーザーの作成と削除を自動化することもできます。ユーザー管理アクションにはAdmin APIキーが必要です。
注：この機能は本番環境（US & EU）のみで使用することを想定しており、テスト環境では使用できません。
認証
前提条件
APIキーの生成
Secure Code Warrior Platform APIに接続してコネクタを使用できるようにするには、APIキーが必要です。Secure Code Warriorでは、2種類のAPIキーを使用します：
- Admin APIキーは読み書き可能で、Create UserおよびDelete Userアクションカードを使用するために必要です。
- Reporting APIキーは読み取り専用で、残りのすべてのアクションカードで使用できます。
注：Admin APIキーを有効にするには、Secure Code Warriorにお問い合わせください。
キーを生成するには
- 会社管理者アカウントでSecure Code Warriorにログインします。
- 管理］に進みます。
- More] [Edit Company] をクリックします。
- Report API］または［Admin API］の下にラベル（たとえば、［Okta Workflows Reporting Key］）を入力し、［Generate Key］をクリックします。APIキーを含むダイアログが表示されます。
- APIキーをクリップボードにコピーします。
接続の設定
Secure Code Warrior アクションカードを初めてフローに追加すると、接続を設定するプロンプトが表示されます。これにより、Secure Code Warrior組織に接続してAPIキーを保存し、Secure Code Warriorアクションカードを含む新しいフローで接続を再利用できるようになります。これを行うには、以下の手順に従ってください：
- Okta Admin DashboardからOkta Workflowsコンソールを開きます。
- Connections］ページまたは任意のSecure Code Warriorアクションカードから、［New Connection］をクリックします。
- 接続のニックネームを入力します。これは、複数の接続を作成してチームで共有する場合に便利です。
- APIキーを
- インスタンスリージョンを選択します。
- 作成をクリックします。
アクションカード
ユーザのアセスメント完了の確認
ユーザーが指定されたアセスメントに合格したかどうかをチェックします。これは合格最低点が設定された評価にのみ使用できることに注意してください。
オプション
オプションなし
入力
| フィールド | 説明 | タイプ | 必須 |
| 評価ID | 完了をチェックする評価の一意の識別子。 | 文字列 | 真 |
| ユーザーのメールアドレス | 完了をチェックするユーザのメールアドレス。 | 文字列 | 真 |
出力
| フィールド | 説明 | タイプ |
| 評価完了 |
ユーザーが指定された評価に合格したかどうかを示すブール値 (true/false)。 |
真/偽 |
ユーザのコース完了チェック
ユーザが指定されたコースを完了したかどうかチェックします。
オプション
オプションなし
入力
| フィールド | 説明 | タイプ | 必須 |
| コースID | 完了をチェックするコースの一意の識別子。 | 文字列 | 真 |
| ユーザのメールアドレス | 完了をチェックするユーザのメールアドレス。 | 文字列 | 真 |
出力
| フィールド | 説明 | タイプ |
| コース完了 |
ユーザが指定されたコースを完了したかどうかを示すブール値 (true/false)。 |
真/偽 |
ユーザの評価受験回数リスト
指定された評価に対するユーザの受験一覧を取得します。最大100レコードが返されます。
オプション
| フィールド | 説明 | タイプ | 必須 |
|
合格した受験のみ表示する |
ユーザが最低合格点を超えた受験のみに評価の受験をフィルタリングします。許可される値はYesとNoです。 |
ドロップダウン | 真 |
入力
| フィールド | 説明 | タイプ | 必須 |
| 評価ID | 試行を取得するアセスメントの一意の識別子。 | 文字列 | 真 |
| ユーザのメールアドレス | 受験結果を取得するユーザのメールアドレス。 | 文字列 | 真 |
出力
| フィールド | 説明 | タイプ |
| 評価受験回数 | 指定された評価に対するユーザの受験のリスト。リストオブジェクトの構造についてはAPIドキュメントを参照してください。最大100レコードが返されます。 | リスト (オブジェクト) |
ユーザの受講一覧
指定されたコースに対するユーザの登録件数のリストを取得します。最大100件のレコードが返されます。
オプション
| フィールド | 説明 | タイプ | 必須 |
|
合格したコース登録のみを表示する |
ユーザがコースを完了したコース登録のみを表示します。許可される値は「はい」と「いいえ」です。 |
ドロップダウン | 真 |
入力
| フィールド | 説明 | タイプ | 必須 |
| コースID | 登録情報を取得するコースの一意な識別子。 | 文字列 | 真 |
| ユーザのメールアドレス | コース登録情報を取得するユーザのメールアドレス。 | 文字列 | 真 |
出力
| フィールド | 説明 | タイプ |
| コース登録数 |
指定されたコースのユーザの登録リスト。リストオブジェクトの構造についてはAPIドキュメントを参照してください。最大100件のレコードが返されます。 |
リスト (オブジェクト) |
ユーザ作成
管理APIキーが必要です。Secure Code Warriorプラットフォームに新しいユーザーを追加します。
オプション
| フィールド | 説明 | タイプ | 必須 |
|
招待メールの送信 |
作成されたユーザに招待メールとリマインダー・メールを送信する。許可される値はYesとNoです。 |
ドロップダウン | 真 |
入力
| フィールド | 説明 | タイプ | 必須 |
| ユーザーメールアドレス | ユーザーのEメールアドレス。 | 文字列 | 真 |
| ユーザーの役割 | ユーザーの役割。許可される値は、会社管理者、チームマネージャー、開発者です。 | ドロップダウン | 真 |
| チーム | ユーザーを追加する既存のチーム名。このフィールドはCompany Administratorロールが選択されている場合は無視され、Team ManagerおよびDeveloperロールの場合は必須です。 | 文字列 | False |
| タグ | ユーザに適用するタグのリスト。 | 文字列のリスト | 偽 |
出力
| フィールド | 説明 | タイプ |
| ステータス・コード | 操作の結果。HTTPステータスコードはコネクタから返され、カードが実行したアクションが成功したか失敗したかを示します。例えば
返されるステータスコードの詳細については、APIドキュメントを参照してください。 |
番号 |
| 詳細エラーコード |
利用可能な場合は、HTTPステータスコードの上に、何が問題だったのかについての詳細な情報を提供する追加のエラーコードが返されます。 返されるエラーコードの詳細については、APIドキュメントを参照してください。 |
番号 |
| 詳細なエラーメッセージ |
利用可能な場合は、エラーメッセージが追加で返されます。 返されるエラーメッセージの詳細については、APIドキュメントを参照してください。 |
文字列 |
ユーザー削除
管理者APIキーが必要です。Secure Code Warriorプラットフォームからユーザーを完全に削除します。この操作は永続的で、元に戻すことはできません。
オプション
オプションなし
入力項目
| フィールド | 説明 | タイプ | 必須 |
| ユーザのメールアドレス | 削除するユーザーのメールアドレス。 | 文字列 | 真 |
出力
| フィールド | 説明 | タイプ |
| ステータス・コード | 操作の結果。HTTPステータスコードはコネクタから返され、カードが実行したアクションが成功したか失敗したかを示します。例えば
返されるステータスコードの詳細については、APIのドキュメントを参照してください。 |
番号 |
ユーザーを無効にする
管理APIキーが必要です。ユーザーを無効にして、Secure Code Warriorプラットフォームにアクセスできなくします。
オプション
オプションなし
入力項目
| フィールド | 説明 | タイプ | 必須 |
| ユーザのメールアドレス | 削除するユーザーのメールアドレス。 | 文字列 | 真 |
出力
| フィールド | 説明 | タイプ |
| ステータス・コード | 操作の結果。HTTPステータスコードはコネクタから返され、カードが実行したアクションが成功したか失敗したかを示します。例えば
返されるステータス・コードの詳細については、Get UserおよびUpdate UserのAPIドキュメントを参照してください。 |
番号 |
| エラーメッセージ |
エラーが発生した場合、エラーメッセージが返されます。 返されるエラー・メッセージの詳細については、Get UserおよびUpdate UserのAPIドキュメントを参照してください。 |
カスタムAPIアクション
Secure Code Warrior REST API に認証済みのカスタム API リクエストを送信するには、Custom API Action を使用します。
オプション
| フィールド | 説明 | タイプ | 必須 |
|
リクエスト・タイプ |
API呼び出しに使用するHTTPリクエスト・タイプ。許可される値はGETとPOSTです。 |
ドロップダウン | 真 |
入力
| フィールド | 説明 | タイプ | 必須 |
| 相対URL |
対話しようとしているウェブサーバーのアドレス。つまり、プロトコル、ホスト、APIバージョンのパス(例: https://portal-api.securecodewarrior.com/api/v2)を指定する必要はありません。指定する値は "/" で始まる必要があります。 |
文字列 | 真 |
| ヘッダー | カスタム API 呼び出しに含めるカスタムヘッダを表す JSON オブジェクト。 | オブジェクト | True |
| クエリ | カスタム API 呼び出しに含まれるクエリパラメータを表す JSON オブジェクト。 | オブジェクト | True |
| ボディ | カスタム API 呼び出しに含まれる HTTP リクエストボディを表す JSON オブジェクト。 | オブジェクト | 真 |
出力
| フィールド | 説明 | タイプ |
| ステータスコード |
APIコールの成功または失敗を示すHTTPレスポンス・ステータス・コード。使用可能なステータスコードの詳細については、このリストを参照してください。 |
数 |
| ヘッダー |
API コールのレスポンスに含まれる HTTP ヘッダーを表す JSON オブジェクト。 |
オブジェクト |
| ボディ |
カスタムAPIリクエストから返されるデータ。構造は呼び出されたAPIエンドポイントによって異なります。詳細については、Secure Code Warrior Platform API ドキュメントを参照してください。 |
オブジェクト |
コメント
0件のコメント
記事コメントは受け付けていません。