Identity Provider - Get

リファレンス

サービス:: API Management

API バージョン:: 2024-05-01

指定したサービスインスタンスで構成された ID プロバイダーの構成の詳細を取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/identityProviders/{identityProviderName}?api-version=2024-05-01

URI パラメーター

名前	/	必須	型	説明
identityProviderName	path	True	IdentityProviderType	ID プロバイダーの種類識別子。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前では大文字と小文字が区別されません。
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API Management サービスの名前。
subscriptionId	path	True	string (uuid)	ターゲットサブスクリプションの ID。値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	IdentityProviderContract	応答本文には、指定された IdentityProvider エンティティ構成の詳細が含まれています。ヘッダー ETag: string
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

名前

型

説明

200 OK

IdentityProviderContract

応答本文には、指定された IdentityProvider エンティティ構成の詳細が含まれています。

ヘッダー

ETag: string

Other Status Codes

ErrorResponse

操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

ApiManagementGetIdentityProvider

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/aadB2C?api-version=2024-05-01

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/AadB2C",
  "type": "Microsoft.ApiManagement/service/identityProviders",
  "name": "AadB2C",
  "properties": {
    "clientId": "f02dafe2-b8b8-48ec-a38e-27e5c16c51e5",
    "type": "aadB2C",
    "authority": "login.microsoftonline.com",
    "signinTenant": "contosoaadb2c.onmicrosoft.com",
    "allowedTenants": [
      "contosoaadb2c.onmicrosoft.com",
      "contoso2aadb2c.onmicrosoft.com"
    ],
    "signupPolicyName": "B2C_1_policy-signup",
    "signinPolicyName": "B2C_1_policy-signin"
  }
}

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
IdentityProviderContract	ID プロバイダーの詳細。
IdentityProviderType	ID プロバイダーの種類識別子。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

IdentityProviderContract

Object

ID プロバイダーの詳細。

名前	型	説明
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.allowedTenants	string[]	Azure Active Directory ログインの構成時に許可されるテナントの一覧。
properties.authority	string	AAD または AAD B2C の OpenID Connect 検出エンドポイントのホスト名。
properties.clientId	string minLength: 1	外部 ID プロバイダー内のアプリケーションのクライアント ID。 Facebook ログインのアプリ ID、Google ログインのクライアント ID、Microsoft のアプリ ID です。
properties.clientLibrary	string minLength: 0 maxLength: 16	開発者ポータルで使用するクライアントライブラリ。 AAD および AAD B2C ID プロバイダーにのみ適用されます。
properties.clientSecret	string minLength: 1	外部 ID プロバイダー内のアプリケーションのクライアントシークレット。ログイン要求の認証に使用されます。たとえば、Facebook ログイン用のアプリシークレット、Google ログイン用の API キー、Microsoft の公開キーなどです。このプロパティは'GET' 操作では入力されません。値を取得するには、'/listSecrets' POST 要求を使用します。
properties.passwordResetPolicyName	string minLength: 1	パスワードリセットポリシー名。 AAD B2C ID プロバイダーにのみ適用されます。
properties.profileEditingPolicyName	string minLength: 1	プロファイル編集ポリシー名。 AAD B2C ID プロバイダーにのみ適用されます。
properties.signinPolicyName	string minLength: 1	サインインポリシー名。 AAD B2C ID プロバイダーにのみ適用されます。
properties.signinTenant	string	Active Directory にログインするときに Common の代わりに使用する TenantId
properties.signupPolicyName	string minLength: 1	サインアップポリシー名。 AAD B2C ID プロバイダーにのみ適用されます。
properties.type	IdentityProviderType	ID プロバイダーの種類識別子。
type	string	リソースの種類。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

IdentityProviderType

列挙

ID プロバイダーの種類識別子。

値	説明
aad	ID プロバイダーとしての Azure Active Directory。
aadB2C	ID プロバイダーとしての Azure Active Directory B2C。
facebook	Id プロバイダーとしての Facebook。
google	ID プロバイダーとしての Google。
microsoft	Id プロバイダーとしての Microsoft Live。
twitter	ID プロバイダーとしての Twitter。

次の方法で共有

Identity Provider - Get

URI パラメーター

応答

セキュリティ

azure_auth

スコープ

例

ApiManagementGetIdentityProvider

要求のサンプル

応答のサンプル

定義

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IdentityProviderContract

IdentityProviderType

その他のリソース