Azure AD（Entra ID）

Azure AD（Entra ID）コネクタを使用すると、Azure Active Directory に対して挿入、削除、更新、読み取りのオペレーションを実行できます。

始める前に

Azure AD（Entra ID）コネクタを使用する前に、次の作業を行います。

  • Google Cloud プロジェクトで次の操作を行います。
    • コネクタを構成するユーザーに roles/connectors.admin IAM ロールを付与します。
    • コネクタに使用するサービス アカウントに、次の IAM ロールを付与します。
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      サービス アカウントは特別なタイプの Google アカウントで、Google API のデータにアクセスするのに認証を受ける必要がある人間以外のユーザーを表します。サービス アカウントがない場合は、サービス アカウントを作成する必要があります。詳細については、サービス アカウントを作成するをご覧ください。

    • 次のサービスを有効にします。
      • secretmanager.googleapis.com（Secret Manager API）
      • connectors.googleapis.com（Connectors API）

      サービスを有効にする方法については、サービスを有効にするをご覧ください。

    以前にプロジェクトでこうしたサービスを有効にしていない場合は、コネクタを構成するときにそれを有効にすることを求められます。

コネクタを構成する

コネクタを構成するには、データソース（バックエンド システム）への接続を作成する必要があります。接続はデータソースに特有です。つまり、多数のデータソースがある場合は、データソースごとに別々の接続を作成する必要があります。接続を作成する手順は次のとおりです。

  1. Cloud コンソールで、[Integration Connectors] > [接続] ページに移動し、Google Cloud プロジェクトを選択または作成します。

    [接続] ページに移動

  2. [+ 新規作成] をクリックして [接続の作成] ページを開きます。
  3. [ロケーション] セクションで、接続のロケーションを選択します。
    1. リージョン: プルダウン リストからロケーションを選択します

      コネクタをサポートしているリージョンは次のとおりです。

      サポートされているすべてのリージョンの一覧については、ロケーションをご覧ください。

    2. [次へ] をクリックします。
  4. [接続の詳細] セクションで、次の操作を行います。
    1. コネクタ: 使用可能なコネクタのプルダウン リストから [Azure AD（Entra ID）] を選択します。
    2. コネクタのバージョン: 使用可能なバージョンのプルダウン リストからコネクタのバージョンを選択します。
    3. [接続名] フィールドに、接続インスタンスの名前を入力します。

      接続名は次の条件を満たす必要があります。

      • 接続名には英字、数字、ハイフンを使用できます。
      • 文字は小文字のみを使用できます。
      • 接続名の先頭には英字を設定し、末尾には英字または数字を設定する必要があります。
      • 接続名は 49 文字以内で指定してください。
    4. 必要に応じて、接続インスタンスの [説明] を入力します。
    5. サービス アカウント: 必要なロールを持つサービス アカウントを選択します。
    6. 必要に応じて、接続ノードの設定を構成します。

      • ノードの最小数: 接続ノードの最小数を入力します。
      • ノードの最大数: 接続ノードの最大数を入力します。

      ノードは、トランザクションを処理する接続の単位（またはレプリカ）です。1 つの接続でより多くのトランザクションを処理するには、より多くのノードが必要になります。逆に、より少ないトランザクションを処理するには、より少ないノードが必要になります。ノードがコネクタの料金に与える影響については、接続ノードの料金をご覧ください。値を入力しない場合は、デフォルトで最小ノード数は 2 に設定され（可用性を高めるため）、最大ノード数は 50 に設定されます。

    7. Azure テナント: データへのアクセスに使用されている Microsoft Online テナント。指定しない場合は、デフォルトのプロジェクトが使用されます。
    8. 必要に応じて、[+ ラベルを追加] をクリックして Key-Value ペアの形式でラベルを接続に追加します。
    9. [次へ] をクリックします。
  5. [認証] セクションで、認証の詳細を入力します。
    1. [認証タイプ] を選択し、関連する詳細を入力します。

      Azure AD（Entra ID）接続でサポートされる認証タイプは次のとおりです。

      • Azure AD（認証コード付与タイプ）
      • OAuth 2.0 - クライアント認証情報
      • JWT Bearer を使用した OAuth 2.0 クライアント認証情報

      2. これらの認証タイプの構成方法については、認証を構成するをご覧ください。

    2. [次へ] をクリックします。
  6. Review: 接続と認証の詳細を確認します。
  7. [作成] をクリックします。

認証を構成する

使用する認証に基づいて詳細を入力します。

  • Azure AD（認証コード付与タイプ）
    • クライアント ID: アクセス トークンのリクエストに使用されるクライアント ID。
    • スコープ: 必要なスコープのカンマ区切りのリスト。
    • クライアント シークレット: アクセス トークンのリクエストに使用されるクライアント シークレット。
    • シークレットのバージョン: クライアント シークレットのバージョン。
    • 承認 URL: クライアントの作成時に生成された承認 URL
  • OAuth 2.0 - クライアント認証情報
    • クライアント ID: 作成したアプリに Azure AD から提供されたクライアント ID（Entra ID）。
    • クライアント シークレット: 作成した接続されているアプリのクライアント シークレットを含む Secret Manager のシークレットです。
    • シークレットのバージョン: クライアント シークレットのバージョン。
  • JWT ベアラ付きの OAuth 2.0 クライアント認証情報
    • 秘密鍵: PEM 形式の秘密鍵ファイルの内容を格納する Secret Manager のシークレット。秘密鍵は公開鍵/証明書と一致する必要があります。
    • 秘密鍵パスワード: 秘密鍵ファイルのパスワード（言い回し）を含む Secret Manager の Secret。
    • シークレットのバージョン: 秘密鍵シークレットのバージョン。
    • クライアント ID: アクセス トークンのリクエストに使用されるクライアント ID。

接続構成のサンプル

Azure AD（Entra ID）接続を作成する前に、Azure Portal または Microsoft Entra ID でアプリケーションを作成します。詳細については、クイックスタート: Microsoft Identity Platform にアプリケーションを登録すると Microsoft Entra ID にクライアント アプリケーションを登録するをご覧ください。

このセクションでは、Azure AD（Entra ID）接続を作成するときに構成するさまざまなフィールドのサンプル値を示します。

Azure AD（認証コード付与タイプ）の接続タイプ

フィールド名 詳細
ロケーション europe-west1
コネクタ Azure AD（Entra ID）
コネクタのバージョン 1
接続名 azure-ad-connection
Cloud Logging を有効にする ○
サービス アカウント XXXX@serviceaccount
Azure テナント 9b25e811-f983-4982-82e4-263c1ca48112
ノードの最小数 2
ノードの最大数 50
認証 ○
Azure AD ○
クライアント ID XXXX
範囲 https://graph.microsoft.com/user.read
クライアント シークレット XXXX
シークレットのバージョン 1
認証 URL https://login.microsoftonline.com/9b25e811-f983-4982-82e4-263c1ca48112/oauth2/v2.0/authorize
スコープ フィールドの値を指定する前に、次のことを確認します。
  • 接続レベルと Azure アプリレベルで User.Read.All 権限と User.Write.All 権限を指定する必要があります。
  • 残りのスコープは、要件に応じて Azure AD アプリの登録レベルと接続レベルの両方で追加できます。
  • 委任された権限とアプリケーション権限の両方で、権限がアプリケーション レベルで追加されていることを確認します。よく使用されるスコープは次のとおりです。
    • https://graph.microsoft.com/group.readwrite.all
    • https://graph.microsoft.com/groupmember.readwrite.all
    • https://graph.microsoft.com/user.read.all
    • https://graph.microsoft.com/user.read
    • https://graph.microsoft.com/directory.readwrite.all
    • https://graph.microsoft.com/RoleManagement.ReadWrite.Directory
    • https://graph.microsoft.com/directory.accessasuser.all
    • https://graph.microsoft.com/domain.readwrite.all
    • https://graph.microsoft.com/device.read.all
    • https://graph.microsoft.com/RoleManagement.Read.Directory
    • https://graph.microsoft.com/organization.Read.all
    • https://graph.microsoft.com/Application.ReadWrite.all
    • https://graph.microsoft.com/AuditLog.Read.All
    • https://graph.microsoft.com/DeviceLocalCredential.Read.All.

OAuth 2.0 クライアント認証情報の接続タイプ

フィールド名 詳細
ロケーション us-central1
コネクタ Azure AD（Entra ID）
コネクタのバージョン 1
接続名 azure-ad-client-credentials
Cloud Logging を有効にする ○
サービス アカウント XXXX@serviceaccount
Azure テナント 9b25e811-f983-4982-82e4-263c1ca48112
ノードの最小数 2
ノードの最大数 50
認証 ○
OAuth 2.0 - クライアント シークレットを含むクライアント認証情報 ○
クライアント ID XXXX
クライアント シークレット XXXX
シークレットのバージョン 1

JWT Bearer 接続タイプを使用した OAuth 2.0 クライアント認証情報

フィールド名 詳細
ロケーション europe-west1
コネクタ Azure AD（Entra ID）
コネクタのバージョン 1
接続名 azure-jwt
Cloud Logging を有効にする ○
サービス アカウント XXXX@serviceaccount
Azure テナント 9b25e811-f983-4982-82e4-263c1ca48112
ノードの最小数 2
ノードの最大数 50
認証 ○
OAuth 2.0 - JWT ベアラーを使用したクライアント認証情報 ○
秘密鍵 XXXX
シークレットのバージョン 1
クライアント ID XXXX
JWT ベアラー接続タイプで OAuth 2.0 クライアント認証情報を使用する場合は、次のタスクを完了します。
  • 自己署名証明書を作成し、秘密鍵証明書と公開鍵の両方をダウンロードします。詳細については、自己署名証明書を作成するをご覧ください。
  • Azure AD アプリケーションの [証明書とシークレット] で公開鍵証明書をアップロードします。
  • 秘密鍵フィールドで、秘密鍵証明書の値と公開鍵証明書の値の両方を 1 つの秘密鍵で渡します。秘密鍵と公開鍵に個別のシークレットを作成する必要はありません。

Postman を使用して接続を確立する方法については、API を使用した JWT 接続をご覧ください。

認証コードの再認可

Authorization code 認証タイプを使用しているユーザーが、Azure AD アプリケーションの構成を変更した場合は、Azure AD（Entra ID）接続を再認可する必要があります。接続を再認可するには、次の手順を行います。

  1. [接続] ページで必要な接続をクリックします。

    これにより、[接続の詳細] ページが開きます。

  2. [編集] をクリックして、接続の詳細を編集します。
  3. [認証] セクションで [OAuth 2.0 - 認証コード] の詳細を確認します。

    必要に応じて必要な変更を加えます。

  4. [保存] をクリックします。接続の詳細ページに移動します。
  5. [認証] セクションで [承認の編集] をクリックします。これにより、[承認] ペインが表示されます。
  6. [Authorize（承認）] をクリックします。

    認可が成功すると、[接続] ページの接続ステータスが「有効」に設定されます。

接続作成後の追加手順

認証に OAuth 2.0 - Authorization code を選択した場合は、接続の作成後に次の追加の手順を行う必要があります。

  1. 接続ページで、新しく作成された接続を見つけます。

    新しいコネクタの [ステータス] は [承認が必要] になります。

  2. [承認が必要] をクリックします。

    これにより、[承認の編集] ペインが表示されます。

  3. [リダイレクト URI] の値を外部アプリケーションにコピーします。
  4. 認可の詳細を確認します。
  5. [Authorize（承認）] をクリックします。

    認可が成功すると、[接続] ページの接続ステータスが「有効」に設定されます。

エンティティ、オペレーション、アクション

すべての Integration Connectors が、接続されたアプリケーションのオブジェクトを抽象化するレイヤを提供します。アプリケーションのオブジェクトには、この抽象化を通じてのみアクセスできます。抽象化は、エンティティ、オペレーション、アクションとして公開されます。

  • エンティティ: エンティティは、接続されているアプリケーションやサービスのオブジェクト、またはプロパティのコレクションと考えることができます。エンティティの定義は、コネクタによって異なります。たとえば、データベース コネクタでは、テーブルがエンティティであり、ファイル サーバー コネクタでは、フォルダがエンティティです。また、メッセージング システム コネクタでは、キューがエンティティです。

    ただし、コネクタでいずれのエンティティもサポートされていない、またはエンティティが存在しない可能性があります。その場合、Entities リストは空になります。

  • オペレーション: エンティティに対して行うことができるアクティビティです。エンティティに対して次のいずれかのオペレーションを行うことができます。

    使用可能なリストからエンティティを選択すると、そのエンティティで使用可能なオペレーションのリストが生成されます。オペレーションの詳細については、コネクタタスクのエンティティ オペレーションをご覧ください。ただし、コネクタがいずれかのエンティティ オペレーションをサポートしていない場合、サポートされていないオペレーションは Operations リストに含まれません。

  • アクション: コネクタ インターフェースを介して統合で使用できる主要な関数の一つです。アクションを使用すると、1 つまたは複数のエンティティに対して変更を加えることができます。また、使用できるアクションはコネクタごとに異なります。通常、アクションには入力パラメータと出力パラメータがあります。ただし、コネクタがどのアクションもサポートしていない可能性があります。その場合は、Actions リストが空になります。

システムの上限

Azure AD（Entra ID）コネクタは、ノードごとに 1 秒あたり 5 件のトランザクションを処理することができ、この上限を超えるトランザクションはすべてスロットルされます。デフォルトでは、Integration Connectors は、接続に 2 つのノードを割り当てます（可用性を高めるため）。

Integration Connectors に適用される上限の詳細については、上限をご覧ください。

アクション

このセクションでは、コネクタでサポートされているアクションを一覧表示します。アクションの構成方法については、アクションの例をご覧ください。

AddGroupMember アクション

このアクションは、グループにメンバーを追加します。

AddGroupMember アクションの入力パラメータ

パラメータ名 データ型 必須 説明
MemberId 文字列 ○ メンバーの固有識別子。
GroupId 文字列 ○ グループの固有識別子。

このアクションの構成方法の例については、アクションの例をご覧ください。

RemoveGroupMember アクション

このアクションにより、グループからメンバーが削除されます。

RemoveGroupMember アクションの入力パラメータ

パラメータ名 データ型 必須 説明
MemberId 文字列 ○ メンバーの固有識別子。
GroupId 文字列 ○ グループの固有識別子。

このアクションの構成方法の例については、例をご覧ください。

AddGroupMember（ゲスト アカウント）アクション

このアクションは、グループにメンバーを追加します。

AddGroupMember アクションの入力パラメータ

パラメータ名 データ型 必須 説明
MemberId 文字列 ○ メンバーの固有識別子。
GroupId 文字列 ○ グループの固有識別子。

このアクションの構成方法の例については、例をご覧ください。

RemoveGroupMember（ゲスト アカウント）アクション

この操作により、グループからメンバーが削除されます

RemoveGroupMember アクションの入力パラメータ

パラメータ名 データ型 必須 説明
MemberId 文字列 ○ メンバーの固有識別子。
GroupId 文字列 ○ グループの固有識別子。

このアクションの構成方法の例については、例をご覧ください。

AddUserApplicationRoleAssignment アクション

このアクションにより、ユーザーがアプリケーションロールの割り当てに追加されます。

AddUserApplicationRoleAssignment アクションの入力パラメータ

パラメータ名 データ型 必須 説明
ResourceId 文字列 ○ リソースの固有識別子。
AppRoleId 文字列 ○ アプリロールの固有識別子。
UserId 文字列 ○ ユーザーの固有識別子。

このアクションの構成方法の例については、例をご覧ください。

RemoveUserApplicationRoleAssignment アクション

この操作を行うと、アプリケーション ロールの割り当てからユーザーが削除されます。

RemoveUserApplicationRoleAssignment アクションの入力パラメータ

パラメータ名 データ型 必須 説明
AppRoleAssignmentId 文字列 ○ アプリロールの割り当ての固有識別子。
UserId 文字列 ○ ユーザーの固有識別子。

このアクションの構成方法の例については、例をご覧ください。

AddGroupApplicationRoleAssignment アクション

このアクションにより、グループがアプリケーション ロールの割り当てに追加されます。/p>

AddGroupApplicationRoleAssignment アクションの入力パラメータ

パラメータ名 データ型 必須 説明
ResourceId 文字列 ○ リソースの固有識別子。
AppRoleId 文字列 ○ アプリロールの固有識別子。
GroupId 文字列 ○ グループの固有識別子。

このアクションの構成方法の例については、例をご覧ください。

RemoveGroupApplicationRoleAssignment アクション

このアクションにより、アプリケーション ロールの割り当てからグループが削除されます。

RemoveGroupApplicationRoleAssignment アクションの入力パラメータ

パラメータ名 データ型 必須 説明
AppRoleAssignmentId 文字列 ○ アプリロールの割り当ての固有識別子。
GroupId 文字列 ○ グループの固有識別子。

このアクションの構成方法の例については、例をご覧ください。

ActivateDirectoryRole アクション

このアクションにより、ディレクトリ ロールが有効になります。

ActivateDirectoryRole アクションの入力パラメータ

パラメータ名 データ型 必須 説明
RoleTemplateId 文字列 ○ ロールの基礎となった directoryRoleTemplate の ID。

このアクションの構成方法の例については、例をご覧ください。

VerifyDomain アクション

このアクションはドメインを検証します。

VerifyDomain アクションの入力パラメータ

パラメータ名 データ型 必須 説明
ID 文字列 ○ 検証するドメインの ID。

このアクションの構成方法の例については、例をご覧ください。

ChangePassword アクション

このアクションは、ユーザーのパスワードを変更します。

ChangePassword アクションの入力パラメータ

パラメータ名 データ型 必須 説明
NewPassword 文字列 ○ ユーザーの新しいパスワード。
CurrentPassword 文字列 ○ ユーザーの現在のパスワード。

このアクションの構成方法の例については、例をご覧ください。

ResetPassword アクション

この操作を行うと、ユーザーのパスワードが再設定されます。

ResetPassword アクションの入力パラメータ

パラメータ名 データ型 必須 説明
パスワード 文字列 ○ ユーザーが送信したパスワード（再設定に使用）。空白のままにすると、システムで生成されたパスワードが作成されます。
UserId 文字列 ○ ユーザーの固有識別子。

このアクションの構成方法の例については、例をご覧ください。

AssignLicense アクション

このアクションは、ユーザーにライセンスを割り当てます。

AssignLicense アクションの入力パラメータ

パラメータ名 データ型 必須 説明
UserPrincipalName 文字列 ○ ライセンスを割り当てる必要があるユーザーのプリンシパル名。ログインしたユーザー名は指定しないでください。
UserId 文字列 ○ ライセンスを割り当てる必要があるユーザーの ID。ログインに使用したユーザー名は提供しないでください。
AddLicenseSkuId 文字列 ○ SKU の固有識別子。
DisabledPlans 文字列 × 無効化されたプランのカンマ区切りの固有識別子のコレクション。
RemoveLicenses 文字列 × 削除するライセンスを識別する GUID のカンマ区切りのコレクション。

このアクションの構成方法の例については、例をご覧ください。

RemoveLicense アクション

この操作を行うと、ユーザーに割り当てられたライセンスが削除されます。

RemoveLicense アクションの入力パラメータ

パラメータ名 データ型 必須 説明
UserPrincipalName 文字列 ○ ライセンスを割り当てる必要があるユーザーのプリンシパル名。ログインに使用したユーザー名は提供しないでください。
UserId 文字列 ○ ライセンスを割り当てる必要があるユーザーの ID。ログインに使用したユーザー名は提供しないでください。
AddLicenseSkuId 文字列 × SKU の固有識別子。
DisabledPlans 文字列 × 無効化されたプランのカンマ区切りの固有識別子のコレクション。
RemoveLicenses 文字列 ○ 削除するライセンスを識別する GUID のカンマ区切りのコレクション。

このアクションの構成方法の例については、例をご覧ください。

FetchAdditionalUserFields アクション

このアクションは、必須の属性フィールドを取得します。

FetchAdditionalUserFields アクションの入力パラメータ

パラメータ名 データ型 必須 説明
UserId 文字列 ○ ユーザーの固有識別子。

このアクションの構成方法の例については、例をご覧ください。

AddGroupOwner アクション

このアクションでは、グループにオーナーを追加します。

AddGroupOwner アクションの入力パラメータ

パラメータ名 データ型 必須 説明
GroupId 文字列 ○ グループの固有識別子。
OwnerId 文字列 ○ オーナーの固有識別子。

このアクションの構成方法の例については、例をご覧ください。

RemoveGroupOwner アクション

このアクションにより、グループ オーナーが削除されます。

RemoveGroupOwner アクションの入力パラメータ

パラメータ名 データ型 必須 説明
GroupId 文字列 ○ グループの固有識別子。
OwnerId 文字列 ○ オーナーの固有識別子。

このアクションの構成方法の例については、例をご覧ください。

InviteExternalUser アクション

このアクションは、外部ユーザーを組織に招待します。

InviteExternalUser アクションの入力パラメータ

パラメータ名 データ型 必須 説明
UserEmailAddress 文字列 ○ 招待するユーザーのメールアドレス。
RedirectURL 文字列 ○ 利用後にユーザーがリダイレクトされる URL。

このアクションの構成方法の例については、例をご覧ください。

AddPhoneAuthenticationMethod アクション

このアクションにより、ユーザーは特定のタスクを実行できます。

AddPhoneAuthenticationMethod アクションの入力パラメータ

パラメータ名 データ型 必須 説明
UserID 文字列 ○ スマートフォン認証方法を追加するユーザーの ID。
PhoneNumber 文字列 ○ 認証方法の電話番号。
PhoneType 文字列 ○ 認証方法のスマートフォンの種類。有効な値は、mobile、alternateMobile、office です。

このアクションの構成方法の例については、例をご覧ください。

RemovePhoneAuthenticationMethod アクション

この操作を行うと、ユーザーのスマートフォン認証方法が削除されます。

RemovePhoneAuthenticationMethod アクションの入力パラメータ

パラメータ名 データ型 必須 説明
UserID 文字列 ○ スマートフォン認証方法を削除するユーザーの ID。ログインに使用したユーザー名は提供しないでください。
ID 文字列 ○ phoneType に対応する電話メソッド ID。

このアクションの構成方法の例については、例をご覧ください。

UpdatePhoneAuthenticationMethod アクション

このアクションにより、ユーザーのスマートフォン認証方法が更新されます。

UpdatePhoneAuthenticationMethod アクションの入力パラメータ

パラメータ名 データ型 必須 説明
UserID 文字列 ○ 電話認証方法を更新するユーザーの ID。
ID 文字列 ○ phoneType に対応する電話メソッド ID。
PhoneNumber 文字列 ○ 認証方法の電話番号。

このアクションの構成方法の例については、例をご覧ください。

AddPrivilegedRole アクション

このアクションは、ユーザーに特権ロールを追加します。

AddPrivilegedRole アクションの入力パラメータ

パラメータ名 データ型 必須 説明
PrincipalId 文字列 ○ ロールの利用資格が付与されているプリンシパルの ID。
RoleDefinitionId 文字列 ○ プリンシパルに割り当てられている unifiedRoleDefinition オブジェクトの ID。
理由 文字列 ○ ユーザーと管理者が提供するメッセージ。
ScheduleInfo 文字列 ○ ロールの利用資格の期間。

このアクションの構成方法の例については、例をご覧ください。

RemovePrivilegedRole アクション

このアクションにより、ユーザーの権限ロールが削除されます。<

RemovePrivilegedRole アクションの入力パラメータ

パラメータ名 データ型 必須 説明
PrincipalId 文字列 ○ ロールの利用資格が付与されているプリンシパルの ID。
RoleDefinitionId 文字列 ○ プリンシパルから削除される unifiedRoleDefinition オブジェクトの ID。
理由 文字列 ○ ユーザーと管理者が提供するメッセージ。

RetrieveUserPhoto アクション

このアクションはユーザーの写真を取得します。

RetrieveUserPhoto アクションの入力パラメータ

パラメータ名 データ型 必須 説明
UserId 文字列 ○ ダウンロードするファイルの ID。
FileLocation 文字列 × ファイルの保存場所。ファイルの完全なパスとファイル名を指定します。
エンコード 文字列 × FileData 入力のエンコード タイプ。
FileStream 文字列 × ファイルデータが書き込まれる出力ストリームのインスタンス。FileLocation が指定されていない場合にのみ使用されます。

このアクションの構成方法の例については、例をご覧ください。

UpdateUserPhoto アクション

このアクションは、ユーザーの写真を更新します。

UpdateUserPhoto アクションの入力パラメータ

パラメータ名 データ型 必須 説明
LocalFile 文字列 × アップロードする写真を含むローカル ファイルの場所。ファイルの完全なパスとファイル名を指定します。
ContentStream 文字列 × localpath または folderpath が指定されていない場合にアップロードする InputStream としてのコンテンツ
UserId 文字列 ○ ユーザの ID
コンテンツ 文字列 ○ アップロードする写真コンテンツ。

このアクションの構成方法の例については、例をご覧ください。

RemoveUserPhoto アクション

この操作を行うと、ユーザーの写真が削除されます。

RemoveUserPhoto アクションの入力パラメータ

パラメータ名 データ型 必須 説明
UserId 文字列 ○ ユーザの ID

このアクションの構成方法の例については、例をご覧ください。

AssignManager アクション

このアクションは、特定のユーザーにマネージャーを割り当てます。

AssignManager アクションの入力パラメータ

パラメータ名 データ型 必須 説明
ObjectId 文字列 ○ オブジェクトの固有識別子。
ObjectName 文字列 ○ 追加する directoryObject、ユーザー、組織の連絡先オブジェクト。
UserId 文字列 ○ ユーザーの固有識別子。

このアクションの構成方法の例については、例をご覧ください。

RemoveManager アクション

この操作を行うと、ユーザーに割り当てられたマネージャーが削除されます。

RemoveManager アクションの入力パラメータ

パラメータ名 データ型 必須 説明
UserId 文字列 ○ ユーザーの固有識別子。

このアクションの構成方法の例については、例をご覧ください。

RetrieveManagerChain アクション

このアクションは、ユーザーのマネージャーを取得します。

RetrieveManagerChain アクションの入力パラメータ

パラメータ名 データ型 必須 説明
レベル 文字列 ○ 取得するマネージャーの階層レベルの数。max を指定すれば、すべてのマネージャーを返します。
UserId 文字列 ○ ユーザーの ID。

このアクションの構成方法の例については、例をご覧ください。

AddProfileCardProperty アクション

このアクションは、組織に新しい ProfileCardProperty を追加します。

AddProfileCardProperty アクションの入力パラメータ

パラメータ名 データ型 必須 説明
DirectoryPropertyName 文字列 ○ profileCardProperty リソースを識別します。
アノテーション 文字列 ○ 管理者がディレクトリ プロパティにカスタム表示ラベルを設定できるようにします。

このアクションの構成方法の例については、例をご覧ください。

RemoveProfileCardProperty アクション

このアクションは、組織の ProfileCardProperty を削除します。

RemoveProfileCardProperty アクションの入力パラメータ

パラメータ名 データ型 必須 説明
DirectoryPropertyName 文字列 ○ profileCardProperty リソースを識別します。

このアクションの構成方法の例については、例をご覧ください。

アクションの例

このセクションでは、このコネクタでいくつかのアクションを実行する方法について説明します。

例 - AddGroupMember

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [AddGroupMember] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "MemberId": "5408040c-fb7d-4c36-8b67-3b66e9edaad3",
  "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100"
  }

    4. このアクションは、AddGroupMember の確認メッセージを返します。アクションが成功すると、AddGroupMember タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    [{
  "Success": "True"
  }]

例 - RemoveGroupMember

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [RemoveGroupMember] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "MemberId": "5408040c-fb7d-4c36-8b67-3b66e9edaad3",
  "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100"
  }

    4. アクションが成功すると、RemoveGroupMember タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    [{
  "Success": "True"
  }]

例 - AddGroupMember（ゲスト アカウント）

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [AddGroupMember] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "MemberId": "735fac93-32df-45c9-b6a3-beee95270a6a",
  "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100"
  }

    4. アクションが成功すると、AddGroupMember タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    [{
  "Success": "True"
  }]

例 - RemoveGroupMember（ゲスト アカウント）

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [RemoveGroupMember] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "MemberId": "735fac93-32df-45c9-b6a3-beee95270a6a",
  "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100"
  }

    4. アクションが成功すると、RemoveGroupMember タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    [{
  "Success": "True"
  }]

例 - AddUserApplicationRoleAssignment

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [AddUserApplicationRoleAssignment] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "UserId": "3558ca6e-2c2e-41d3-a854-bf9249a3c913",
  "ResourceId": "3a914726-ab97-49a0-ab7d-4f742fbc271e",
  "AppRoleId": "820afb79-d975-4da7-8f29-0e2c0cff1217"
  }

    4. アクションが成功すると、AddUserApplicationRoleAssignment タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    [{
  "Success": "True"
  }]

例 - RemoveUserApplicationRoleAssignment

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [RemoveUserApplicationRoleAssignment] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "UserId": "3558ca6e-2c2e-41d3-a854-bf9249a3c913",
  "AppRoleAssignmentId": "bspYNS4s00GoVL-SSaPJE0xC2--0GxxIu8uS4aeindU"
  }

    4. アクションが成功すると、RemoveUserApplicationRoleAssignment タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    [{
  "Success": "True"
  }]

例 - AddGroupApplicationRoleAssignment

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [AddGroupApplicationRoleAssignment] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "ResourceId": "3a914726-ab97-49a0-ab7d-4f742fbc271e",
  "AppRoleId": "820afb79-d975-4da7-8f29-0e2c0cff1217",
  "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100"
  }

    4. アクションが成功すると、AddGroupApplicationRoleAssignment タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    [{
  "Success": "True"
  }]

例 - RemoveGroupApplicationRoleAssignment

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [RemoveGroupApplicationRoleAssignment] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100",
  "AppRoleAssignmentId": "p3luD3g1tEid3t7Pu3uxAMT7DwI3p29HlrxMuZ143eU"
  }

    4. アクションが成功すると、RemoveGroupApplicationRoleAssignment タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    [{
  "Success": "True"
  }]

例 - ActivateDirectoryRole

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [ActivateDirectoryRole] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
     {
  "RoleTemplateId": "f023fd81-a637-4b56-95fd-791ac0226033"
  }

    4. アクションが成功すると、ActivateDirectoryRole タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    [{
  "id": "c865d9cb-57da-416c-97a3-753e733da678",
  "roleTemplateId": "f023fd81-a637-4b56-95fd-791ac0226033",
  "displayName": "Service Support Administrator",
  "description": "Can read service health information and manage support tickets."
  }]

例 - VerifyDomain

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [VerifyDomain] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "Id": "eternalsolarsolutions.com"
  }

    4. アクションが成功すると、VerifyDomain タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    [{
  "Success": "True"
  }]

例 - ChangePassword

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [ChangePassword] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "NewPassword": "XXX@9876",
  "CurrentPassword": "XXX@123"
  }

    4. アクションが成功すると、ChangePassword タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    [{
  "Success": "True"
  }]

例 - ResetPassword

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [ResetPassword] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "Password": "XXX@9876",
  "UserId": "3558ca6e-2c2e-41d3-a854-bf9249a3c913"
  }

    4. アクションが成功すると、ResetPassword タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    [{
  "Success": "True"
  }]

例 - AssignLicense

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [AssignLicense] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "UserID": "3558ca6e-2c2e-41d3-a854-bf9249a3c913",
  "UserPrincipalName": "Gcp_test@z8474.onmicrosoft.com",
  "AddLicenseSkuId": "6ec92958-3cc1-49db-95bd-bc6b3798df71"
  }

    4. アクションが成功すると、AssignLicense タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    [{
  "Success": "True"
  }]

例 - RemoveLicense

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [AssignLicense] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "UserID": "3558ca6e-2c2e-41d3-a854-bf9249a3c913",
  "UserPrincipalName": "Gcp_test@z8474.onmicrosoft.com",
  "RemoveLicenses": "6ec92958-3cc1-49db-95bd-bc6b3798df71"
  }

    4. アクションが成功すると、RemoveLicense タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    [{
  "Success": "True"
  }]

例 - FetchAdditionalUserFields

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [FetchAdditionalUserFields] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "UserId": "9630c9d7-cf15-4406-8d21-598e41a058cc"
  }

    4. アクションが成功すると、FetchAdditionalUserFields タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    [{
    "id": "9630c9d7-cf15-4406-8d21-598e41a058cc",
    "deleteddatetime": null,
    "accountenabled": "true",
    "agegroup": null,
    "businessphones": "",
    "city": null,
    "companyname": null,
    "consentprovidedforminor": null,
    "country": null,
    "createddatetime": "2024-04-12T10:24:42Z",
    "creationtype": null,
    "department": null,
    "displayname": "Azure_AD_Test",
    "employeehiredate": null,
    "employeeid": null,
    "employeeleavedatetime": null,
    "employeetype": null,
    "externaluserstate": null,
    "externaluserstatechangedatetime": null,
    "faxnumber": null,
    "givenname": null,
    "imaddresses": "",
    "isresourceaccount": null,
    "jobtitle": null,
    "lastpasswordchangedatetime": "2024-05-14T05:07:15Z",
    "legalagegroupclassification": null,
    "mail": null,
    "mailnickname": "Azure_AD_Test",
    "mobilephone": null,
    "officelocation": null,
    "onpremisesdistinguishedname": null,
    "onpremisesdomainname": null,
    "onpremisesimmutableid": null,
    "onpremiseslastsyncdatetime": null,
    "onpremisessamaccountname": null,
    "onpremisessecurityidentifier": null,
    "onpremisessyncenabled": null,
    "onpremisesuserprincipalname": null,
    "othermails": "",
    "passwordpolicies": null,
    "postalcode": null,
    "preferreddatalocation": null,
    "preferredlanguage": null,
    "proxyaddresses": "",
    "securityidentifier": "S-1-12-1-2519779799-1141296917-2388205965-3428360257",
    "showinaddresslist": null,
    "signinsessionsvalidfromdatetime": "2024-05-14T05:07:15Z",
    "state": null,
    "streetaddress": null,
    "surname": null,
    "usagelocation": "IN",
    "userprincipalname": "Azure_AD_Test@z8474.onmicrosoft.com",
    "usertype": "Member",
    "aboutme": null,
    "birthday": "0001-01-01T08:00:00Z",
    "hiredate": "0001-01-01T08:00:00Z",
    "interests": "",
    "mysite": null,
    "pastprojects": "",
    "preferredname": "",
    "responsibilities": "",
    "schools": "",
    "skills": "",
    "assignedlicenses": "",
    "assignedplans": "[\r\n  {\r\n    \"assignedDateTime\": \"2024-05-16T10:17:45Z\",\r\n    \"capabilityStatus\": \"Deleted\",\r\n    \"service\": \"DynamicsNAV\",\r\n    \"servicePlanId\": \"3f2afeed-6fb5-4bf9-998f-f2912133aead\"\r\n  }\r\n]",
  "authorizationinfo_certificateuserids": "",
  "identities": "[\r\n  {\r\n    \"signInType\": \"userPrincipalName\",\r\n    \"issuer\": \"z8474.onmicrosoft.com\",\r\n    \"issuerAssignedId\": \"Azure_AD_Test@z8474.onmicrosoft.com\"\r\n  }\r\n]",
  "licenseassignmentstates": "",
  "onpremisesextensionattributes_extensionattribute1": null,
  "onpremisesextensionattributes_extensionattribute2": null,
  "onpremisesextensionattributes_extensionattribute3": null,
  "onpremisesextensionattributes_extensionattribute4": null,
  "onpremisesextensionattributes_extensionattribute5": null,
  "onpremisesextensionattributes_extensionattribute6": null,
  "onpremisesextensionattributes_extensionattribute7": null,
  "onpremisesextensionattributes_extensionattribute8": null,
  "onpremisesextensionattributes_extensionattribute9": null,
  "onpremisesextensionattributes_extensionattribute10": null,
  "onpremisesextensionattributes_extensionattribute11": null,
  "onpremisesextensionattributes_extensionattribute12": null,
  "onpremisesextensionattributes_extensionattribute13": null,
  "onpremisesextensionattributes_extensionattribute14": null,
  "onpremisesextensionattributes_extensionattribute15": null,
  "onpremisesprovisioningerrors": "",
  "provisionedplans": "",
  "serviceprovisioningerrors": "",
  "customsecurityattributes": "{\r\n  \"ConnectorTesting\": {\r\n    \"@odata.type\": \"#microsoft.graph.customSecurityAttributeValue\",\r\n    \"FavouriteSport\": \"cricket\",\r\n    \"FavouriteMovie\": \"3 idiots\"\r\n  }\r\n}",
  "signinactivity_lastsignindatetime": "2024-05-14T07:04:51Z",
  "signinactivity_lastsigninrequestid": "ed35b322-d0d9-4fcb-8e71-f9ee7e065e00",
  "signinactivity_lastnoninteractivesignindatetime": "2024-05-15T09:00:02Z",
  "signinactivity_lastnoninteractivesigninrequestid": "0d4ce88b-710a-440f-a612-f590954d6800",
  "signinactivity_lastsuccessfulsignindatetime": "2024-05-15T06:45:42Z",
  "signinactivity_lastsuccessfulsigninrequestid": "64643e9d-3468-4e4d-b7c3-8bd316956600"
  }

例 - AddGroupOwner

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [AddGroupOwner] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100",
  "OwnerId": "9630c9d7-cf15-4406-8d21-598e41a058cc"
  }

    4. アクションが成功すると、AddGroupOwner タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    [{
  "Success": "True"
  }]

例 - RemoveGroupOwner

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [RemoveGroupOwner] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "GroupId": "0f6e79a7-3578-48b4-9dde-decfbb7bb100",
  "OwnerId": "9630c9d7-cf15-4406-8d21-598e41a058cc"
  }

    4. アクションが成功すると、RemoveGroupOwner タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    [{
  "Success": "True"
  }]

例 - InviteExternalUser

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [InviteExternalUser] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "UserEmailAddress": "taleprajyot97@gmail.com",
  "RedirectURL": "https://www.example.com"
  }

    4. このアクションは、InviteExternalUser の確認メッセージを返します。アクションが成功すると、InviteExternalUser タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    [{
  "Success": "True",
  "Id": "70905aef-361f-4cb1-8d04-41f9e377ebd3",
  "ReedemURL": "https://login.microsoftonline.com/redeem?rd=https%3a%2f%2finvitations.microsoft.com%2fredeem%2f%3ftenant%3d9b25e811-f983-4982-82e4-263c1ca48112%26user%3d70905aef-361f-4cb1-8d04-41f9e377ebd3%26ticket%3dx5aOZc%25252bE9XslKcOdb101qLnoe2V%25252b8%25252beeFlNhYA5WvTg%25253d%26ver%3d2.0",
  "InvitedUserId": "d5eeb199-a544-4985-b726-e3073751050c"
  }]

例 - AddPhoneAuthenticationMethod

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [AddPhoneAuthenticationMethod] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "PhoneType": "mobile",
  "UserID": "93e42f0d-74d7-445b-b15a-dd6ceb013d81",
  "PhoneNumber": "+91 9898989890"
  }

    4. アクションが成功すると、AddPhoneAuthenticationMethod タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    [{
  "Success": "True"
  }]

例 - RemovePhoneAuthenticationMethod

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [RemovePhoneAuthenticationMethod] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "PhoneType": "mobile",
  "UserID": "93e42f0d-74d7-445b-b15a-dd6ceb013d81",
  "PhoneNumber": "+91 9898989890"
  }

    4. アクションが成功すると、RemovePhoneAuthenticationMethod タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    [{
  "Success": "True"
  }]

例 - UpdatePhoneAuthenticationMethod

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [UpdatePhoneAuthenticationMethod] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "securityComplianceNotificationPhones": "9899999999",
  "securityComplianceNotificationMails": "abc@gmail.com"
  }

    4. アクションが成功すると、UpdatePhoneAuthenticationMethod タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    [{
  "Success": "True"
  }]

例 - AddPrivilegedRole

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [AddPrivilegedRole] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "PrincipalId": "8cbe82b6-0dd5-4f10-bf67-82bf88ac6cb8",
  "RoleDefinitionId": "729827e3-9c14-49f7-bb1b-9608f156bbb8",
  "Justification": "Add Privileged Role",
  "ScheduleInfo": "{\n\"StartDateTime\" : \"2022-09-09T21:31:27.91Z\",\n\"Expiration\"    : {\n\"Type\"        : \"Eligible\"}\n}"
  }

    4. アクションが成功すると、AddPrivilegedRole タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    [{
  "Success": "True"
  }]

例 - RemovePrivilegedRole

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [RemovePrivilegedRole] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "PrincipalId": "8cbe82b6-0dd5-4f10-bf67-82bf88ac6cb8",
  "RoleDefinitionId": "729827e3-9c14-49f7-bb1b-9608f156bbb8",
  "Justification": "Removing Privileage Role"
  }

    4. アクションが成功すると、RemovePrivilegedRole タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    [{
  "Success": "True"
  }]

例 - RetrieveUserPhoto

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [RetrieveUserPhoto] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "UserId": "8e22c728-c523-436b-8f46-3b21cc1b5f80"
  }

    4. アクションが成功すると、RetrieveUserPhoto タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    [{
    "Status": "Success",
    "FileData": "77+9UE5HDQoaCgAAAA1JSERSAAADUgAAAjYIBgAAAFo077+977+9AAAAAXNSR0IA77+977+9HO+/vQAAAARnQU1BAADvv73vv70L77+9YQUAAAAJcEhZcwAADu+/vQAADu+/vQHvv71v77+9ZAAA77+977+9SURBVHhe77+977+9ZXwcV9K+LWlmZCbvv71O77+977+977+9ZO+/vcmG77+9Ge+/vThmZmZm77+9OO+/vcmG77+977+9MTMzM++/vS0z77+977+977+9eu+/ve+/vXTvv71o77+9KAvvv73vv73vv71w77+9DjRO77+977+9Vl3vv70677+9KWsrR2zvv71zEe+/ve+/vUTvv73vv717KGrvv709EO+/ve+/vWjvv71RG01777+977+9Me+/ve+/vWjvv73vv719OmJLyqfZuu+/vRHvv71ZK++/vQ7Uj9iJ77+977+9du+/vUXEslrvv73vv73vv70uzbzvv70pFu+/vUrvv709Yl4P77+9eu+/vSDvv73vv71n77+977+977+9Gu+/ve+/vV3vv71sP2Vm77+977+9be+/vWbvv707RmxV77+9VFvvv70u77+9Fu+/ve+/vdqi77+9aTbvv71N77+977+9Re+/ve+/vWPvv70tYe+/vRXvv73vv70677+9bu+/vTRbS++/ve+/ve+/vWxkP1vvv71FbWt377+977+9LdW277+977+977+977+977+9ae+/ve+/vXvvv73vv73vv70Z77+9Xe+/vSLvv73vv70X77+977+9E++/vT1ob1/vv71+ae+/ve+/vWx3by1P77+9XT3vv71sL++/ve+/ve+/vWbvv73vv73vv71m77+9F+e0s2vvv712dErvv73vv73vv73vv73vv73vv71p77+977+9Le+/vW/vv73vv71oZ0vvv73vv70577+9R3tb77+92b7vv70R77+977+9KmIHKQ/vv73vv73agdapdu+/vU3vv73vv73vv73vv73vv71zXe+/ve+/ve+/ve+/ve+/vRTvv70777+977+977+96pqK77+9LO+/vXN077+9PO+/ve+/ve+/vVp2f++/vdOgNO+/ve+/veyBlO+/ve+/vQdQ77+9cO+/vTc477+9bBDvv71S77+977+977+977+9Zu+/ve+/vW8I77+977+977+9ZQ8paFnvv70LWnxwYe+/ve+/vVEWNBvvv71O77+977+9eQMKW++/vV8x77+977+9FO+/vd6k77+977+9LmHvv70eRS3erQBiG++/vXXvv71DzLI577+9LO+/vT3vv73vv71077+9Ze+/ve+/ve+/vTcebe+/vWbvv73vv71E77+9UEPvv71r77+9NMus77+9Zu+/ve+/vUVsXe+/ve+/ve+/ve+/ve+/vWZr77+9c29qRG0177+9VdWi77+977+9eu+/ve+/ve+/vUlfTe+/ve+/vW/vv73NujVTbX3vv73vv73vv73vv70V77+9He+/ve+/vXUj77+977+9AdeeMe+/ve+/ve+/ve+/ve+/ve+/vQHvv73vv70Y77+9aFcj77+9Y2Pvv700Zjtpb2vvv73vv73vv73vv73ZmHvXnHvvv70Y77+904Lvv73vv70y77+977+9EO+/ve+/vRjvv73vv71077+9dDvbs++/ve+/vXsX4bqU77+9Wu+/vVsH77+977+977+977+9P1vvv73vv70y77+9fO+/ve+/vV8pZd6rJe+/vXvvv70cy6Yef++/ve+/vWXvv71U1LJf77+9Wg3vv73vv71j1otF77+9NO+/ve+/vQTvv73vv70A77+9SO+/vWZHD++/vQ3vv71ta++/ve+/ve+/veO+rmDvv73vv73vv71c77+9cD1+77+9Hu+/ve+/vSpG77+977+9Y++/ve+/vWfvv73vv73vv70zMXvvv73vv73vv73
  ...[too long to view on UI. Please use the API to view the full content.]

例 - UpdateUserPhoto

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [UpdateUserPhoto] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "UserId": "9630c9d7-cf15-4406-8d21-598e41a058cc",
  "Content": "iVBORw0KGgoAAAANSUhEUgAAA1IAAAI2CAIAAADVVi6oAAAgAElEQVR4AZy9d3Rc1dX3r3POHVmWrG6ckIQHN0gCCYEkT/IkJA89lARc1Xsf1ZlR78W2iis4BFuybMAFMMW4qctFknu31XvvzTbu0tx9fmufOzMWJe+b97fWXmede2ekBYs/8sm3bJm1uLAry9jJt2jFq9Khl6XDL0vFr0ilr0pHXlMdf52ee5tdXU5b3diAN50IYHdCyYMINh1FIJpCnJmcRCGFQSqBdDNIJzhp5H4Su5FIx5PYYDzrjaVdcaxRS+qjyWWNdFlHL2jZBR27ECNdiqNX41l9HG1MYI0JtCWBtSTSjiTWnSz1pNCuZNKXKvWl0e4U0p/GhtLZcDodz2QjmWw0i42soiOZdDiDDaXToVQ6ms76k2lvEuuKZ71xbCBJ6o+nA7F0IIb260ifhg5p6EAkHdGycS0bjaJjGjYWxSY17IZOmtCQ61p6P0a6HU1vRtPbsfRePH2QQO8lkXtJdDqN4aRTfRbRryaQQ+Ucqs+mshj9GiqvocpLyKU8h0CueMwmPJtCDoE8CtlMn2cxnWsh51pCnrWca8FzzSHPAtZYyqusIdMG0s15hq2cOkdOniUnW8hxVI5V6WPpdDSd1kn3IsndKPZNOL2hZteD6HgAHfSnff6s1ZM1u9NmD9biKTW500Z3qdGDNnmxFi+pyYO2+7BWL9Lmy9q8WbuP1OHHegJZVwDr8qc9gawvkPYF0cEgOhTMhkPYcKhqIIj2BpP+IDoQQkfD2WgEG4mgY5EqPCPodS27FUfvJ5lPpVnJGVaQbS9n28o5c+V1j+rXzYWN8+RN9vCuLWyep99kL2901G+Yo19rAevw33p6vdX9XPM72Wwiiw2l0v5U1p9Ge1Kk1gRaH8dOR7Ayf/alh2qnk7RjhWrbUmnLO6p332DrX6fZr0iZL7KUF1jCn1TaP86K/P2siN9Zhj43R/1b68DfWPv+ysbrlw5uT9g6L7JducjeeZGjy6J5zo/buyxwdF9g77nIwfcJ+9Bfzo34pX3MMw4Jv7LP/K3tpj/b5L9gu/0Fq89fn130zpzyFXNOONuecZ1z0WtOnd+ctiDrjkCbwTDH4Qjrm9qf3on9yd34H02n/Jc+9TFIf1xOX6hPexwyF0Da49NJj00nPXYndt7tuB9N6hyGImx71datfrOueNHTrtKR5axkmVS2fHaN67wLvovq1c+26f7cl/zqZPbye5u99NuC4JMI2B8LFelwIodffg/qtkBzIbTthI5dvHMP7/4cp+dL3vcVH9jPBw/CUDEfKYPRMj5Wzscq+dgRPirOh5dK8VH5d04YKYVR8YOj5TBSir9kpIwPlcJwKQyXwHAJFwNDxfg4VGx6lAcP8YGHA/0H8bH/EO8Tl76DeOk7CP378Z+wfx/v3wf9+6Dva7kXT+jbB31fQe9X0P0V79mH0/0V71LmS979BXR9bjp59xe86wve+Tl07OWdnxtnL+/cCx2fKcM7PoP2T6H9Uy5OaPuEt38C7Z/wtj3Qsou37sZp2cNb9sgte3gzDjTv4U27efNO3vwxb/4Ip0lM807etBMaP4KGHdCwgzd+iO8bP+SNH0KT4aXhfcN2qC/k9dvlum1Qvw3qxGPdNj5joN74WFsw8z3eDW8KeJ34qLYA3xhHrsuH+nxel89r83ndVsPP1hZA7VbAx628Lh8atvLGfF6/Va4v4LVbceryeaPxfWM+NObzhgLegC+VAeXeUIAX/KgA3xu/gL+wYSv+lGmMH+GbpgLT4HdmPP7f780FvHnrw2nZyvHNNpyWfN4i7k3boLmAt4pp2cZbC7npbNnGWwrxo5Z8aM0X39kGbQWG6djK2/OhrYC35z+cjnxow/e8Ix/E8M4C6MjnnQUPp2sb79qGj8rZOeOufPS9E7rF
  ...[too long to view on UI. Please use the API to view the full content.]

    4. アクションが成功すると、UpdateUserPhoto タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

     [{
  "Status": "Success"
  }]

例 - RemoveUserPhoto

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [RemoveUserPhoto] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
     {
  "UserId": "9630c9d7-cf15-4406-8d21-598e41a058cc"
  }

    4. アクションが成功すると、RemoveUserPhoto タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

     [{
  "Status": "Success"
  }]

例 - AssignManager

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [AssignManager] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "UserId": "3558ca6e-2c2e-41d3-a854-bf9249a3c913",
  "ObjectId": "8cbe82b6-0dd5-4f10-bf67-82bf88ac6cb8",
  "ObjectName": "users"
  }

    4. アクションが成功すると、AssignManager タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

     [{
  "Status": "True"
  }]

例 - RemoveManager

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [RemoveManager] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "UserId": "3558ca6e-2c2e-41d3-a854-bf9249a3c913"
  }

    4. アクションが成功すると、RemoveManager タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

     [{
  "Status": "True"
  }]

例 - RetrieveManagerChain

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [RetrieveManagerChain] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
  "UserId": "8cbe82b6-0dd5-4f10-bf67-82bf88ac6cb8",
  "Levels": "max"
  }

    4. アクションが成功すると、RetrieveManagerChain タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    [{
  "id": "8cbe82b6-0dd5-4f10-bf67-82bf88ac6cb8",
  "displayName": "test1",
  "manager": "{\r\n  \"@odata.type\": \"#microsoft.graph.user\",\r\n  \"id\": \"9630c9d7-cf15-4406-8d21-598e41a058cc\",\r\n  \"deletedDateTime\": null,\r\n  \"accountEnabled\": true,\r\n  \"ageGroup\": null,\r\n  \"businessPhones\": [],\r\n  \"city\": null,\r\n  \"companyName\": null,\r\n  \"consentProvidedForMinor\": null,\r\n  \"country\": null,\r\n  \"createdDateTime\": \"2024-04-12T10:24:42Z\",\r\n  \"creationType\": null,\r\n  \"department\": null,\r\n  \"displayName\": \"Azure_AD_Test\",\r\n  \"employeeId\": null,\r\n  \"employeeHireDate\": null,\r\n  \"employeeLeaveDateTime\": null,\r\n  \"employeeType\": null,\r\n  \"externalUserState\": null,\r\n  \"externalUserStateChangeDateTime\": null,\r\n  \"faxNumber\": null,\r\n  \"givenName\": null,\r\n  \"isLicenseReconciliationNeeded\": false,\r\n  \"jobTitle\": null,\r\n  \"legalAgeGroupClassification\": null,\r\n  \"mail\": null,\r\n  \"mailNickname\": \"Azure_AD_Test\",\r\n  \"mobilePhone\": null,\r\n  \"onPremisesDistinguishedName\": null,\r\n  \"onPremisesDomainName\": null,\r\n  \"onPremisesImmutableId\": null,\r\n  \"onPremisesLastSyncDateTime\": null,\r\n  \"onPremisesSecurityIdentifier\": null,\r\n  \"onPremisesSamAccountName\": null,\r\n  \"onPremisesSyncEnabled\": null,\r\n  \"onPremisesUserPrincipalName\": null,\r\n  \"otherMails\": [],\r\n  \"passwordPolicies\": null,\r\n  \"officeLocation\": null,\r\n  \"postalCode\": null,\r\n  \"preferredDataLocation\": null,\r\n  \"preferredLanguage\": null,\r\n  \"proxyAddresses\": [],\r\n  \"refreshTokensValidFromDateTime\": \"2024-05-14T05:07:15Z\",\r\n  \"imAddresses\": [],\r\n  \"isResourceAccount\": null,\r\n  \"showInAddressList\": null,\r\n  \"securityIdentifier\": \"S-1-12-1-2519779799-1141296917-2388205965-3428360257\",\r\n  \"signInSessionsValidFromDateTime\": \"2024-05-14T05:07:15Z\",\r\n  \"state\": null,\r\n  \"streetAddress\": null,\r\n  \"surname\": null,\r\n  \"usageLocat
  ...[too long to view on UI. Please use the API to view the full content.]

例 - AddProfileCardProperty

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [AddProfileCardProperty] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
     {
"Annotations": "[{"displayName": "Attributes"}]",
"DirectoryPropertyName": "CustomAttribute15"
}

    4. アクションが成功すると、AddProfileCardProperty タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

     [{
"Status": "True"
}]

例 - RemoveProfileCardProperty

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [RemoveProfileCardProperty] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
"DirectoryPropertyName": "CustomAttribute12"
}
    4. アクションが成功すると、RemoveProfileCardProperty タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

     [{
"Status": "True"
}]

エンティティ オペレーションの例

このセクションでは、このコネクタでエンティティ オペレーションの一部を実行する方法について説明します。

例 - グループを一覧表示する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから [Groups] を選択します。
  3. [LIST] オペレーションを選択し、[完了] をクリックします。
  4. [コネクタ] タスクの [タスク入力] セクションで、お客様の要件に応じて filterClause を設定できます。

フィルタ句の値は単一引用符（'）で囲む必要があります。フィルタ句を使用すると、列に基づいてレコードをフィルタできます。

LIST オペレーションは、次のエンティティに対しても実行できます。

  • ユーザー
  • GroupMembers
  • ドメイン
  • RoleAssignments
  • Applications
  • デバイス
  • 連絡先
  • DirectoryRoleTemplates
  • DirectoryRoles
  • AdministrativeUnits
  • SubscribedSKUs
  • PhoneAuthenticationMethod
  • Organization
  • DeviceLocalCredentials
  • ProfileCardProperties

例 - グループから 1 つのレコードを取得する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから [Groups] を選択します。
  3. [GET] オペレーションを選択し、[完了] をクリックします。
  4. エンティティ ID を「bb4756c7-38c0-426b-97aa-03b6443e7f16」に設定します。これは渡されるキーです。エンティティ ID を設定するには、[データ マッピング] の [データ マッパー] セクションで [データ マッピング エディタを開く] をクリックし、[入力値] フィールドに "bb4756c7-38c0-426b-97aa-03b6443e7f16" を入力し、EntityId をローカル変数として選択します。

次のエンティティに対して GET オペレーションを実行することもできます。

  • ユーザー
  • GroupMembers
  • ドメイン
  • RoleAssignments
  • Applications
  • デバイス
  • 連絡先
  • DirectoryRoleTemplates
  • DirectoryRoles
  • AdministrativeUnits
  • PhoneAuthenticationMethod
  • Organization
  • UserManagers
  • DeviceLocalCredentials

例 - グループからレコードを削除する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから [Groups] を選択します。
  3. [DELETE] オペレーションを選択し、[完了] をクリックします。
  4. エンティティ ID を「62008bbe-effa-4341-9d29-eac7f67b84fe」に設定します。これは渡されるキーです。エンティティ ID を設定するには、[データ マッピング] の [データ マッパー] セクションで [データ マッピング エディタを開く] をクリックし、[入力値] フィールドに "62008bbe-effa-4341-9d29-eac7f67b84fe" を入力し、EntityId をローカル変数として選択します。

    2 つの複合キーまたは主キーが存在する場合、エンティティ ID を渡すとエラーが発生することがあります。このような場合は、 id='62008bbe-effa-4341-9d29-eac7f67b84fe' などのフィルタ句を使用できます。

DELETE オペレーションは、次のエンティティに対しても実行できます。

  • ユーザー
  • ドメイン
  • Applications
  • デバイス

    • 例 - グループ（Microsoft 365）エンティティを作成する

    1. [Configure connector task] ダイアログで、[Entities] をクリックします。
    2. Entity リストから [Groups] を選択します。
    3. [Create] オペレーションを選択し、[完了] をクリックします。
    4. [データ マッピング] タスクの [データ マッパー] セクションで、Open Data Mapping Editor をクリックし、[Input Value] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload をローカル変数として選択します。 
      {
"securityEnabled": true,
"displayName": "GoogleGCP",
"description": "This Group is creating for gcp testing.",
"mailEnabled": false,
"mailNickname": "GoogleGCP",
"groupTypes": "Unified"
}

      この例では、Groups レコードを作成します。統合が成功すると、Groups タスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

      {
"id": "30fc13b3-79b3-4ac5-a3ba-684d4e887ecc"
}

    例 - ユーザーを更新する

    1. [Configure connector task] ダイアログで、[Entities] をクリックします。
    2. Entity リストから [Users] を選択します。
    3. [Update] オペレーションを選択し、[完了] をクリックします。
    4. [データ マッピング] タスクの [データ マッパー] セクションで、Open Data Mapping Editor をクリックし、[Input Value] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload/FilterClause をローカル変数として選択します。
      {
"jobTitle": "Software Engineer"
}
    5. Data Mapper でエンティティ ID をユーザーのエンティティに設定します。エンティティ ID を設定するには、[Open Data Mapping Editor] をクリックし、[Input Value] フィールドに次のような値を入力し、EntityId/ConnectorInputPayload/FilterClause をローカル変数として選択します。

      [entityId] を指定する代わりに、[filterClause] を 7ad59ec3-1c37-4932-be51-7513fe98c3c3 に設定することもできます。

      この例を実行すると、コネクタタスクの connectorOutputPayload 出力変数で次のようなレスポンスが返されます。

      {
"id": "7ad59ec3-1c37-4932-be51-7513fe98c3c3"
}

    統合で Azure AD（Entra ID）接続を使用する

    接続を作成すると、Apigee Integration と Application Integration の両方で使用できるようになります。この接続は、コネクタタスクを介して統合で使用できます。

    • Apigee Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。
    • Application Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。

    Google Cloud コミュニティの助けを借りる

    Google Cloud コミュニティの Cloud フォーラムで質問を投稿したり、このコネクタについてディスカッションしたりできます。

    次のステップ