Identity Provider - Update

Reference

Service:: API Management

API Version:: 2024-05-01

Updates an existing IdentityProvider configuration.

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

URI Parameters

Name	In	Required	Type	Description
identityProviderName	path	True	IdentityProviderType	Identity Provider Type identifier.
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
serviceName	path	True	string	The name of the API Management service. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string	The API version to use for this operation.

Request Header

Name	Required	Type	Description
If-Match	True	string	ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Request Body

Name	Type	Description
properties.allowedTenants	string[]	List of Allowed Tenants when configuring Azure Active Directory login.
properties.authority	string	OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
properties.clientId	string	Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.
properties.clientLibrary	string	The client library to be used in the developer portal. Only applies to AAD and AAD B2C Identity Provider.
properties.clientSecret	string	Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft.
properties.passwordResetPolicyName	string	Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
properties.profileEditingPolicyName	string	Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
properties.signinPolicyName	string	Signin Policy Name. Only applies to AAD B2C Identity Provider.
properties.signinTenant	string	The TenantId to use instead of Common when logging into Active Directory
properties.signupPolicyName	string	Signup Policy Name. Only applies to AAD B2C Identity Provider.
properties.type	IdentityProviderType	Identity Provider Type identifier.

Responses

Name	Type	Description
200 OK	IdentityProviderContract	The existing Identity Provider was successfully updated. Headers ETag: string
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Name

Type

Description

200 OK

IdentityProviderContract

The existing Identity Provider was successfully updated.

Headers

ETag: string

Other Status Codes

ErrorResponse

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

ApiManagementUpdateIdentityProvider

Sample request

HTTP

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


{
  "properties": {
    "clientId": "updatedfacebookid",
    "clientSecret": "updatedfacebooksecret"
  }
}

Sample response

Status code:: 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"
  }
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
IdentityProviderContract	Identity Provider details.
IdentityProviderType	Identity Provider Type identifier.
IdentityProviderUpdateParameters	Parameters supplied to update Identity Provider

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

IdentityProviderContract

Identity Provider details.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	The name of the resource
properties.allowedTenants	string[]	List of Allowed Tenants when configuring Azure Active Directory login.
properties.authority	string	OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
properties.clientId	string	Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.
properties.clientLibrary	string	The client library to be used in the developer portal. Only applies to AAD and AAD B2C Identity Provider.
properties.clientSecret	string	Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
properties.passwordResetPolicyName	string	Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
properties.profileEditingPolicyName	string	Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
properties.signinPolicyName	string	Signin Policy Name. Only applies to AAD B2C Identity Provider.
properties.signinTenant	string	The TenantId to use instead of Common when logging into Active Directory
properties.signupPolicyName	string	Signup Policy Name. Only applies to AAD B2C Identity Provider.
properties.type	IdentityProviderType	Identity Provider Type identifier.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

IdentityProviderType

Identity Provider Type identifier.

Name	Type	Description
aad	string	Azure Active Directory as Identity provider.
aadB2C	string	Azure Active Directory B2C as Identity provider.
facebook	string	Facebook as Identity provider.
google	string	Google as Identity provider.
microsoft	string	Microsoft Live as Identity provider.
twitter	string	Twitter as Identity provider.

IdentityProviderUpdateParameters

Parameters supplied to update Identity Provider

Name	Type	Description
properties.allowedTenants	string[]	List of Allowed Tenants when configuring Azure Active Directory login.
properties.authority	string	OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
properties.clientId	string	Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.
properties.clientLibrary	string	The client library to be used in the developer portal. Only applies to AAD and AAD B2C Identity Provider.
properties.clientSecret	string	Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft.
properties.passwordResetPolicyName	string	Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
properties.profileEditingPolicyName	string	Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
properties.signinPolicyName	string	Signin Policy Name. Only applies to AAD B2C Identity Provider.
properties.signinTenant	string	The TenantId to use instead of Common when logging into Active Directory
properties.signupPolicyName	string	Signup Policy Name. Only applies to AAD B2C Identity Provider.
properties.type	IdentityProviderType	Identity Provider Type identifier.

次の方法で共有

Identity Provider - Update

URI Parameters

Request Header

Request Body

Responses

Security

azure_auth

Scopes

Examples

ApiManagementUpdateIdentityProvider

Sample request

Sample response

Definitions

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IdentityProviderContract

IdentityProviderType

IdentityProviderUpdateParameters

その他のリソース