Identity Provider - Create Or Update
Creates or Updates the IdentityProvider configuration.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/identityProviders/{identityProviderName}?api-version=2021-08-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
identity
|
path | True |
Identity Provider Type identifier. |
|
resource
|
path | True |
string |
The name of the resource group. |
service
|
path | True |
string |
The name of the API Management service. Regex pattern: |
subscription
|
path | True |
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
api-version
|
query | True |
string |
Version of the API to be used with the client request. |
Request Header
Name | Required | Type | Description |
---|---|---|---|
If-Match |
string |
ETag of the Entity. Not required when creating an entity, but required when updating an entity. |
Request Body
Name | Required | Type | Description |
---|---|---|---|
properties.clientId | True |
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.clientSecret | True |
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.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.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 |
Identity Provider Type identifier. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
The existing Identity Provider was successfully updated. Headers ETag: string |
|
201 Created |
IdentityProvider configuration were successfully created. Headers ETag: string |
|
Other Status Codes |
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
ApiManagementCreateIdentityProvider
Sample request
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/facebook?api-version=2021-08-01
{
"properties": {
"clientId": "facebookid",
"clientSecret": "facebookapplicationsecret"
}
}
Sample response
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/Facebook",
"type": "Microsoft.ApiManagement/service/identityProviders",
"name": "Facebook",
"properties": {
"clientId": "facebookid",
"type": "facebook"
}
}
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/Facebook",
"type": "Microsoft.ApiManagement/service/identityProviders",
"name": "Facebook",
"properties": {
"clientId": "facebookid",
"type": "facebook"
}
}
Definitions
Name | Description |
---|---|
Error |
Error Field contract. |
Error |
Error Response. |
Identity |
Identity Provider details. |
Identity |
Identity Provider details. |
Identity |
Identity Provider Type identifier. |
ErrorFieldContract
Error Field contract.
Name | Type | Description |
---|---|---|
code |
string |
Property level error code. |
message |
string |
Human-readable representation of property-level error. |
target |
string |
Property name. |
ErrorResponse
Error Response.
Name | Type | Description |
---|---|---|
error.code |
string |
Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. |
error.details |
The list of invalid fields send in request, in case of validation error. |
|
error.message |
string |
Human-readable representation of the error. |
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.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 |
Identity Provider Type identifier. |
|
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |
IdentityProviderCreateContract
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.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 |
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. |
string |
Facebook as Identity provider. |
|
string |
Google as Identity provider. |
|
microsoft |
string |
Microsoft Live as Identity provider. |
string |
Twitter as Identity provider. |